Coverage for devtools/utils.py: 89.39%
60 statements
« prev ^ index » next coverage.py v7.16.2, created at 2026-10-11 17:56 +0000
« prev ^ index » next coverage.py v7.16.2, created at 2026-10-11 17:56 +0000
1import os 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
2import sys 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
3from typing import Any 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
5__all__ = ( 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
6 'DataClassType',
7 'LaxMapping',
8 'SQLAlchemyClassType',
9 'auto_highlight',
10 'env_bool',
11 'env_true',
12 'is_literal',
13 'isatty',
14 'use_highlight',
15)
18def isatty(stream: Any = None) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
19 stream = stream or sys.stdout 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
20 try: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
21 return stream.isatty() 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
22 except Exception: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
23 return False 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
26def env_true(var_name: str, alt: bool | None = None) -> Any: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
27 env = os.getenv(var_name, None) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
28 if env: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
29 return env.upper() in {'1', 'TRUE'} 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
30 else:
31 return alt 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
34def env_bool(value: bool | None, env_name: str, env_default: bool | None) -> bool | None: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
35 if value is None: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
36 return env_true(env_name, env_default) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
37 else:
38 return value 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
41def activate_win_color() -> bool: # pragma: no cover 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
42 """
43 Activate ANSI support on windows consoles.
45 As of Windows 10, the windows conolse got some support for ANSI escape
46 sequences. Unfortunately it has to be enabled first using `SetConsoleMode`.
47 See: https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
49 Code snippet source: https://bugs.python.org/msg291732
50 """
51 import ctypes 1abcdefghijkl
52 import msvcrt 1abcdefghijkl
53 import os 1abcdefghijkl
54 from ctypes import wintypes 1abcdefghijkl
56 def _check_bool(result: Any, func: Any, args: Any) -> Any: 1abcdefghijkl
57 if not result: 1abcdefghijkl
58 raise ctypes.WinError(ctypes.get_last_error())
59 return args 1abcdefghijkl
61 ERROR_INVALID_PARAMETER = 0x0057 1abcdefghijkl
62 ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004 1abcdefghijkl
64 LPDWORD = ctypes.POINTER(wintypes.DWORD) 1abcdefghijkl
66 kernel32 = ctypes.WinDLL('kernel32', use_last_error=True) 1abcdefghijkl
67 kernel32.GetConsoleMode.errcheck = _check_bool 1abcdefghijkl
68 kernel32.GetConsoleMode.argtypes = (wintypes.HANDLE, LPDWORD) 1abcdefghijkl
69 kernel32.SetConsoleMode.errcheck = _check_bool 1abcdefghijkl
70 kernel32.SetConsoleMode.argtypes = (wintypes.HANDLE, wintypes.DWORD) 1abcdefghijkl
72 def _set_conout_mode(new_mode: int, mask: int = 0xFFFFFFFF) -> int: 1abcdefghijkl
73 # don't assume StandardOutput is a console.
74 # open CONOUT$ instead
75 fdout = os.open('CONOUT$', os.O_RDWR) 1abcdefghijkl
76 try: 1abcdefghijkl
77 hout = msvcrt.get_osfhandle(fdout) 1abcdefghijkl
78 old_mode = wintypes.DWORD() 1abcdefghijkl
79 kernel32.GetConsoleMode(hout, ctypes.byref(old_mode)) 1abcdefghijkl
80 mode = (new_mode & mask) | (old_mode.value & ~mask) 1abcdefghijkl
81 kernel32.SetConsoleMode(hout, mode) 1abcdefghijkl
82 return old_mode.value 1abcdefghijkl
83 finally:
84 os.close(fdout) 1abcdefghijkl
86 mode = mask = ENABLE_VIRTUAL_TERMINAL_PROCESSING 1abcdefghijkl
87 try: 1abcdefghijkl
88 _set_conout_mode(mode, mask) 1abcdefghijkl
89 except OSError as e:
90 if e.winerror == ERROR_INVALID_PARAMETER:
91 return False
92 raise
93 return True 1abcdefghijkl
96def use_highlight(highlight: bool | None = None, file_: Any = None) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
97 highlight = env_bool(highlight, 'PY_DEVTOOLS_HIGHLIGHT', None) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
99 if highlight is not None: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
100 return highlight 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
102 if sys.platform == 'win32': # pragma: no cover 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
103 return auto_highlight(file_) and activate_win_color() 1abcdefghijkl
104 return auto_highlight(file_) 1mnopqrstuvwxyzABCDEFGHIJ
107def auto_highlight(file_: Any = None) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
108 """
109 Whether to colour output when nothing has asked for it explicitly: only when writing to a terminal and
110 `NO_COLOR` (https://no-color.org/) is unset or empty.
111 """
112 return not os.getenv('NO_COLOR') and isatty(file_) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
115def is_literal(s: Any) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
116 import ast 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
118 try: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
119 ast.literal_eval(s) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
120 except (TypeError, MemoryError, SyntaxError, ValueError): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
121 return False 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
122 else:
123 return True 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
126class MetaLaxMapping(type): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
127 def __instancecheck__(self, instance: Any) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
128 return ( 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
129 hasattr(instance, '__getitem__')
130 and hasattr(instance, 'items')
131 and callable(instance.items)
132 and type(instance) != type
133 )
136class LaxMapping(metaclass=MetaLaxMapping): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
137 pass 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
140class MetaDataClassType(type): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
141 def __instancecheck__(self, instance: Any) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
142 from dataclasses import is_dataclass 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
144 return is_dataclass(instance) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
147class DataClassType(metaclass=MetaDataClassType): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
148 pass 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
151class MetaSQLAlchemyClassType(type): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
152 def __instancecheck__(self, instance: Any) -> bool: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
153 try: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
154 from sqlalchemy.orm import DeclarativeBase 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
155 except ImportError:
156 pass
157 else:
158 if isinstance(instance, DeclarativeBase): 158 ↛ 159line 158 didn't jump to line 159 because the condition on line 158 was never true1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
159 return True
161 try: 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
162 from sqlalchemy.ext.declarative import DeclarativeMeta 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
163 except ImportError:
164 pass
165 else:
166 return isinstance(instance.__class__, DeclarativeMeta) 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
168 return False
171class SQLAlchemyClassType(metaclass=MetaSQLAlchemyClassType): 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ
172 pass 1mnopqrstuvwxabcdefghijklyzABCDEFGHIJ