Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`sys` --- System-specific parameters and functions |
| 2 | ======================================================= |
| 3 | |
| 4 | .. module:: sys |
| 5 | :synopsis: Access system-specific parameters and functions. |
| 6 | |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 7 | -------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 8 | |
| 9 | This module provides access to some variables used or maintained by the |
| 10 | interpreter and to functions that interact strongly with the interpreter. It is |
| 11 | always available. |
| 12 | |
| 13 | |
Barry Warsaw | a40453d | 2010-10-16 14:17:50 +0000 | [diff] [blame] | 14 | .. data:: abiflags |
| 15 | |
Georg Brandl | df48b97 | 2014-03-24 09:06:18 +0100 | [diff] [blame] | 16 | On POSIX systems where Python was built with the standard ``configure`` |
Barry Warsaw | a40453d | 2010-10-16 14:17:50 +0000 | [diff] [blame] | 17 | script, this contains the ABI flags as specified by :pep:`3149`. |
| 18 | |
| 19 | .. versionadded:: 3.2 |
| 20 | |
Georg Brandl | df48b97 | 2014-03-24 09:06:18 +0100 | [diff] [blame] | 21 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 22 | .. data:: argv |
| 23 | |
| 24 | The list of command line arguments passed to a Python script. ``argv[0]`` is the |
| 25 | script name (it is operating system dependent whether this is a full pathname or |
| 26 | not). If the command was executed using the :option:`-c` command line option to |
| 27 | the interpreter, ``argv[0]`` is set to the string ``'-c'``. If no script name |
| 28 | was passed to the Python interpreter, ``argv[0]`` is the empty string. |
| 29 | |
| 30 | To loop over the standard input, or the list of files given on the |
| 31 | command line, see the :mod:`fileinput` module. |
| 32 | |
| 33 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 34 | .. data:: base_exec_prefix |
| 35 | |
| 36 | Set during Python startup, before ``site.py`` is run, to the same value as |
Vinay Sajip | cd9b746 | 2012-07-09 10:37:01 +0100 | [diff] [blame] | 37 | :data:`exec_prefix`. If not running in a |
| 38 | :ref:`virtual environment <venv-def>`, the values will stay the same; if |
| 39 | ``site.py`` finds that a virtual environment is in use, the values of |
| 40 | :data:`prefix` and :data:`exec_prefix` will be changed to point to the |
| 41 | virtual environment, whereas :data:`base_prefix` and |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 42 | :data:`base_exec_prefix` will remain pointing to the base Python |
| 43 | installation (the one which the virtual environment was created from). |
| 44 | |
Georg Brandl | 039b01d | 2012-05-26 09:11:22 +0200 | [diff] [blame] | 45 | .. versionadded:: 3.3 |
| 46 | |
| 47 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 48 | .. data:: base_prefix |
| 49 | |
| 50 | Set during Python startup, before ``site.py`` is run, to the same value as |
Vinay Sajip | cd9b746 | 2012-07-09 10:37:01 +0100 | [diff] [blame] | 51 | :data:`prefix`. If not running in a :ref:`virtual environment <venv-def>`, the values |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 52 | will stay the same; if ``site.py`` finds that a virtual environment is in |
| 53 | use, the values of :data:`prefix` and :data:`exec_prefix` will be changed to |
| 54 | point to the virtual environment, whereas :data:`base_prefix` and |
| 55 | :data:`base_exec_prefix` will remain pointing to the base Python |
| 56 | installation (the one which the virtual environment was created from). |
| 57 | |
Georg Brandl | 039b01d | 2012-05-26 09:11:22 +0200 | [diff] [blame] | 58 | .. versionadded:: 3.3 |
| 59 | |
| 60 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 61 | .. data:: byteorder |
| 62 | |
| 63 | An indicator of the native byte order. This will have the value ``'big'`` on |
| 64 | big-endian (most-significant byte first) platforms, and ``'little'`` on |
| 65 | little-endian (least-significant byte first) platforms. |
| 66 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 67 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 68 | .. data:: builtin_module_names |
| 69 | |
| 70 | A tuple of strings giving the names of all modules that are compiled into this |
| 71 | Python interpreter. (This information is not available in any other way --- |
| 72 | ``modules.keys()`` only lists the imported modules.) |
| 73 | |
| 74 | |
Georg Brandl | 8527126 | 2010-10-17 11:06:14 +0000 | [diff] [blame] | 75 | .. function:: call_tracing(func, args) |
| 76 | |
| 77 | Call ``func(*args)``, while tracing is enabled. The tracing state is saved, |
| 78 | and restored afterwards. This is intended to be called from a debugger from |
| 79 | a checkpoint, to recursively debug some other code. |
| 80 | |
| 81 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 82 | .. data:: copyright |
| 83 | |
| 84 | A string containing the copyright pertaining to the Python interpreter. |
| 85 | |
| 86 | |
Christian Heimes | 15ebc88 | 2008-02-04 18:48:49 +0000 | [diff] [blame] | 87 | .. function:: _clear_type_cache() |
| 88 | |
| 89 | Clear the internal type cache. The type cache is used to speed up attribute |
| 90 | and method lookups. Use the function *only* to drop unnecessary references |
| 91 | during reference leak debugging. |
| 92 | |
| 93 | This function should be used for internal and specialized purposes only. |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 94 | |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 95 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 96 | .. function:: _current_frames() |
| 97 | |
| 98 | Return a dictionary mapping each thread's identifier to the topmost stack frame |
| 99 | currently active in that thread at the time the function is called. Note that |
| 100 | functions in the :mod:`traceback` module can build the call stack given such a |
| 101 | frame. |
| 102 | |
| 103 | This is most useful for debugging deadlock: this function does not require the |
| 104 | deadlocked threads' cooperation, and such threads' call stacks are frozen for as |
| 105 | long as they remain deadlocked. The frame returned for a non-deadlocked thread |
| 106 | may bear no relationship to that thread's current activity by the time calling |
| 107 | code examines the frame. |
| 108 | |
| 109 | This function should be used for internal and specialized purposes only. |
| 110 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 111 | |
Barry Warsaw | 36c1d1f | 2017-10-05 12:11:18 -0400 | [diff] [blame] | 112 | .. function:: breakpointhook() |
| 113 | |
| 114 | This hook function is called by built-in :func:`breakpoint`. By default, |
| 115 | it drops you into the :mod:`pdb` debugger, but it can be set to any other |
| 116 | function so that you can choose which debugger gets used. |
| 117 | |
| 118 | The signature of this function is dependent on what it calls. For example, |
| 119 | the default binding (e.g. ``pdb.set_trace()``) expects no arguments, but |
| 120 | you might bind it to a function that expects additional arguments |
| 121 | (positional and/or keyword). The built-in ``breakpoint()`` function passes |
| 122 | its ``*args`` and ``**kws`` straight through. Whatever |
| 123 | ``breakpointhooks()`` returns is returned from ``breakpoint()``. |
| 124 | |
| 125 | The default implementation first consults the environment variable |
| 126 | :envvar:`PYTHONBREAKPOINT`. If that is set to ``"0"`` then this function |
| 127 | returns immediately; i.e. it is a no-op. If the environment variable is |
| 128 | not set, or is set to the empty string, ``pdb.set_trace()`` is called. |
| 129 | Otherwise this variable should name a function to run, using Python's |
| 130 | dotted-import nomenclature, e.g. ``package.subpackage.module.function``. |
| 131 | In this case, ``package.subpackage.module`` would be imported and the |
| 132 | resulting module must have a callable named ``function()``. This is run, |
| 133 | passing in ``*args`` and ``**kws``, and whatever ``function()`` returns, |
| 134 | ``sys.breakpointhook()`` returns to the built-in :func:`breakpoint` |
| 135 | function. |
| 136 | |
| 137 | Note that if anything goes wrong while importing the callable named by |
| 138 | :envvar:`PYTHONBREAKPOINT`, a :exc:`RuntimeWarning` is reported and the |
| 139 | breakpoint is ignored. |
| 140 | |
| 141 | Also note that if ``sys.breakpointhook()`` is overridden programmatically, |
| 142 | :envvar:`PYTHONBREAKPOINT` is *not* consulted. |
| 143 | |
| 144 | .. versionadded:: 3.7 |
| 145 | |
David Malcolm | 49526f4 | 2012-06-22 14:55:41 -0400 | [diff] [blame] | 146 | .. function:: _debugmallocstats() |
| 147 | |
| 148 | Print low-level information to stderr about the state of CPython's memory |
| 149 | allocator. |
| 150 | |
| 151 | If Python is configured --with-pydebug, it also performs some expensive |
| 152 | internal consistency checks. |
| 153 | |
| 154 | .. versionadded:: 3.3 |
| 155 | |
| 156 | .. impl-detail:: |
| 157 | |
| 158 | This function is specific to CPython. The exact output format is not |
| 159 | defined here, and may change. |
| 160 | |
| 161 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 162 | .. data:: dllhandle |
| 163 | |
| 164 | Integer specifying the handle of the Python DLL. Availability: Windows. |
| 165 | |
| 166 | |
| 167 | .. function:: displayhook(value) |
| 168 | |
Victor Stinner | 13d49ee | 2010-12-04 17:24:33 +0000 | [diff] [blame] | 169 | If *value* is not ``None``, this function prints ``repr(value)`` to |
| 170 | ``sys.stdout``, and saves *value* in ``builtins._``. If ``repr(value)`` is |
| 171 | not encodable to ``sys.stdout.encoding`` with ``sys.stdout.errors`` error |
| 172 | handler (which is probably ``'strict'``), encode it to |
| 173 | ``sys.stdout.encoding`` with ``'backslashreplace'`` error handler. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 174 | |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 175 | ``sys.displayhook`` is called on the result of evaluating an :term:`expression` |
| 176 | entered in an interactive Python session. The display of these values can be |
| 177 | customized by assigning another one-argument function to ``sys.displayhook``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 178 | |
Victor Stinner | 13d49ee | 2010-12-04 17:24:33 +0000 | [diff] [blame] | 179 | Pseudo-code:: |
| 180 | |
| 181 | def displayhook(value): |
| 182 | if value is None: |
| 183 | return |
| 184 | # Set '_' to None to avoid recursion |
| 185 | builtins._ = None |
| 186 | text = repr(value) |
| 187 | try: |
| 188 | sys.stdout.write(text) |
| 189 | except UnicodeEncodeError: |
| 190 | bytes = text.encode(sys.stdout.encoding, 'backslashreplace') |
| 191 | if hasattr(sys.stdout, 'buffer'): |
| 192 | sys.stdout.buffer.write(bytes) |
| 193 | else: |
| 194 | text = bytes.decode(sys.stdout.encoding, 'strict') |
| 195 | sys.stdout.write(text) |
| 196 | sys.stdout.write("\n") |
| 197 | builtins._ = value |
| 198 | |
| 199 | .. versionchanged:: 3.2 |
| 200 | Use ``'backslashreplace'`` error handler on :exc:`UnicodeEncodeError`. |
| 201 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 202 | |
Éric Araujo | da27263 | 2011-10-05 01:17:38 +0200 | [diff] [blame] | 203 | .. data:: dont_write_bytecode |
| 204 | |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 205 | If this is true, Python won't try to write ``.pyc`` files on the |
Éric Araujo | da27263 | 2011-10-05 01:17:38 +0200 | [diff] [blame] | 206 | import of source modules. This value is initially set to ``True`` or |
| 207 | ``False`` depending on the :option:`-B` command line option and the |
| 208 | :envvar:`PYTHONDONTWRITEBYTECODE` environment variable, but you can set it |
| 209 | yourself to control bytecode file generation. |
| 210 | |
| 211 | |
Carl Meyer | b193fa9 | 2018-06-15 22:40:56 -0600 | [diff] [blame] | 212 | .. data:: pycache_prefix |
| 213 | |
| 214 | If this is set (not ``None``), Python will write bytecode-cache ``.pyc`` |
| 215 | files to (and read them from) a parallel directory tree rooted at this |
| 216 | directory, rather than from ``__pycache__`` directories in the source code |
| 217 | tree. Any ``__pycache__`` directories in the source code tree will be ignored |
| 218 | and new `.pyc` files written within the pycache prefix. Thus if you use |
| 219 | :mod:`compileall` as a pre-build step, you must ensure you run it with the |
| 220 | same pycache prefix (if any) that you will use at runtime. |
| 221 | |
| 222 | A relative path is interpreted relative to the current working directory. |
| 223 | |
| 224 | This value is initially set based on the value of the :option:`-X` |
| 225 | ``pycache_prefix=PATH`` command-line option or the |
| 226 | :envvar:`PYTHONPYCACHEPREFIX` environment variable (command-line takes |
| 227 | precedence). If neither are set, it is ``None``. |
| 228 | |
| 229 | .. versionadded:: 3.8 |
| 230 | |
| 231 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 232 | .. function:: excepthook(type, value, traceback) |
| 233 | |
| 234 | This function prints out a given traceback and exception to ``sys.stderr``. |
| 235 | |
| 236 | When an exception is raised and uncaught, the interpreter calls |
| 237 | ``sys.excepthook`` with three arguments, the exception class, exception |
| 238 | instance, and a traceback object. In an interactive session this happens just |
| 239 | before control is returned to the prompt; in a Python program this happens just |
| 240 | before the program exits. The handling of such top-level exceptions can be |
| 241 | customized by assigning another three-argument function to ``sys.excepthook``. |
| 242 | |
| 243 | |
Barry Warsaw | 36c1d1f | 2017-10-05 12:11:18 -0400 | [diff] [blame] | 244 | .. data:: __breakpointhook__ |
| 245 | __displayhook__ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 246 | __excepthook__ |
| 247 | |
Barry Warsaw | 36c1d1f | 2017-10-05 12:11:18 -0400 | [diff] [blame] | 248 | These objects contain the original values of ``breakpointhook``, |
| 249 | ``displayhook``, and ``excepthook`` at the start of the program. They are |
| 250 | saved so that ``breakpointhook``, ``displayhook`` and ``excepthook`` can be |
| 251 | restored in case they happen to get replaced with broken or alternative |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 252 | objects. |
| 253 | |
Barry Warsaw | 36c1d1f | 2017-10-05 12:11:18 -0400 | [diff] [blame] | 254 | .. versionadded:: 3.7 |
| 255 | __breakpointhook__ |
| 256 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 257 | |
| 258 | .. function:: exc_info() |
| 259 | |
| 260 | This function returns a tuple of three values that give information about the |
| 261 | exception that is currently being handled. The information returned is specific |
| 262 | both to the current thread and to the current stack frame. If the current stack |
| 263 | frame is not handling an exception, the information is taken from the calling |
| 264 | stack frame, or its caller, and so on until a stack frame is found that is |
| 265 | handling an exception. Here, "handling an exception" is defined as "executing |
Benjamin Peterson | eec3d71 | 2008-06-11 15:59:43 +0000 | [diff] [blame] | 266 | an except clause." For any stack frame, only information about the exception |
| 267 | being currently handled is accessible. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 268 | |
| 269 | .. index:: object: traceback |
| 270 | |
Georg Brandl | 482b151 | 2010-03-21 09:02:59 +0000 | [diff] [blame] | 271 | If no exception is being handled anywhere on the stack, a tuple containing |
| 272 | three ``None`` values is returned. Otherwise, the values returned are |
| 273 | ``(type, value, traceback)``. Their meaning is: *type* gets the type of the |
| 274 | exception being handled (a subclass of :exc:`BaseException`); *value* gets |
| 275 | the exception instance (an instance of the exception type); *traceback* gets |
| 276 | a traceback object (see the Reference Manual) which encapsulates the call |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 277 | stack at the point where the exception originally occurred. |
| 278 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 279 | |
| 280 | .. data:: exec_prefix |
| 281 | |
| 282 | A string giving the site-specific directory prefix where the platform-dependent |
| 283 | Python files are installed; by default, this is also ``'/usr/local'``. This can |
Éric Araujo | 713d303 | 2010-11-18 16:38:46 +0000 | [diff] [blame] | 284 | be set at build time with the ``--exec-prefix`` argument to the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 285 | :program:`configure` script. Specifically, all configuration files (e.g. the |
Éric Araujo | 58a9153 | 2011-10-05 01:28:24 +0200 | [diff] [blame] | 286 | :file:`pyconfig.h` header file) are installed in the directory |
Georg Brandl | eb25fb7 | 2012-02-23 21:12:39 +0100 | [diff] [blame] | 287 | :file:`{exec_prefix}/lib/python{X.Y}/config`, and shared library modules are |
Éric Araujo | 58a9153 | 2011-10-05 01:28:24 +0200 | [diff] [blame] | 288 | installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y* |
| 289 | is the version number of Python, for example ``3.2``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 290 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 291 | .. note:: |
| 292 | |
| 293 | If a :ref:`virtual environment <venv-def>` is in effect, this |
Vinay Sajip | cd9b746 | 2012-07-09 10:37:01 +0100 | [diff] [blame] | 294 | value will be changed in ``site.py`` to point to the virtual environment. |
| 295 | The value for the Python installation will still be available, via |
| 296 | :data:`base_exec_prefix`. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 297 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 298 | |
| 299 | .. data:: executable |
| 300 | |
Petri Lehtinen | 9713321 | 2012-02-02 20:59:48 +0200 | [diff] [blame] | 301 | A string giving the absolute path of the executable binary for the Python |
| 302 | interpreter, on systems where this makes sense. If Python is unable to retrieve |
| 303 | the real path to its executable, :data:`sys.executable` will be an empty string |
| 304 | or ``None``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 305 | |
| 306 | |
| 307 | .. function:: exit([arg]) |
| 308 | |
| 309 | Exit from Python. This is implemented by raising the :exc:`SystemExit` |
| 310 | exception, so cleanup actions specified by finally clauses of :keyword:`try` |
Georg Brandl | 6f4e68d | 2010-10-17 10:51:45 +0000 | [diff] [blame] | 311 | statements are honored, and it is possible to intercept the exit attempt at |
| 312 | an outer level. |
| 313 | |
| 314 | The optional argument *arg* can be an integer giving the exit status |
| 315 | (defaulting to zero), or another type of object. If it is an integer, zero |
| 316 | is considered "successful termination" and any nonzero value is considered |
| 317 | "abnormal termination" by shells and the like. Most systems require it to be |
Martin Panter | b4ce1fc | 2015-11-30 03:18:29 +0000 | [diff] [blame] | 318 | in the range 0--127, and produce undefined results otherwise. Some systems |
Georg Brandl | 6f4e68d | 2010-10-17 10:51:45 +0000 | [diff] [blame] | 319 | have a convention for assigning specific meanings to specific exit codes, but |
| 320 | these are generally underdeveloped; Unix programs generally use 2 for command |
| 321 | line syntax errors and 1 for all other kind of errors. If another type of |
| 322 | object is passed, ``None`` is equivalent to passing zero, and any other |
| 323 | object is printed to :data:`stderr` and results in an exit code of 1. In |
| 324 | particular, ``sys.exit("some error message")`` is a quick way to exit a |
| 325 | program when an error occurs. |
| 326 | |
| 327 | Since :func:`exit` ultimately "only" raises an exception, it will only exit |
| 328 | the process when called from the main thread, and the exception is not |
| 329 | intercepted. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 330 | |
Martin Panter | b4ce1fc | 2015-11-30 03:18:29 +0000 | [diff] [blame] | 331 | .. versionchanged:: 3.6 |
| 332 | If an error occurs in the cleanup after the Python interpreter |
| 333 | has caught :exc:`SystemExit` (such as an error flushing buffered data |
| 334 | in the standard streams), the exit status is changed to 120. |
| 335 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 336 | |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 337 | .. data:: flags |
| 338 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 339 | The :term:`struct sequence` *flags* exposes the status of command line |
| 340 | flags. The attributes are read only. |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 341 | |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 342 | ============================= ============================= |
| 343 | attribute flag |
| 344 | ============================= ============================= |
| 345 | :const:`debug` :option:`-d` |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 346 | :const:`inspect` :option:`-i` |
| 347 | :const:`interactive` :option:`-i` |
Danish Prakash | 656d52d | 2018-10-07 16:12:31 +0000 | [diff] [blame^] | 348 | :const:`isolated` :option:`-I` |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 349 | :const:`optimize` :option:`-O` or :option:`-OO` |
| 350 | :const:`dont_write_bytecode` :option:`-B` |
| 351 | :const:`no_user_site` :option:`-s` |
| 352 | :const:`no_site` :option:`-S` |
| 353 | :const:`ignore_environment` :option:`-E` |
| 354 | :const:`verbose` :option:`-v` |
| 355 | :const:`bytes_warning` :option:`-b` |
Éric Araujo | 722bec4 | 2011-03-26 01:59:47 +0100 | [diff] [blame] | 356 | :const:`quiet` :option:`-q` |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 357 | :const:`hash_randomization` :option:`-R` |
Victor Stinner | 5e3806f | 2017-11-30 11:40:24 +0100 | [diff] [blame] | 358 | :const:`dev_mode` :option:`-X` ``dev`` |
Victor Stinner | 91106cd | 2017-12-13 12:29:09 +0100 | [diff] [blame] | 359 | :const:`utf8_mode` :option:`-X` ``utf8`` |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 360 | ============================= ============================= |
Georg Brandl | 8aa7e99 | 2010-12-28 18:30:18 +0000 | [diff] [blame] | 361 | |
| 362 | .. versionchanged:: 3.2 |
| 363 | Added ``quiet`` attribute for the new :option:`-q` flag. |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 364 | |
Georg Brandl | 09a7c72 | 2012-02-20 21:31:46 +0100 | [diff] [blame] | 365 | .. versionadded:: 3.2.3 |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 366 | The ``hash_randomization`` attribute. |
| 367 | |
Éric Araujo | 3e89870 | 2011-04-24 04:37:00 +0200 | [diff] [blame] | 368 | .. versionchanged:: 3.3 |
| 369 | Removed obsolete ``division_warning`` attribute. |
| 370 | |
Danish Prakash | 656d52d | 2018-10-07 16:12:31 +0000 | [diff] [blame^] | 371 | .. versionchanged:: 3.4 |
| 372 | Added ``isolated`` attribute for :option:`-I` ``isolated`` flag. |
| 373 | |
Victor Stinner | 5e3806f | 2017-11-30 11:40:24 +0100 | [diff] [blame] | 374 | .. versionchanged:: 3.7 |
Victor Stinner | 91106cd | 2017-12-13 12:29:09 +0100 | [diff] [blame] | 375 | Added ``dev_mode`` attribute for the new :option:`-X` ``dev`` flag |
| 376 | and ``utf8_mode`` attribute for the new :option:`-X` ``utf8`` flag. |
Victor Stinner | 5e3806f | 2017-11-30 11:40:24 +0100 | [diff] [blame] | 377 | |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 378 | |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 379 | .. data:: float_info |
| 380 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 381 | A :term:`struct sequence` holding information about the float type. It |
| 382 | contains low level information about the precision and internal |
| 383 | representation. The values correspond to the various floating-point |
| 384 | constants defined in the standard header file :file:`float.h` for the 'C' |
| 385 | programming language; see section 5.2.4.2.2 of the 1999 ISO/IEC C standard |
| 386 | [C99]_, 'Characteristics of floating types', for details. |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 387 | |
Georg Brandl | 44ea77b | 2013-03-28 13:28:44 +0100 | [diff] [blame] | 388 | .. tabularcolumns:: |l|l|L| |
| 389 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 390 | +---------------------+----------------+--------------------------------------------------+ |
| 391 | | attribute | float.h macro | explanation | |
| 392 | +=====================+================+==================================================+ |
Mark Dickinson | 39af05f | 2010-07-03 09:17:16 +0000 | [diff] [blame] | 393 | | :const:`epsilon` | DBL_EPSILON | difference between 1 and the least value greater | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 394 | | | | than 1 that is representable as a float | |
| 395 | +---------------------+----------------+--------------------------------------------------+ |
| 396 | | :const:`dig` | DBL_DIG | maximum number of decimal digits that can be | |
| 397 | | | | faithfully represented in a float; see below | |
| 398 | +---------------------+----------------+--------------------------------------------------+ |
| 399 | | :const:`mant_dig` | DBL_MANT_DIG | float precision: the number of base-``radix`` | |
| 400 | | | | digits in the significand of a float | |
| 401 | +---------------------+----------------+--------------------------------------------------+ |
| 402 | | :const:`max` | DBL_MAX | maximum representable finite float | |
| 403 | +---------------------+----------------+--------------------------------------------------+ |
| 404 | | :const:`max_exp` | DBL_MAX_EXP | maximum integer e such that ``radix**(e-1)`` is | |
| 405 | | | | a representable finite float | |
| 406 | +---------------------+----------------+--------------------------------------------------+ |
| 407 | | :const:`max_10_exp` | DBL_MAX_10_EXP | maximum integer e such that ``10**e`` is in the | |
| 408 | | | | range of representable finite floats | |
| 409 | +---------------------+----------------+--------------------------------------------------+ |
| 410 | | :const:`min` | DBL_MIN | minimum positive normalized float | |
| 411 | +---------------------+----------------+--------------------------------------------------+ |
| 412 | | :const:`min_exp` | DBL_MIN_EXP | minimum integer e such that ``radix**(e-1)`` is | |
| 413 | | | | a normalized float | |
| 414 | +---------------------+----------------+--------------------------------------------------+ |
| 415 | | :const:`min_10_exp` | DBL_MIN_10_EXP | minimum integer e such that ``10**e`` is a | |
| 416 | | | | normalized float | |
| 417 | +---------------------+----------------+--------------------------------------------------+ |
| 418 | | :const:`radix` | FLT_RADIX | radix of exponent representation | |
| 419 | +---------------------+----------------+--------------------------------------------------+ |
Mark Dickinson | b1e58fe | 2011-11-19 16:26:45 +0000 | [diff] [blame] | 420 | | :const:`rounds` | FLT_ROUNDS | integer constant representing the rounding mode | |
| 421 | | | | used for arithmetic operations. This reflects | |
| 422 | | | | the value of the system FLT_ROUNDS macro at | |
| 423 | | | | interpreter startup time. See section 5.2.4.2.2 | |
| 424 | | | | of the C99 standard for an explanation of the | |
| 425 | | | | possible values and their meanings. | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 426 | +---------------------+----------------+--------------------------------------------------+ |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 427 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 428 | The attribute :attr:`sys.float_info.dig` needs further explanation. If |
| 429 | ``s`` is any string representing a decimal number with at most |
| 430 | :attr:`sys.float_info.dig` significant digits, then converting ``s`` to a |
| 431 | float and back again will recover a string representing the same decimal |
| 432 | value:: |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 433 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 434 | >>> import sys |
| 435 | >>> sys.float_info.dig |
| 436 | 15 |
| 437 | >>> s = '3.14159265358979' # decimal string with 15 significant digits |
| 438 | >>> format(float(s), '.15g') # convert to float and back -> same value |
| 439 | '3.14159265358979' |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 440 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 441 | But for strings with more than :attr:`sys.float_info.dig` significant digits, |
| 442 | this isn't always true:: |
| 443 | |
| 444 | >>> s = '9876543211234567' # 16 significant digits is too many! |
| 445 | >>> format(float(s), '.16g') # conversion changes value |
| 446 | '9876543211234568' |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 447 | |
Mark Dickinson | b08a53a | 2009-04-16 19:52:09 +0000 | [diff] [blame] | 448 | .. data:: float_repr_style |
| 449 | |
| 450 | A string indicating how the :func:`repr` function behaves for |
| 451 | floats. If the string has value ``'short'`` then for a finite |
| 452 | float ``x``, ``repr(x)`` aims to produce a short string with the |
| 453 | property that ``float(repr(x)) == x``. This is the usual behaviour |
| 454 | in Python 3.1 and later. Otherwise, ``float_repr_style`` has value |
| 455 | ``'legacy'`` and ``repr(x)`` behaves in the same way as it did in |
| 456 | versions of Python prior to 3.1. |
| 457 | |
| 458 | .. versionadded:: 3.1 |
| 459 | |
| 460 | |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 461 | .. function:: getallocatedblocks() |
| 462 | |
| 463 | Return the number of memory blocks currently allocated by the interpreter, |
Antoine Pitrou | 9284053 | 2012-12-17 23:05:59 +0100 | [diff] [blame] | 464 | regardless of their size. This function is mainly useful for tracking |
| 465 | and debugging memory leaks. Because of the interpreter's internal |
| 466 | caches, the result can vary from call to call; you may have to call |
| 467 | :func:`_clear_type_cache()` and :func:`gc.collect()` to get more |
| 468 | predictable results. |
| 469 | |
| 470 | If a Python build or implementation cannot reasonably compute this |
| 471 | information, :func:`getallocatedblocks()` is allowed to return 0 instead. |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 472 | |
| 473 | .. versionadded:: 3.4 |
| 474 | |
Antoine Pitrou | f9d0b12 | 2012-12-09 14:28:26 +0100 | [diff] [blame] | 475 | |
Victor Stinner | d6958ac | 2016-12-02 01:13:46 +0100 | [diff] [blame] | 476 | .. function:: getandroidapilevel() |
| 477 | |
| 478 | Return the build time API version of Android as an integer. |
| 479 | |
| 480 | Availability: Android. |
| 481 | |
| 482 | .. versionadded:: 3.7 |
| 483 | |
| 484 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 485 | .. function:: getcheckinterval() |
| 486 | |
| 487 | Return the interpreter's "check interval"; see :func:`setcheckinterval`. |
| 488 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 489 | .. deprecated:: 3.2 |
| 490 | Use :func:`getswitchinterval` instead. |
| 491 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 492 | |
| 493 | .. function:: getdefaultencoding() |
| 494 | |
| 495 | Return the name of the current default string encoding used by the Unicode |
| 496 | implementation. |
| 497 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 498 | |
| 499 | .. function:: getdlopenflags() |
| 500 | |
Andrew Kuchling | c61b913 | 2013-06-21 10:58:41 -0400 | [diff] [blame] | 501 | Return the current value of the flags that are used for |
| 502 | :c:func:`dlopen` calls. Symbolic names for the flag values can be |
| 503 | found in the :mod:`os` module (``RTLD_xxx`` constants, e.g. |
| 504 | :data:`os.RTLD_LAZY`). Availability: Unix. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 505 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 506 | |
| 507 | .. function:: getfilesystemencoding() |
| 508 | |
Steve Dower | cc16be8 | 2016-09-08 10:35:16 -0700 | [diff] [blame] | 509 | Return the name of the encoding used to convert between Unicode |
| 510 | filenames and bytes filenames. For best compatibility, str should be |
| 511 | used for filenames in all cases, although representing filenames as bytes |
| 512 | is also supported. Functions accepting or returning filenames should support |
| 513 | either str or bytes and internally convert to the system's preferred |
| 514 | representation. |
| 515 | |
| 516 | This encoding is always ASCII-compatible. |
| 517 | |
| 518 | :func:`os.fsencode` and :func:`os.fsdecode` should be used to ensure that |
| 519 | the correct encoding and errors mode are used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 520 | |
Victor Stinner | 91106cd | 2017-12-13 12:29:09 +0100 | [diff] [blame] | 521 | * In the UTF-8 mode, the encoding is ``utf-8`` on any platform. |
| 522 | |
Ezio Melotti | d5334e1 | 2010-04-29 16:24:51 +0000 | [diff] [blame] | 523 | * On Mac OS X, the encoding is ``'utf-8'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 524 | |
Steve Dower | cc16be8 | 2016-09-08 10:35:16 -0700 | [diff] [blame] | 525 | * On Unix, the encoding is the locale encoding. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 526 | |
Steve Dower | cc16be8 | 2016-09-08 10:35:16 -0700 | [diff] [blame] | 527 | * On Windows, the encoding may be ``'utf-8'`` or ``'mbcs'``, depending |
| 528 | on user configuration. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 529 | |
Victor Stinner | b744ba1 | 2010-05-15 12:27:16 +0000 | [diff] [blame] | 530 | .. versionchanged:: 3.2 |
Victor Stinner | 22d0418 | 2013-12-02 12:16:46 +0100 | [diff] [blame] | 531 | :func:`getfilesystemencoding` result cannot be ``None`` anymore. |
Victor Stinner | b744ba1 | 2010-05-15 12:27:16 +0000 | [diff] [blame] | 532 | |
Steve Dower | cc16be8 | 2016-09-08 10:35:16 -0700 | [diff] [blame] | 533 | .. versionchanged:: 3.6 |
| 534 | Windows is no longer guaranteed to return ``'mbcs'``. See :pep:`529` |
| 535 | and :func:`_enablelegacywindowsfsencoding` for more information. |
| 536 | |
Victor Stinner | 91106cd | 2017-12-13 12:29:09 +0100 | [diff] [blame] | 537 | .. versionchanged:: 3.7 |
| 538 | Return 'utf-8' in the UTF-8 mode. |
| 539 | |
| 540 | |
Steve Dower | cc16be8 | 2016-09-08 10:35:16 -0700 | [diff] [blame] | 541 | .. function:: getfilesystemencodeerrors() |
| 542 | |
| 543 | Return the name of the error mode used to convert between Unicode filenames |
| 544 | and bytes filenames. The encoding name is returned from |
| 545 | :func:`getfilesystemencoding`. |
| 546 | |
| 547 | :func:`os.fsencode` and :func:`os.fsdecode` should be used to ensure that |
| 548 | the correct encoding and errors mode are used. |
| 549 | |
| 550 | .. versionadded:: 3.6 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 551 | |
| 552 | .. function:: getrefcount(object) |
| 553 | |
| 554 | Return the reference count of the *object*. The count returned is generally one |
| 555 | higher than you might expect, because it includes the (temporary) reference as |
| 556 | an argument to :func:`getrefcount`. |
| 557 | |
| 558 | |
| 559 | .. function:: getrecursionlimit() |
| 560 | |
| 561 | Return the current value of the recursion limit, the maximum depth of the Python |
| 562 | interpreter stack. This limit prevents infinite recursion from causing an |
| 563 | overflow of the C stack and crashing Python. It can be set by |
| 564 | :func:`setrecursionlimit`. |
| 565 | |
| 566 | |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 567 | .. function:: getsizeof(object[, default]) |
Martin v. Löwis | 00709aa | 2008-06-04 14:18:43 +0000 | [diff] [blame] | 568 | |
| 569 | Return the size of an object in bytes. The object can be any type of |
| 570 | object. All built-in objects will return correct results, but this |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 571 | does not have to hold true for third-party extensions as it is implementation |
Martin v. Löwis | 00709aa | 2008-06-04 14:18:43 +0000 | [diff] [blame] | 572 | specific. |
| 573 | |
Martin v. Löwis | 1e5d0ff | 2012-06-17 10:40:16 +0200 | [diff] [blame] | 574 | Only the memory consumption directly attributed to the object is |
| 575 | accounted for, not the memory consumption of objects it refers to. |
| 576 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 577 | If given, *default* will be returned if the object does not provide means to |
Georg Brandl | ef871f6 | 2010-03-12 10:06:40 +0000 | [diff] [blame] | 578 | retrieve the size. Otherwise a :exc:`TypeError` will be raised. |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 579 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 580 | :func:`getsizeof` calls the object's ``__sizeof__`` method and adds an |
| 581 | additional garbage collector overhead if the object is managed by the garbage |
| 582 | collector. |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 583 | |
Serhiy Storchaka | 6dff020 | 2016-05-07 10:49:07 +0300 | [diff] [blame] | 584 | See `recursive sizeof recipe <https://code.activestate.com/recipes/577504>`_ |
Raymond Hettinger | c539a2a | 2010-12-17 23:31:30 +0000 | [diff] [blame] | 585 | for an example of using :func:`getsizeof` recursively to find the size of |
| 586 | containers and all their contents. |
Martin v. Löwis | 00709aa | 2008-06-04 14:18:43 +0000 | [diff] [blame] | 587 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 588 | .. function:: getswitchinterval() |
| 589 | |
| 590 | Return the interpreter's "thread switch interval"; see |
| 591 | :func:`setswitchinterval`. |
| 592 | |
Antoine Pitrou | 79707ca | 2009-11-11 22:03:32 +0000 | [diff] [blame] | 593 | .. versionadded:: 3.2 |
| 594 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 595 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 596 | .. function:: _getframe([depth]) |
| 597 | |
| 598 | Return a frame object from the call stack. If optional integer *depth* is |
| 599 | given, return the frame object that many calls below the top of the stack. If |
| 600 | that is deeper than the call stack, :exc:`ValueError` is raised. The default |
| 601 | for *depth* is zero, returning the frame at the top of the call stack. |
| 602 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 603 | .. impl-detail:: |
| 604 | |
| 605 | This function should be used for internal and specialized purposes only. |
| 606 | It is not guaranteed to exist in all implementations of Python. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 607 | |
| 608 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 609 | .. function:: getprofile() |
| 610 | |
| 611 | .. index:: |
| 612 | single: profile function |
| 613 | single: profiler |
| 614 | |
| 615 | Get the profiler function as set by :func:`setprofile`. |
| 616 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 617 | |
| 618 | .. function:: gettrace() |
| 619 | |
| 620 | .. index:: |
| 621 | single: trace function |
| 622 | single: debugger |
| 623 | |
| 624 | Get the trace function as set by :func:`settrace`. |
| 625 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 626 | .. impl-detail:: |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 627 | |
| 628 | The :func:`gettrace` function is intended only for implementing debuggers, |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 629 | profilers, coverage tools and the like. Its behavior is part of the |
| 630 | implementation platform, rather than part of the language definition, and |
| 631 | thus may not be available in all Python implementations. |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 632 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 633 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 634 | .. function:: getwindowsversion() |
| 635 | |
Eric Smith | 7338a39 | 2010-01-27 00:56:30 +0000 | [diff] [blame] | 636 | Return a named tuple describing the Windows version |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 637 | currently running. The named elements are *major*, *minor*, |
| 638 | *build*, *platform*, *service_pack*, *service_pack_minor*, |
Steve Dower | 74f4af7 | 2016-09-17 17:27:48 -0700 | [diff] [blame] | 639 | *service_pack_major*, *suite_mask*, *product_type* and |
| 640 | *platform_version*. *service_pack* contains a string, |
| 641 | *platform_version* a 3-tuple and all other values are |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 642 | integers. The components can also be accessed by name, so |
| 643 | ``sys.getwindowsversion()[0]`` is equivalent to |
| 644 | ``sys.getwindowsversion().major``. For compatibility with prior |
| 645 | versions, only the first 5 elements are retrievable by indexing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 646 | |
Steve Dower | 74f4af7 | 2016-09-17 17:27:48 -0700 | [diff] [blame] | 647 | *platform* will be :const:`2 (VER_PLATFORM_WIN32_NT)`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 648 | |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 649 | *product_type* may be one of the following values: |
| 650 | |
| 651 | +---------------------------------------+---------------------------------+ |
| 652 | | Constant | Meaning | |
| 653 | +=======================================+=================================+ |
| 654 | | :const:`1 (VER_NT_WORKSTATION)` | The system is a workstation. | |
| 655 | +---------------------------------------+---------------------------------+ |
| 656 | | :const:`2 (VER_NT_DOMAIN_CONTROLLER)` | The system is a domain | |
| 657 | | | controller. | |
| 658 | +---------------------------------------+---------------------------------+ |
| 659 | | :const:`3 (VER_NT_SERVER)` | The system is a server, but not | |
| 660 | | | a domain controller. | |
| 661 | +---------------------------------------+---------------------------------+ |
| 662 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 663 | This function wraps the Win32 :c:func:`GetVersionEx` function; see the |
| 664 | Microsoft documentation on :c:func:`OSVERSIONINFOEX` for more information |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 665 | about these fields. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 666 | |
Steve Dower | 74f4af7 | 2016-09-17 17:27:48 -0700 | [diff] [blame] | 667 | *platform_version* returns the accurate major version, minor version and |
| 668 | build number of the current operating system, rather than the version that |
| 669 | is being emulated for the process. It is intended for use in logging rather |
| 670 | than for feature detection. |
| 671 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 672 | Availability: Windows. |
| 673 | |
Ezio Melotti | 83fc6dd | 2010-01-27 22:44:03 +0000 | [diff] [blame] | 674 | .. versionchanged:: 3.2 |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 675 | Changed to a named tuple and added *service_pack_minor*, |
| 676 | *service_pack_major*, *suite_mask*, and *product_type*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 677 | |
Steve Dower | 74f4af7 | 2016-09-17 17:27:48 -0700 | [diff] [blame] | 678 | .. versionchanged:: 3.6 |
| 679 | Added *platform_version* |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 680 | |
Yury Selivanov | 0366004 | 2016-12-15 17:36:05 -0500 | [diff] [blame] | 681 | |
| 682 | .. function:: get_asyncgen_hooks() |
| 683 | |
| 684 | Returns an *asyncgen_hooks* object, which is similar to a |
| 685 | :class:`~collections.namedtuple` of the form `(firstiter, finalizer)`, |
| 686 | where *firstiter* and *finalizer* are expected to be either ``None`` or |
| 687 | functions which take an :term:`asynchronous generator iterator` as an |
Ville Skyttä | 49b2734 | 2017-08-03 09:00:59 +0300 | [diff] [blame] | 688 | argument, and are used to schedule finalization of an asynchronous |
Yury Selivanov | 0366004 | 2016-12-15 17:36:05 -0500 | [diff] [blame] | 689 | generator by an event loop. |
| 690 | |
| 691 | .. versionadded:: 3.6 |
| 692 | See :pep:`525` for more details. |
| 693 | |
| 694 | .. note:: |
| 695 | This function has been added on a provisional basis (see :pep:`411` |
| 696 | for details.) |
| 697 | |
| 698 | |
Nathaniel J. Smith | fc2f407 | 2018-01-21 06:44:07 -0800 | [diff] [blame] | 699 | .. function:: get_coroutine_origin_tracking_depth() |
| 700 | |
| 701 | Get the current coroutine origin tracking depth, as set by |
| 702 | func:`set_coroutine_origin_tracking_depth`. |
| 703 | |
| 704 | .. versionadded:: 3.7 |
| 705 | |
| 706 | .. note:: |
| 707 | This function has been added on a provisional basis (see :pep:`411` |
| 708 | for details.) Use it only for debugging purposes. |
| 709 | |
| 710 | |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 711 | .. function:: get_coroutine_wrapper() |
| 712 | |
| 713 | Returns ``None``, or a wrapper set by :func:`set_coroutine_wrapper`. |
| 714 | |
| 715 | .. versionadded:: 3.5 |
| 716 | See :pep:`492` for more details. |
| 717 | |
| 718 | .. note:: |
| 719 | This function has been added on a provisional basis (see :pep:`411` |
Yury Selivanov | 4180e43 | 2015-06-04 11:10:24 -0400 | [diff] [blame] | 720 | for details.) Use it only for debugging purposes. |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 721 | |
Nathaniel J. Smith | fc2f407 | 2018-01-21 06:44:07 -0800 | [diff] [blame] | 722 | .. deprecated:: 3.7 |
| 723 | The coroutine wrapper functionality has been deprecated, and |
| 724 | will be removed in 3.8. See :issue:`32591` for details. |
| 725 | |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 726 | |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 727 | .. data:: hash_info |
| 728 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 729 | A :term:`struct sequence` giving parameters of the numeric hash |
| 730 | implementation. For more details about hashing of numeric types, see |
| 731 | :ref:`numeric-hash`. |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 732 | |
| 733 | +---------------------+--------------------------------------------------+ |
| 734 | | attribute | explanation | |
| 735 | +=====================+==================================================+ |
| 736 | | :const:`width` | width in bits used for hash values | |
| 737 | +---------------------+--------------------------------------------------+ |
| 738 | | :const:`modulus` | prime modulus P used for numeric hash scheme | |
| 739 | +---------------------+--------------------------------------------------+ |
| 740 | | :const:`inf` | hash value returned for a positive infinity | |
| 741 | +---------------------+--------------------------------------------------+ |
| 742 | | :const:`nan` | hash value returned for a nan | |
| 743 | +---------------------+--------------------------------------------------+ |
| 744 | | :const:`imag` | multiplier used for the imaginary part of a | |
| 745 | | | complex number | |
| 746 | +---------------------+--------------------------------------------------+ |
Christian Heimes | 985ecdc | 2013-11-20 11:46:18 +0100 | [diff] [blame] | 747 | | :const:`algorithm` | name of the algorithm for hashing of str, bytes, | |
| 748 | | | and memoryview | |
| 749 | +---------------------+--------------------------------------------------+ |
| 750 | | :const:`hash_bits` | internal output size of the hash algorithm | |
| 751 | +---------------------+--------------------------------------------------+ |
| 752 | | :const:`seed_bits` | size of the seed key of the hash algorithm | |
| 753 | +---------------------+--------------------------------------------------+ |
| 754 | |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 755 | |
| 756 | .. versionadded:: 3.2 |
| 757 | |
R David Murray | f93d3df | 2014-03-17 11:20:29 -0400 | [diff] [blame] | 758 | .. versionchanged:: 3.4 |
Christian Heimes | 985ecdc | 2013-11-20 11:46:18 +0100 | [diff] [blame] | 759 | Added *algorithm*, *hash_bits* and *seed_bits* |
| 760 | |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 761 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 762 | .. data:: hexversion |
| 763 | |
| 764 | The version number encoded as a single integer. This is guaranteed to increase |
| 765 | with each version, including proper support for non-production releases. For |
| 766 | example, to test that the Python interpreter is at least version 1.5.2, use:: |
| 767 | |
| 768 | if sys.hexversion >= 0x010502F0: |
| 769 | # use some advanced feature |
| 770 | ... |
| 771 | else: |
| 772 | # use an alternative implementation or warn the user |
| 773 | ... |
| 774 | |
| 775 | This is called ``hexversion`` since it only really looks meaningful when viewed |
| 776 | as the result of passing it to the built-in :func:`hex` function. The |
Éric Araujo | 0abb8b7 | 2011-04-27 16:32:36 +0200 | [diff] [blame] | 777 | :term:`struct sequence` :data:`sys.version_info` may be used for a more |
| 778 | human-friendly encoding of the same information. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 779 | |
Martin Panter | d21e0b5 | 2015-10-10 10:36:22 +0000 | [diff] [blame] | 780 | More details of ``hexversion`` can be found at :ref:`apiabiversion`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 781 | |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 782 | |
| 783 | .. data:: implementation |
| 784 | |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 785 | An object containing information about the implementation of the |
| 786 | currently running Python interpreter. The following attributes are |
| 787 | required to exist in all Python implementations. |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 788 | |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 789 | *name* is the implementation's identifier, e.g. ``'cpython'``. The actual |
| 790 | string is defined by the Python implementation, but it is guaranteed to be |
| 791 | lower case. |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 792 | |
| 793 | *version* is a named tuple, in the same format as |
| 794 | :data:`sys.version_info`. It represents the version of the Python |
| 795 | *implementation*. This has a distinct meaning from the specific |
| 796 | version of the Python *language* to which the currently running |
| 797 | interpreter conforms, which ``sys.version_info`` represents. For |
| 798 | example, for PyPy 1.8 ``sys.implementation.version`` might be |
| 799 | ``sys.version_info(1, 8, 0, 'final', 0)``, whereas ``sys.version_info`` |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 800 | would be ``sys.version_info(2, 7, 2, 'final', 0)``. For CPython they |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 801 | are the same value, since it is the reference implementation. |
| 802 | |
| 803 | *hexversion* is the implementation version in hexadecimal format, like |
| 804 | :data:`sys.hexversion`. |
| 805 | |
| 806 | *cache_tag* is the tag used by the import machinery in the filenames of |
| 807 | cached modules. By convention, it would be a composite of the |
| 808 | implementation's name and version, like ``'cpython-33'``. However, a |
| 809 | Python implementation may use some other value if appropriate. If |
| 810 | ``cache_tag`` is set to ``None``, it indicates that module caching should |
| 811 | be disabled. |
| 812 | |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 813 | :data:`sys.implementation` may contain additional attributes specific to |
| 814 | the Python implementation. These non-standard attributes must start with |
| 815 | an underscore, and are not described here. Regardless of its contents, |
| 816 | :data:`sys.implementation` will not change during a run of the interpreter, |
| 817 | nor between implementation versions. (It may change between Python |
Georg Brandl | 93a56cd | 2014-10-30 22:25:41 +0100 | [diff] [blame] | 818 | language versions, however.) See :pep:`421` for more information. |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 819 | |
| 820 | .. versionadded:: 3.3 |
| 821 | |
| 822 | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 823 | .. data:: int_info |
| 824 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 825 | A :term:`struct sequence` that holds information about Python's internal |
| 826 | representation of integers. The attributes are read only. |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 827 | |
Georg Brandl | 44ea77b | 2013-03-28 13:28:44 +0100 | [diff] [blame] | 828 | .. tabularcolumns:: |l|L| |
| 829 | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 830 | +-------------------------+----------------------------------------------+ |
R David Murray | 9beb34e | 2011-04-30 16:35:29 -0400 | [diff] [blame] | 831 | | Attribute | Explanation | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 832 | +=========================+==============================================+ |
| 833 | | :const:`bits_per_digit` | number of bits held in each digit. Python | |
| 834 | | | integers are stored internally in base | |
| 835 | | | ``2**int_info.bits_per_digit`` | |
| 836 | +-------------------------+----------------------------------------------+ |
| 837 | | :const:`sizeof_digit` | size in bytes of the C type used to | |
| 838 | | | represent a digit | |
| 839 | +-------------------------+----------------------------------------------+ |
| 840 | |
Mark Dickinson | d72c7b6 | 2009-03-20 16:00:49 +0000 | [diff] [blame] | 841 | .. versionadded:: 3.1 |
| 842 | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 843 | |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 844 | .. data:: __interactivehook__ |
| 845 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 846 | When this attribute exists, its value is automatically called (with no |
| 847 | arguments) when the interpreter is launched in :ref:`interactive mode |
| 848 | <tut-interactive>`. This is done after the :envvar:`PYTHONSTARTUP` file is |
| 849 | read, so that you can set this hook there. The :mod:`site` module |
| 850 | :ref:`sets this <rlcompleter-config>`. |
Antoine Pitrou | 1a6cb30 | 2013-05-04 20:08:35 +0200 | [diff] [blame] | 851 | |
| 852 | .. versionadded:: 3.4 |
| 853 | |
| 854 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 855 | .. function:: intern(string) |
| 856 | |
| 857 | Enter *string* in the table of "interned" strings and return the interned string |
| 858 | -- which is *string* itself or a copy. Interning strings is useful to gain a |
| 859 | little performance on dictionary lookup -- if the keys in a dictionary are |
| 860 | interned, and the lookup key is interned, the key comparisons (after hashing) |
| 861 | can be done by a pointer compare instead of a string compare. Normally, the |
| 862 | names used in Python programs are automatically interned, and the dictionaries |
| 863 | used to hold module, class or instance attributes have interned keys. |
| 864 | |
Georg Brandl | 55ac8f0 | 2007-09-01 13:51:09 +0000 | [diff] [blame] | 865 | Interned strings are not immortal; you must keep a reference to the return |
| 866 | value of :func:`intern` around to benefit from it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 867 | |
| 868 | |
Antoine Pitrou | 5db1bb8 | 2014-12-07 01:28:27 +0100 | [diff] [blame] | 869 | .. function:: is_finalizing() |
| 870 | |
| 871 | Return :const:`True` if the Python interpreter is |
| 872 | :term:`shutting down <interpreter shutdown>`, :const:`False` otherwise. |
| 873 | |
| 874 | .. versionadded:: 3.5 |
| 875 | |
| 876 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 877 | .. data:: last_type |
| 878 | last_value |
| 879 | last_traceback |
| 880 | |
| 881 | These three variables are not always defined; they are set when an exception is |
| 882 | not handled and the interpreter prints an error message and a stack traceback. |
| 883 | Their intended use is to allow an interactive user to import a debugger module |
| 884 | and engage in post-mortem debugging without having to re-execute the command |
| 885 | that caused the error. (Typical use is ``import pdb; pdb.pm()`` to enter the |
Alexander Belopolsky | f0a0d14 | 2010-10-27 03:06:43 +0000 | [diff] [blame] | 886 | post-mortem debugger; see :mod:`pdb` module for |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 887 | more information.) |
| 888 | |
| 889 | The meaning of the variables is the same as that of the return values from |
Georg Brandl | 482b151 | 2010-03-21 09:02:59 +0000 | [diff] [blame] | 890 | :func:`exc_info` above. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 891 | |
| 892 | |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 893 | .. data:: maxsize |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 894 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 895 | An integer giving the maximum value a variable of type :c:type:`Py_ssize_t` can |
Georg Brandl | 3377055 | 2007-12-15 09:55:35 +0000 | [diff] [blame] | 896 | take. It's usually ``2**31 - 1`` on a 32-bit platform and ``2**63 - 1`` on a |
| 897 | 64-bit platform. |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 898 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 899 | |
| 900 | .. data:: maxunicode |
| 901 | |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 902 | An integer giving the value of the largest Unicode code point, |
| 903 | i.e. ``1114111`` (``0x10FFFF`` in hexadecimal). |
| 904 | |
| 905 | .. versionchanged:: 3.3 |
Éric Araujo | 525b1e9 | 2011-10-05 01:06:31 +0200 | [diff] [blame] | 906 | Before :pep:`393`, ``sys.maxunicode`` used to be either ``0xFFFF`` |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 907 | or ``0x10FFFF``, depending on the configuration option that specified |
| 908 | whether Unicode characters were stored as UCS-2 or UCS-4. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 909 | |
| 910 | |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 911 | .. data:: meta_path |
| 912 | |
Brett Cannon | ccddbb1 | 2015-12-04 15:46:21 -0800 | [diff] [blame] | 913 | A list of :term:`meta path finder` objects that have their |
| 914 | :meth:`~importlib.abc.MetaPathFinder.find_spec` methods called to see if one |
| 915 | of the objects can find the module to be imported. The |
| 916 | :meth:`~importlib.abc.MetaPathFinder.find_spec` method is called with at |
| 917 | least the absolute name of the module being imported. If the module to be |
| 918 | imported is contained in a package, then the parent package's :attr:`__path__` |
| 919 | attribute is passed in as a second argument. The method returns a |
| 920 | :term:`module spec`, or ``None`` if the module cannot be found. |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 921 | |
Brett Cannon | ccddbb1 | 2015-12-04 15:46:21 -0800 | [diff] [blame] | 922 | .. seealso:: |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 923 | |
Brett Cannon | ccddbb1 | 2015-12-04 15:46:21 -0800 | [diff] [blame] | 924 | :class:`importlib.abc.MetaPathFinder` |
| 925 | The abstract base class defining the interface of finder objects on |
| 926 | :data:`meta_path`. |
| 927 | :class:`importlib.machinery.ModuleSpec` |
| 928 | The concrete class which |
| 929 | :meth:`~importlib.abc.MetaPathFinder.find_spec` should return |
| 930 | instances of. |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 931 | |
Brett Cannon | ccddbb1 | 2015-12-04 15:46:21 -0800 | [diff] [blame] | 932 | .. versionchanged:: 3.4 |
| 933 | |
| 934 | :term:`Module specs <module spec>` were introduced in Python 3.4, by |
| 935 | :pep:`451`. Earlier versions of Python looked for a method called |
| 936 | :meth:`~importlib.abc.MetaPathFinder.find_module`. |
| 937 | This is still called as a fallback if a :data:`meta_path` entry doesn't |
| 938 | have a :meth:`~importlib.abc.MetaPathFinder.find_spec` method. |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 939 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 940 | .. data:: modules |
| 941 | |
| 942 | This is a dictionary that maps module names to modules which have already been |
| 943 | loaded. This can be manipulated to force reloading of modules and other tricks. |
Brett Cannon | c3511c1 | 2013-05-24 08:05:07 -0400 | [diff] [blame] | 944 | However, replacing the dictionary will not necessarily work as expected and |
| 945 | deleting essential items from the dictionary may cause Python to fail. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 946 | |
| 947 | |
| 948 | .. data:: path |
| 949 | |
| 950 | .. index:: triple: module; search; path |
| 951 | |
| 952 | A list of strings that specifies the search path for modules. Initialized from |
| 953 | the environment variable :envvar:`PYTHONPATH`, plus an installation-dependent |
| 954 | default. |
| 955 | |
| 956 | As initialized upon program startup, the first item of this list, ``path[0]``, |
| 957 | is the directory containing the script that was used to invoke the Python |
| 958 | interpreter. If the script directory is not available (e.g. if the interpreter |
| 959 | is invoked interactively or if the script is read from standard input), |
| 960 | ``path[0]`` is the empty string, which directs Python to search modules in the |
| 961 | current directory first. Notice that the script directory is inserted *before* |
| 962 | the entries inserted as a result of :envvar:`PYTHONPATH`. |
| 963 | |
Barry Warsaw | 82c1c78 | 2012-11-20 15:22:51 -0500 | [diff] [blame] | 964 | A program is free to modify this list for its own purposes. Only strings |
| 965 | and bytes should be added to :data:`sys.path`; all other data types are |
| 966 | ignored during import. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 967 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 968 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 969 | .. seealso:: |
| 970 | Module :mod:`site` This describes how to use .pth files to extend |
| 971 | :data:`sys.path`. |
| 972 | |
| 973 | |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 974 | .. data:: path_hooks |
| 975 | |
| 976 | A list of callables that take a path argument to try to create a |
| 977 | :term:`finder` for the path. If a finder can be created, it is to be |
| 978 | returned by the callable, else raise :exc:`ImportError`. |
| 979 | |
| 980 | Originally specified in :pep:`302`. |
| 981 | |
| 982 | |
| 983 | .. data:: path_importer_cache |
| 984 | |
| 985 | A dictionary acting as a cache for :term:`finder` objects. The keys are |
| 986 | paths that have been passed to :data:`sys.path_hooks` and the values are |
| 987 | the finders that are found. If a path is a valid file system path but no |
Brett Cannon | 2514b48 | 2013-03-13 10:46:22 -0700 | [diff] [blame] | 988 | finder is found on :data:`sys.path_hooks` then ``None`` is |
| 989 | stored. |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 990 | |
| 991 | Originally specified in :pep:`302`. |
| 992 | |
Brett Cannon | 2514b48 | 2013-03-13 10:46:22 -0700 | [diff] [blame] | 993 | .. versionchanged:: 3.3 |
| 994 | ``None`` is stored instead of :class:`imp.NullImporter` when no finder |
| 995 | is found. |
| 996 | |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 997 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 998 | .. data:: platform |
| 999 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 1000 | This string contains a platform identifier that can be used to append |
| 1001 | platform-specific components to :data:`sys.path`, for instance. |
| 1002 | |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 1003 | For Unix systems, except on Linux, this is the lowercased OS name as |
| 1004 | returned by ``uname -s`` with the first part of the version as returned by |
| 1005 | ``uname -r`` appended, e.g. ``'sunos5'`` or ``'freebsd8'``, *at the time |
| 1006 | when Python was built*. Unless you want to test for a specific system |
| 1007 | version, it is therefore recommended to use the following idiom:: |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 1008 | |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 1009 | if sys.platform.startswith('freebsd'): |
| 1010 | # FreeBSD-specific code here... |
Georg Brandl | a47e53e | 2011-09-03 09:26:09 +0200 | [diff] [blame] | 1011 | elif sys.platform.startswith('linux'): |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 1012 | # Linux-specific code here... |
| 1013 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 1014 | For other systems, the values are: |
| 1015 | |
| 1016 | ================ =========================== |
Éric Araujo | 3f7c0e4 | 2012-12-08 22:53:43 -0500 | [diff] [blame] | 1017 | System ``platform`` value |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 1018 | ================ =========================== |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 1019 | Linux ``'linux'`` |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 1020 | Windows ``'win32'`` |
| 1021 | Windows/Cygwin ``'cygwin'`` |
Georg Brandl | c575c90 | 2008-09-13 17:46:05 +0000 | [diff] [blame] | 1022 | Mac OS X ``'darwin'`` |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 1023 | ================ =========================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1024 | |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 1025 | .. versionchanged:: 3.3 |
| 1026 | On Linux, :attr:`sys.platform` doesn't contain the major version anymore. |
Georg Brandl | fbd1e04 | 2011-09-04 08:42:26 +0200 | [diff] [blame] | 1027 | It is always ``'linux'``, instead of ``'linux2'`` or ``'linux3'``. Since |
| 1028 | older Python versions include the version number, it is recommended to |
| 1029 | always use the ``startswith`` idiom presented above. |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 1030 | |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 1031 | .. seealso:: |
Georg Brandl | eb25fb7 | 2012-02-23 21:12:39 +0100 | [diff] [blame] | 1032 | |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 1033 | :attr:`os.name` has a coarser granularity. :func:`os.uname` gives |
| 1034 | system-dependent version information. |
| 1035 | |
| 1036 | The :mod:`platform` module provides detailed checks for the |
| 1037 | system's identity. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1038 | |
Georg Brandl | fbd1e04 | 2011-09-04 08:42:26 +0200 | [diff] [blame] | 1039 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1040 | .. data:: prefix |
| 1041 | |
| 1042 | A string giving the site-specific directory prefix where the platform |
| 1043 | independent Python files are installed; by default, this is the string |
Éric Araujo | 713d303 | 2010-11-18 16:38:46 +0000 | [diff] [blame] | 1044 | ``'/usr/local'``. This can be set at build time with the ``--prefix`` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1045 | argument to the :program:`configure` script. The main collection of Python |
Georg Brandl | a673eb8 | 2012-03-04 16:17:05 +0100 | [diff] [blame] | 1046 | library modules is installed in the directory :file:`{prefix}/lib/python{X.Y}` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1047 | while the platform independent header files (all except :file:`pyconfig.h`) are |
Georg Brandl | eb25fb7 | 2012-02-23 21:12:39 +0100 | [diff] [blame] | 1048 | stored in :file:`{prefix}/include/python{X.Y}`, where *X.Y* is the version |
Éric Araujo | 58a9153 | 2011-10-05 01:28:24 +0200 | [diff] [blame] | 1049 | number of Python, for example ``3.2``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1050 | |
Vinay Sajip | cd9b746 | 2012-07-09 10:37:01 +0100 | [diff] [blame] | 1051 | .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this |
| 1052 | value will be changed in ``site.py`` to point to the virtual |
| 1053 | environment. The value for the Python installation will still be |
| 1054 | available, via :data:`base_prefix`. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 1055 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1056 | |
| 1057 | .. data:: ps1 |
| 1058 | ps2 |
| 1059 | |
| 1060 | .. index:: |
| 1061 | single: interpreter prompts |
| 1062 | single: prompts, interpreter |
| 1063 | |
| 1064 | Strings specifying the primary and secondary prompt of the interpreter. These |
| 1065 | are only defined if the interpreter is in interactive mode. Their initial |
| 1066 | values in this case are ``'>>> '`` and ``'... '``. If a non-string object is |
| 1067 | assigned to either variable, its :func:`str` is re-evaluated each time the |
| 1068 | interpreter prepares to read a new interactive command; this can be used to |
| 1069 | implement a dynamic prompt. |
| 1070 | |
| 1071 | |
| 1072 | .. function:: setcheckinterval(interval) |
| 1073 | |
| 1074 | Set the interpreter's "check interval". This integer value determines how often |
| 1075 | the interpreter checks for periodic things such as thread switches and signal |
| 1076 | handlers. The default is ``100``, meaning the check is performed every 100 |
| 1077 | Python virtual instructions. Setting it to a larger value may increase |
| 1078 | performance for programs using threads. Setting it to a value ``<=`` 0 checks |
| 1079 | every virtual instruction, maximizing responsiveness as well as overhead. |
| 1080 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1081 | .. deprecated:: 3.2 |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 1082 | This function doesn't have an effect anymore, as the internal logic for |
| 1083 | thread switching and asynchronous tasks has been rewritten. Use |
| 1084 | :func:`setswitchinterval` instead. |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1085 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1086 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1087 | .. function:: setdlopenflags(n) |
| 1088 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1089 | Set the flags used by the interpreter for :c:func:`dlopen` calls, such as when |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1090 | the interpreter loads extension modules. Among other things, this will enable a |
| 1091 | lazy resolving of symbols when importing a module, if called as |
| 1092 | ``sys.setdlopenflags(0)``. To share symbols across extension modules, call as |
Andrew Kuchling | c61b913 | 2013-06-21 10:58:41 -0400 | [diff] [blame] | 1093 | ``sys.setdlopenflags(os.RTLD_GLOBAL)``. Symbolic names for the flag values |
Victor Stinner | 8b905bd | 2011-10-25 13:34:04 +0200 | [diff] [blame] | 1094 | can be found in the :mod:`os` module (``RTLD_xxx`` constants, e.g. |
| 1095 | :data:`os.RTLD_LAZY`). |
| 1096 | |
| 1097 | Availability: Unix. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1098 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1099 | .. function:: setprofile(profilefunc) |
| 1100 | |
| 1101 | .. index:: |
| 1102 | single: profile function |
| 1103 | single: profiler |
| 1104 | |
| 1105 | Set the system's profile function, which allows you to implement a Python source |
| 1106 | code profiler in Python. See chapter :ref:`profile` for more information on the |
| 1107 | Python profiler. The system's profile function is called similarly to the |
Pablo Galindo | 131fd7f | 2018-01-24 12:57:49 +0000 | [diff] [blame] | 1108 | system's trace function (see :func:`settrace`), but it is called with different events, |
| 1109 | for example it isn't called for each executed line of code (only on call and return, |
| 1110 | but the return event is reported even when an exception has been set). The function is |
| 1111 | thread-specific, but there is no way for the profiler to know about context switches between |
| 1112 | threads, so it does not make sense to use this in the presence of multiple threads. Also, |
Xiang Zhang | 60da99b | 2018-01-27 23:04:47 +0800 | [diff] [blame] | 1113 | its return value is not used, so it can simply return ``None``. Error in the profile |
| 1114 | function will cause itself unset. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1115 | |
Pablo Galindo | 131fd7f | 2018-01-24 12:57:49 +0000 | [diff] [blame] | 1116 | Profile functions should have three arguments: *frame*, *event*, and |
| 1117 | *arg*. *frame* is the current stack frame. *event* is a string: ``'call'``, |
| 1118 | ``'return'``, ``'c_call'``, ``'c_return'``, or ``'c_exception'``. *arg* depends |
| 1119 | on the event type. |
| 1120 | |
| 1121 | The events have the following meaning: |
| 1122 | |
| 1123 | ``'call'`` |
| 1124 | A function is called (or some other code block entered). The |
| 1125 | profile function is called; *arg* is ``None``. |
| 1126 | |
| 1127 | ``'return'`` |
| 1128 | A function (or other code block) is about to return. The profile |
| 1129 | function is called; *arg* is the value that will be returned, or ``None`` |
| 1130 | if the event is caused by an exception being raised. |
| 1131 | |
| 1132 | ``'c_call'`` |
| 1133 | A C function is about to be called. This may be an extension function or |
| 1134 | a built-in. *arg* is the C function object. |
| 1135 | |
| 1136 | ``'c_return'`` |
| 1137 | A C function has returned. *arg* is the C function object. |
| 1138 | |
| 1139 | ``'c_exception'`` |
| 1140 | A C function has raised an exception. *arg* is the C function object. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1141 | |
| 1142 | .. function:: setrecursionlimit(limit) |
| 1143 | |
| 1144 | Set the maximum depth of the Python interpreter stack to *limit*. This limit |
| 1145 | prevents infinite recursion from causing an overflow of the C stack and crashing |
| 1146 | Python. |
| 1147 | |
| 1148 | The highest possible limit is platform-dependent. A user may need to set the |
Georg Brandl | 5166375 | 2011-05-13 06:55:28 +0200 | [diff] [blame] | 1149 | limit higher when they have a program that requires deep recursion and a platform |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1150 | that supports a higher limit. This should be done with care, because a too-high |
| 1151 | limit can lead to a crash. |
| 1152 | |
Victor Stinner | 50856d5 | 2015-10-13 00:11:21 +0200 | [diff] [blame] | 1153 | If the new limit is too low at the current recursion depth, a |
| 1154 | :exc:`RecursionError` exception is raised. |
| 1155 | |
| 1156 | .. versionchanged:: 3.5.1 |
| 1157 | A :exc:`RecursionError` exception is now raised if the new limit is too |
| 1158 | low at the current recursion depth. |
| 1159 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1160 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1161 | .. function:: setswitchinterval(interval) |
| 1162 | |
| 1163 | Set the interpreter's thread switch interval (in seconds). This floating-point |
| 1164 | value determines the ideal duration of the "timeslices" allocated to |
| 1165 | concurrently running Python threads. Please note that the actual value |
| 1166 | can be higher, especially if long-running internal functions or methods |
| 1167 | are used. Also, which thread becomes scheduled at the end of the interval |
| 1168 | is the operating system's decision. The interpreter doesn't have its |
| 1169 | own scheduler. |
| 1170 | |
Antoine Pitrou | 79707ca | 2009-11-11 22:03:32 +0000 | [diff] [blame] | 1171 | .. versionadded:: 3.2 |
| 1172 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 1173 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1174 | .. function:: settrace(tracefunc) |
| 1175 | |
| 1176 | .. index:: |
| 1177 | single: trace function |
| 1178 | single: debugger |
| 1179 | |
| 1180 | Set the system's trace function, which allows you to implement a Python |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1181 | source code debugger in Python. The function is thread-specific; for a |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1182 | debugger to support multiple threads, it must be registered using |
| 1183 | :func:`settrace` for each thread being debugged. |
| 1184 | |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1185 | Trace functions should have three arguments: *frame*, *event*, and |
| 1186 | *arg*. *frame* is the current stack frame. *event* is a string: ``'call'``, |
Pablo Galindo | 131fd7f | 2018-01-24 12:57:49 +0000 | [diff] [blame] | 1187 | ``'line'``, ``'return'``, ``'exception'`` or ``'opcode'``. *arg* depends on |
| 1188 | the event type. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1189 | |
| 1190 | The trace function is invoked (with *event* set to ``'call'``) whenever a new |
| 1191 | local scope is entered; it should return a reference to a local trace |
| 1192 | function to be used that scope, or ``None`` if the scope shouldn't be traced. |
| 1193 | |
| 1194 | The local trace function should return a reference to itself (or to another |
| 1195 | function for further tracing in that scope), or ``None`` to turn off tracing |
| 1196 | in that scope. |
| 1197 | |
Xiang Zhang | 60da99b | 2018-01-27 23:04:47 +0800 | [diff] [blame] | 1198 | If there is any error occurred in the trace function, it will be unset, just |
| 1199 | like ``settrace(None)`` is called. |
| 1200 | |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1201 | The events have the following meaning: |
| 1202 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 1203 | ``'call'`` |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1204 | A function is called (or some other code block entered). The |
| 1205 | global trace function is called; *arg* is ``None``; the return value |
| 1206 | specifies the local trace function. |
| 1207 | |
| 1208 | ``'line'`` |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 1209 | The interpreter is about to execute a new line of code or re-execute the |
| 1210 | condition of a loop. The local trace function is called; *arg* is |
| 1211 | ``None``; the return value specifies the new local trace function. See |
| 1212 | :file:`Objects/lnotab_notes.txt` for a detailed explanation of how this |
| 1213 | works. |
Nick Coghlan | 5a85167 | 2017-09-08 10:14:16 +1000 | [diff] [blame] | 1214 | Per-line events may be disabled for a frame by setting |
| 1215 | :attr:`f_trace_lines` to :const:`False` on that frame. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1216 | |
| 1217 | ``'return'`` |
| 1218 | A function (or other code block) is about to return. The local trace |
Georg Brandl | d0b0e1d | 2010-10-15 16:42:37 +0000 | [diff] [blame] | 1219 | function is called; *arg* is the value that will be returned, or ``None`` |
| 1220 | if the event is caused by an exception being raised. The trace function's |
| 1221 | return value is ignored. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1222 | |
| 1223 | ``'exception'`` |
| 1224 | An exception has occurred. The local trace function is called; *arg* is a |
| 1225 | tuple ``(exception, value, traceback)``; the return value specifies the |
| 1226 | new local trace function. |
| 1227 | |
Nick Coghlan | 5a85167 | 2017-09-08 10:14:16 +1000 | [diff] [blame] | 1228 | ``'opcode'`` |
| 1229 | The interpreter is about to execute a new opcode (see :mod:`dis` for |
| 1230 | opcode details). The local trace function is called; *arg* is |
| 1231 | ``None``; the return value specifies the new local trace function. |
| 1232 | Per-opcode events are not emitted by default: they must be explicitly |
| 1233 | requested by setting :attr:`f_trace_opcodes` to :const:`True` on the |
| 1234 | frame. |
| 1235 | |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 1236 | Note that as an exception is propagated down the chain of callers, an |
| 1237 | ``'exception'`` event is generated at each level. |
| 1238 | |
| 1239 | For more information on code and frame objects, refer to :ref:`types`. |
| 1240 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 1241 | .. impl-detail:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1242 | |
| 1243 | The :func:`settrace` function is intended only for implementing debuggers, |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 1244 | profilers, coverage tools and the like. Its behavior is part of the |
| 1245 | implementation platform, rather than part of the language definition, and |
| 1246 | thus may not be available in all Python implementations. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1247 | |
Nick Coghlan | 5a85167 | 2017-09-08 10:14:16 +1000 | [diff] [blame] | 1248 | .. versionchanged:: 3.7 |
| 1249 | |
| 1250 | ``'opcode'`` event type added; :attr:`f_trace_lines` and |
| 1251 | :attr:`f_trace_opcodes` attributes added to frames |
| 1252 | |
Yury Selivanov | 0366004 | 2016-12-15 17:36:05 -0500 | [diff] [blame] | 1253 | .. function:: set_asyncgen_hooks(firstiter, finalizer) |
| 1254 | |
| 1255 | Accepts two optional keyword arguments which are callables that accept an |
| 1256 | :term:`asynchronous generator iterator` as an argument. The *firstiter* |
| 1257 | callable will be called when an asynchronous generator is iterated for the |
| 1258 | first time. The *finalizer* will be called when an asynchronous generator |
| 1259 | is about to be garbage collected. |
| 1260 | |
| 1261 | .. versionadded:: 3.6 |
| 1262 | See :pep:`525` for more details, and for a reference example of a |
| 1263 | *finalizer* method see the implementation of |
| 1264 | ``asyncio.Loop.shutdown_asyncgens`` in |
| 1265 | :source:`Lib/asyncio/base_events.py` |
| 1266 | |
| 1267 | .. note:: |
| 1268 | This function has been added on a provisional basis (see :pep:`411` |
| 1269 | for details.) |
| 1270 | |
Nathaniel J. Smith | fc2f407 | 2018-01-21 06:44:07 -0800 | [diff] [blame] | 1271 | .. function:: set_coroutine_origin_tracking_depth(depth) |
| 1272 | |
| 1273 | Allows enabling or disabling coroutine origin tracking. When |
| 1274 | enabled, the ``cr_origin`` attribute on coroutine objects will |
| 1275 | contain a tuple of (filename, line number, function name) tuples |
| 1276 | describing the traceback where the coroutine object was created, |
| 1277 | with the most recent call first. When disabled, ``cr_origin`` will |
| 1278 | be None. |
| 1279 | |
| 1280 | To enable, pass a *depth* value greater than zero; this sets the |
| 1281 | number of frames whose information will be captured. To disable, |
| 1282 | pass set *depth* to zero. |
| 1283 | |
| 1284 | This setting is thread-specific. |
| 1285 | |
| 1286 | .. versionadded:: 3.7 |
| 1287 | |
| 1288 | .. note:: |
| 1289 | This function has been added on a provisional basis (see :pep:`411` |
| 1290 | for details.) Use it only for debugging purposes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1291 | |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 1292 | .. function:: set_coroutine_wrapper(wrapper) |
| 1293 | |
Yury Selivanov | 5376ba9 | 2015-06-22 12:19:30 -0400 | [diff] [blame] | 1294 | Allows intercepting creation of :term:`coroutine` objects (only ones that |
| 1295 | are created by an :keyword:`async def` function; generators decorated with |
| 1296 | :func:`types.coroutine` or :func:`asyncio.coroutine` will not be |
| 1297 | intercepted). |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 1298 | |
Yury Selivanov | 66f8828 | 2015-06-24 11:04:15 -0400 | [diff] [blame] | 1299 | The *wrapper* argument must be either: |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 1300 | |
| 1301 | * a callable that accepts one argument (a coroutine object); |
| 1302 | * ``None``, to reset the wrapper. |
| 1303 | |
| 1304 | If called twice, the new wrapper replaces the previous one. The function |
| 1305 | is thread-specific. |
| 1306 | |
Yury Selivanov | aab3c4a | 2015-06-02 18:43:51 -0400 | [diff] [blame] | 1307 | The *wrapper* callable cannot define new coroutines directly or indirectly:: |
| 1308 | |
| 1309 | def wrapper(coro): |
| 1310 | async def wrap(coro): |
| 1311 | return await coro |
| 1312 | return wrap(coro) |
| 1313 | sys.set_coroutine_wrapper(wrapper) |
| 1314 | |
Yury Selivanov | 66f8828 | 2015-06-24 11:04:15 -0400 | [diff] [blame] | 1315 | async def foo(): |
| 1316 | pass |
Yury Selivanov | aab3c4a | 2015-06-02 18:43:51 -0400 | [diff] [blame] | 1317 | |
| 1318 | # The following line will fail with a RuntimeError, because |
Zachary Ware | 3d3aedc | 2015-07-07 00:07:25 -0500 | [diff] [blame] | 1319 | # ``wrapper`` creates a ``wrap(coro)`` coroutine: |
Yury Selivanov | aab3c4a | 2015-06-02 18:43:51 -0400 | [diff] [blame] | 1320 | foo() |
| 1321 | |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 1322 | See also :func:`get_coroutine_wrapper`. |
| 1323 | |
| 1324 | .. versionadded:: 3.5 |
| 1325 | See :pep:`492` for more details. |
| 1326 | |
| 1327 | .. note:: |
| 1328 | This function has been added on a provisional basis (see :pep:`411` |
Yury Selivanov | 4180e43 | 2015-06-04 11:10:24 -0400 | [diff] [blame] | 1329 | for details.) Use it only for debugging purposes. |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 1330 | |
Nathaniel J. Smith | fc2f407 | 2018-01-21 06:44:07 -0800 | [diff] [blame] | 1331 | .. deprecated:: 3.7 |
| 1332 | The coroutine wrapper functionality has been deprecated, and |
| 1333 | will be removed in 3.8. See :issue:`32591` for details. |
| 1334 | |
Steve Dower | cc16be8 | 2016-09-08 10:35:16 -0700 | [diff] [blame] | 1335 | .. function:: _enablelegacywindowsfsencoding() |
| 1336 | |
| 1337 | Changes the default filesystem encoding and errors mode to 'mbcs' and |
| 1338 | 'replace' respectively, for consistency with versions of Python prior to 3.6. |
| 1339 | |
| 1340 | This is equivalent to defining the :envvar:`PYTHONLEGACYWINDOWSFSENCODING` |
| 1341 | environment variable before launching Python. |
| 1342 | |
| 1343 | Availability: Windows |
| 1344 | |
| 1345 | .. versionadded:: 3.6 |
| 1346 | See :pep:`529` for more details. |
Yury Selivanov | d4cbbeb | 2015-05-31 17:13:08 -0400 | [diff] [blame] | 1347 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1348 | .. data:: stdin |
| 1349 | stdout |
| 1350 | stderr |
| 1351 | |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1352 | :term:`File objects <file object>` used by the interpreter for standard |
| 1353 | input, output and errors: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1354 | |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1355 | * ``stdin`` is used for all interactive input (including calls to |
| 1356 | :func:`input`); |
| 1357 | * ``stdout`` is used for the output of :func:`print` and :term:`expression` |
| 1358 | statements and for the prompts of :func:`input`; |
| 1359 | * The interpreter's own prompts and its error messages go to ``stderr``. |
| 1360 | |
Antoine Pitrou | 2d1ec06 | 2014-05-15 22:38:56 +0200 | [diff] [blame] | 1361 | These streams are regular :term:`text files <text file>` like those |
| 1362 | returned by the :func:`open` function. Their parameters are chosen as |
| 1363 | follows: |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1364 | |
| 1365 | * The character encoding is platform-dependent. Under Windows, if the stream |
Serhiy Storchaka | fbc1c26 | 2013-11-29 12:17:13 +0200 | [diff] [blame] | 1366 | is interactive (that is, if its :meth:`isatty` method returns ``True``), the |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1367 | console codepage is used, otherwise the ANSI code page. Under other |
| 1368 | platforms, the locale encoding is used (see :meth:`locale.getpreferredencoding`). |
| 1369 | |
| 1370 | Under all platforms though, you can override this value by setting the |
Antoine Pitrou | 2d1ec06 | 2014-05-15 22:38:56 +0200 | [diff] [blame] | 1371 | :envvar:`PYTHONIOENCODING` environment variable before starting Python. |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1372 | |
Berker Peksag | 7f58097 | 2017-10-13 15:16:31 +0300 | [diff] [blame] | 1373 | * When interactive, ``stdout`` and ``stderr`` streams are line-buffered. |
| 1374 | Otherwise, they are block-buffered like regular text files. You can |
| 1375 | override this value with the :option:`-u` command-line option. |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1376 | |
Antoine Pitrou | 2d1ec06 | 2014-05-15 22:38:56 +0200 | [diff] [blame] | 1377 | .. note:: |
Benjamin Peterson | 4199d60 | 2009-05-12 20:47:57 +0000 | [diff] [blame] | 1378 | |
Antoine Pitrou | 2d1ec06 | 2014-05-15 22:38:56 +0200 | [diff] [blame] | 1379 | To write or read binary data from/to the standard streams, use the |
| 1380 | underlying binary :data:`~io.TextIOBase.buffer` object. For example, to |
| 1381 | write bytes to :data:`stdout`, use ``sys.stdout.buffer.write(b'abc')``. |
Benjamin Peterson | 995bb47 | 2009-06-14 18:41:18 +0000 | [diff] [blame] | 1382 | |
Antoine Pitrou | 2d1ec06 | 2014-05-15 22:38:56 +0200 | [diff] [blame] | 1383 | However, if you are writing a library (and do not control in which |
| 1384 | context its code will be executed), be aware that the standard streams |
| 1385 | may be replaced with file-like objects like :class:`io.StringIO` which |
| 1386 | do not support the :attr:`~io.BufferedIOBase.buffer` attribute. |
Benjamin Peterson | eb9fc52 | 2008-12-07 14:58:03 +0000 | [diff] [blame] | 1387 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1388 | |
| 1389 | .. data:: __stdin__ |
| 1390 | __stdout__ |
| 1391 | __stderr__ |
| 1392 | |
| 1393 | These objects contain the original values of ``stdin``, ``stderr`` and |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1394 | ``stdout`` at the start of the program. They are used during finalization, |
| 1395 | and could be useful to print to the actual standard stream no matter if the |
| 1396 | ``sys.std*`` object has been redirected. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1397 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1398 | It can also be used to restore the actual files to known working file objects |
| 1399 | in case they have been overwritten with a broken object. However, the |
| 1400 | preferred way to do this is to explicitly save the previous stream before |
| 1401 | replacing it, and restore the saved object. |
Christian Heimes | 58cb1b8 | 2007-11-13 02:19:40 +0000 | [diff] [blame] | 1402 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1403 | .. note:: |
| 1404 | Under some conditions ``stdin``, ``stdout`` and ``stderr`` as well as the |
| 1405 | original values ``__stdin__``, ``__stdout__`` and ``__stderr__`` can be |
Serhiy Storchaka | ecf41da | 2016-10-19 16:29:26 +0300 | [diff] [blame] | 1406 | ``None``. It is usually the case for Windows GUI apps that aren't connected |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1407 | to a console and Python apps started with :program:`pythonw`. |
Christian Heimes | 58cb1b8 | 2007-11-13 02:19:40 +0000 | [diff] [blame] | 1408 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1409 | |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 1410 | .. data:: thread_info |
| 1411 | |
| 1412 | A :term:`struct sequence` holding information about the thread |
| 1413 | implementation. |
| 1414 | |
Georg Brandl | 44ea77b | 2013-03-28 13:28:44 +0100 | [diff] [blame] | 1415 | .. tabularcolumns:: |l|p{0.7\linewidth}| |
| 1416 | |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 1417 | +------------------+---------------------------------------------------------+ |
| 1418 | | Attribute | Explanation | |
| 1419 | +==================+=========================================================+ |
| 1420 | | :const:`name` | Name of the thread implementation: | |
| 1421 | | | | |
| 1422 | | | * ``'nt'``: Windows threads | |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 1423 | | | * ``'pthread'``: POSIX threads | |
| 1424 | | | * ``'solaris'``: Solaris threads | |
| 1425 | +------------------+---------------------------------------------------------+ |
| 1426 | | :const:`lock` | Name of the lock implementation: | |
| 1427 | | | | |
| 1428 | | | * ``'semaphore'``: a lock uses a semaphore | |
| 1429 | | | * ``'mutex+cond'``: a lock uses a mutex | |
| 1430 | | | and a condition variable | |
| 1431 | | | * ``None`` if this information is unknown | |
| 1432 | +------------------+---------------------------------------------------------+ |
| 1433 | | :const:`version` | Name and version of the thread library. It is a string, | |
luzpaz | a5293b4 | 2017-11-05 07:37:50 -0600 | [diff] [blame] | 1434 | | | or ``None`` if this information is unknown. | |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 1435 | +------------------+---------------------------------------------------------+ |
| 1436 | |
| 1437 | .. versionadded:: 3.3 |
| 1438 | |
| 1439 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1440 | .. data:: tracebacklimit |
| 1441 | |
| 1442 | When this variable is set to an integer value, it determines the maximum number |
| 1443 | of levels of traceback information printed when an unhandled exception occurs. |
| 1444 | The default is ``1000``. When set to ``0`` or less, all traceback information |
| 1445 | is suppressed and only the exception type and value are printed. |
| 1446 | |
| 1447 | |
| 1448 | .. data:: version |
| 1449 | |
| 1450 | A string containing the version number of the Python interpreter plus additional |
Georg Brandl | e42a59d | 2010-07-31 20:05:31 +0000 | [diff] [blame] | 1451 | information on the build number and compiler used. This string is displayed |
| 1452 | when the interactive interpreter is started. Do not extract version information |
| 1453 | out of it, rather, use :data:`version_info` and the functions provided by the |
| 1454 | :mod:`platform` module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1455 | |
| 1456 | |
| 1457 | .. data:: api_version |
| 1458 | |
| 1459 | The C API version for this interpreter. Programmers may find this useful when |
| 1460 | debugging version conflicts between Python and extension modules. |
| 1461 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1462 | |
| 1463 | .. data:: version_info |
| 1464 | |
| 1465 | A tuple containing the five components of the version number: *major*, *minor*, |
| 1466 | *micro*, *releaselevel*, and *serial*. All values except *releaselevel* are |
| 1467 | integers; the release level is ``'alpha'``, ``'beta'``, ``'candidate'``, or |
| 1468 | ``'final'``. The ``version_info`` value corresponding to the Python version 2.0 |
Eric Smith | 0e5b562 | 2009-02-06 01:32:42 +0000 | [diff] [blame] | 1469 | is ``(2, 0, 0, 'final', 0)``. The components can also be accessed by name, |
| 1470 | so ``sys.version_info[0]`` is equivalent to ``sys.version_info.major`` |
| 1471 | and so on. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1472 | |
Raymond Hettinger | 35a8836 | 2009-04-09 00:08:24 +0000 | [diff] [blame] | 1473 | .. versionchanged:: 3.1 |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 1474 | Added named component attributes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1475 | |
| 1476 | .. data:: warnoptions |
| 1477 | |
| 1478 | This is an implementation detail of the warnings framework; do not modify this |
| 1479 | value. Refer to the :mod:`warnings` module for more information on the warnings |
| 1480 | framework. |
| 1481 | |
| 1482 | |
| 1483 | .. data:: winver |
| 1484 | |
| 1485 | The version number used to form registry keys on Windows platforms. This is |
| 1486 | stored as string resource 1000 in the Python DLL. The value is normally the |
| 1487 | first three characters of :const:`version`. It is provided in the :mod:`sys` |
| 1488 | module for informational purposes; modifying this value has no effect on the |
| 1489 | registry keys used by Python. Availability: Windows. |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 1490 | |
Antoine Pitrou | 9583cac | 2010-10-21 13:42:28 +0000 | [diff] [blame] | 1491 | |
| 1492 | .. data:: _xoptions |
| 1493 | |
| 1494 | A dictionary of the various implementation-specific flags passed through |
| 1495 | the :option:`-X` command-line option. Option names are either mapped to |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1496 | their values, if given explicitly, or to :const:`True`. Example: |
| 1497 | |
| 1498 | .. code-block:: shell-session |
Antoine Pitrou | 9583cac | 2010-10-21 13:42:28 +0000 | [diff] [blame] | 1499 | |
| 1500 | $ ./python -Xa=b -Xc |
| 1501 | Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50) |
| 1502 | [GCC 4.4.3] on linux2 |
| 1503 | Type "help", "copyright", "credits" or "license" for more information. |
| 1504 | >>> import sys |
| 1505 | >>> sys._xoptions |
| 1506 | {'a': 'b', 'c': True} |
| 1507 | |
| 1508 | .. impl-detail:: |
| 1509 | |
| 1510 | This is a CPython-specific way of accessing options passed through |
| 1511 | :option:`-X`. Other implementations may export them through other |
| 1512 | means, or not at all. |
| 1513 | |
| 1514 | .. versionadded:: 3.2 |
| 1515 | |
| 1516 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 1517 | .. rubric:: Citations |
| 1518 | |
Serhiy Storchaka | a4d170d | 2013-12-23 18:20:51 +0200 | [diff] [blame] | 1519 | .. [C99] ISO/IEC 9899:1999. "Programming languages -- C." A public draft of this standard is available at http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf\ . |