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 | |
| 7 | |
| 8 | This module provides access to some variables used or maintained by the |
| 9 | interpreter and to functions that interact strongly with the interpreter. It is |
| 10 | always available. |
| 11 | |
| 12 | |
Barry Warsaw | a40453d | 2010-10-16 14:17:50 +0000 | [diff] [blame] | 13 | .. data:: abiflags |
| 14 | |
| 15 | On POSIX systems where Python is build with the standard ``configure`` |
| 16 | script, this contains the ABI flags as specified by :pep:`3149`. |
| 17 | |
| 18 | .. versionadded:: 3.2 |
| 19 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 20 | .. data:: argv |
| 21 | |
| 22 | The list of command line arguments passed to a Python script. ``argv[0]`` is the |
| 23 | script name (it is operating system dependent whether this is a full pathname or |
| 24 | not). If the command was executed using the :option:`-c` command line option to |
| 25 | the interpreter, ``argv[0]`` is set to the string ``'-c'``. If no script name |
| 26 | was passed to the Python interpreter, ``argv[0]`` is the empty string. |
| 27 | |
| 28 | To loop over the standard input, or the list of files given on the |
| 29 | command line, see the :mod:`fileinput` module. |
| 30 | |
| 31 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 32 | .. data:: base_exec_prefix |
| 33 | |
| 34 | 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] | 35 | :data:`exec_prefix`. If not running in a |
| 36 | :ref:`virtual environment <venv-def>`, the values will stay the same; if |
| 37 | ``site.py`` finds that a virtual environment is in use, the values of |
| 38 | :data:`prefix` and :data:`exec_prefix` will be changed to point to the |
| 39 | virtual environment, whereas :data:`base_prefix` and |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 40 | :data:`base_exec_prefix` will remain pointing to the base Python |
| 41 | installation (the one which the virtual environment was created from). |
| 42 | |
Georg Brandl | 039b01d | 2012-05-26 09:11:22 +0200 | [diff] [blame] | 43 | .. versionadded:: 3.3 |
| 44 | |
| 45 | |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 46 | .. data:: base_prefix |
| 47 | |
| 48 | 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] | 49 | :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] | 50 | will stay the same; if ``site.py`` finds that a virtual environment is in |
| 51 | use, the values of :data:`prefix` and :data:`exec_prefix` will be changed to |
| 52 | point to the virtual environment, whereas :data:`base_prefix` and |
| 53 | :data:`base_exec_prefix` will remain pointing to the base Python |
| 54 | installation (the one which the virtual environment was created from). |
| 55 | |
Georg Brandl | 039b01d | 2012-05-26 09:11:22 +0200 | [diff] [blame] | 56 | .. versionadded:: 3.3 |
| 57 | |
| 58 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 59 | .. data:: byteorder |
| 60 | |
| 61 | An indicator of the native byte order. This will have the value ``'big'`` on |
| 62 | big-endian (most-significant byte first) platforms, and ``'little'`` on |
| 63 | little-endian (least-significant byte first) platforms. |
| 64 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 65 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 66 | .. data:: builtin_module_names |
| 67 | |
| 68 | A tuple of strings giving the names of all modules that are compiled into this |
| 69 | Python interpreter. (This information is not available in any other way --- |
| 70 | ``modules.keys()`` only lists the imported modules.) |
| 71 | |
| 72 | |
Georg Brandl | 8527126 | 2010-10-17 11:06:14 +0000 | [diff] [blame] | 73 | .. function:: call_tracing(func, args) |
| 74 | |
| 75 | Call ``func(*args)``, while tracing is enabled. The tracing state is saved, |
| 76 | and restored afterwards. This is intended to be called from a debugger from |
| 77 | a checkpoint, to recursively debug some other code. |
| 78 | |
| 79 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 80 | .. data:: copyright |
| 81 | |
| 82 | A string containing the copyright pertaining to the Python interpreter. |
| 83 | |
| 84 | |
Christian Heimes | 15ebc88 | 2008-02-04 18:48:49 +0000 | [diff] [blame] | 85 | .. function:: _clear_type_cache() |
| 86 | |
| 87 | Clear the internal type cache. The type cache is used to speed up attribute |
| 88 | and method lookups. Use the function *only* to drop unnecessary references |
| 89 | during reference leak debugging. |
| 90 | |
| 91 | This function should be used for internal and specialized purposes only. |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 92 | |
Christian Heimes | 2685563 | 2008-01-27 23:50:43 +0000 | [diff] [blame] | 93 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 94 | .. function:: _current_frames() |
| 95 | |
| 96 | Return a dictionary mapping each thread's identifier to the topmost stack frame |
| 97 | currently active in that thread at the time the function is called. Note that |
| 98 | functions in the :mod:`traceback` module can build the call stack given such a |
| 99 | frame. |
| 100 | |
| 101 | This is most useful for debugging deadlock: this function does not require the |
| 102 | deadlocked threads' cooperation, and such threads' call stacks are frozen for as |
| 103 | long as they remain deadlocked. The frame returned for a non-deadlocked thread |
| 104 | may bear no relationship to that thread's current activity by the time calling |
| 105 | code examines the frame. |
| 106 | |
| 107 | This function should be used for internal and specialized purposes only. |
| 108 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 109 | |
David Malcolm | 49526f4 | 2012-06-22 14:55:41 -0400 | [diff] [blame] | 110 | .. function:: _debugmallocstats() |
| 111 | |
| 112 | Print low-level information to stderr about the state of CPython's memory |
| 113 | allocator. |
| 114 | |
| 115 | If Python is configured --with-pydebug, it also performs some expensive |
| 116 | internal consistency checks. |
| 117 | |
| 118 | .. versionadded:: 3.3 |
| 119 | |
| 120 | .. impl-detail:: |
| 121 | |
| 122 | This function is specific to CPython. The exact output format is not |
| 123 | defined here, and may change. |
| 124 | |
| 125 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 126 | .. data:: dllhandle |
| 127 | |
| 128 | Integer specifying the handle of the Python DLL. Availability: Windows. |
| 129 | |
| 130 | |
| 131 | .. function:: displayhook(value) |
| 132 | |
Victor Stinner | 13d49ee | 2010-12-04 17:24:33 +0000 | [diff] [blame] | 133 | If *value* is not ``None``, this function prints ``repr(value)`` to |
| 134 | ``sys.stdout``, and saves *value* in ``builtins._``. If ``repr(value)`` is |
| 135 | not encodable to ``sys.stdout.encoding`` with ``sys.stdout.errors`` error |
| 136 | handler (which is probably ``'strict'``), encode it to |
| 137 | ``sys.stdout.encoding`` with ``'backslashreplace'`` error handler. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 138 | |
Christian Heimes | d8654cf | 2007-12-02 15:22:16 +0000 | [diff] [blame] | 139 | ``sys.displayhook`` is called on the result of evaluating an :term:`expression` |
| 140 | entered in an interactive Python session. The display of these values can be |
| 141 | customized by assigning another one-argument function to ``sys.displayhook``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 142 | |
Victor Stinner | 13d49ee | 2010-12-04 17:24:33 +0000 | [diff] [blame] | 143 | Pseudo-code:: |
| 144 | |
| 145 | def displayhook(value): |
| 146 | if value is None: |
| 147 | return |
| 148 | # Set '_' to None to avoid recursion |
| 149 | builtins._ = None |
| 150 | text = repr(value) |
| 151 | try: |
| 152 | sys.stdout.write(text) |
| 153 | except UnicodeEncodeError: |
| 154 | bytes = text.encode(sys.stdout.encoding, 'backslashreplace') |
| 155 | if hasattr(sys.stdout, 'buffer'): |
| 156 | sys.stdout.buffer.write(bytes) |
| 157 | else: |
| 158 | text = bytes.decode(sys.stdout.encoding, 'strict') |
| 159 | sys.stdout.write(text) |
| 160 | sys.stdout.write("\n") |
| 161 | builtins._ = value |
| 162 | |
| 163 | .. versionchanged:: 3.2 |
| 164 | Use ``'backslashreplace'`` error handler on :exc:`UnicodeEncodeError`. |
| 165 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 166 | |
Éric Araujo | da27263 | 2011-10-05 01:17:38 +0200 | [diff] [blame] | 167 | .. data:: dont_write_bytecode |
| 168 | |
| 169 | If this is true, Python won't try to write ``.pyc`` or ``.pyo`` files on the |
| 170 | import of source modules. This value is initially set to ``True`` or |
| 171 | ``False`` depending on the :option:`-B` command line option and the |
| 172 | :envvar:`PYTHONDONTWRITEBYTECODE` environment variable, but you can set it |
| 173 | yourself to control bytecode file generation. |
| 174 | |
| 175 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 176 | .. function:: excepthook(type, value, traceback) |
| 177 | |
| 178 | This function prints out a given traceback and exception to ``sys.stderr``. |
| 179 | |
| 180 | When an exception is raised and uncaught, the interpreter calls |
| 181 | ``sys.excepthook`` with three arguments, the exception class, exception |
| 182 | instance, and a traceback object. In an interactive session this happens just |
| 183 | before control is returned to the prompt; in a Python program this happens just |
| 184 | before the program exits. The handling of such top-level exceptions can be |
| 185 | customized by assigning another three-argument function to ``sys.excepthook``. |
| 186 | |
| 187 | |
| 188 | .. data:: __displayhook__ |
| 189 | __excepthook__ |
| 190 | |
| 191 | These objects contain the original values of ``displayhook`` and ``excepthook`` |
| 192 | at the start of the program. They are saved so that ``displayhook`` and |
| 193 | ``excepthook`` can be restored in case they happen to get replaced with broken |
| 194 | objects. |
| 195 | |
| 196 | |
| 197 | .. function:: exc_info() |
| 198 | |
| 199 | This function returns a tuple of three values that give information about the |
| 200 | exception that is currently being handled. The information returned is specific |
| 201 | both to the current thread and to the current stack frame. If the current stack |
| 202 | frame is not handling an exception, the information is taken from the calling |
| 203 | stack frame, or its caller, and so on until a stack frame is found that is |
| 204 | handling an exception. Here, "handling an exception" is defined as "executing |
Benjamin Peterson | eec3d71 | 2008-06-11 15:59:43 +0000 | [diff] [blame] | 205 | an except clause." For any stack frame, only information about the exception |
| 206 | being currently handled is accessible. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 207 | |
| 208 | .. index:: object: traceback |
| 209 | |
Georg Brandl | 482b151 | 2010-03-21 09:02:59 +0000 | [diff] [blame] | 210 | If no exception is being handled anywhere on the stack, a tuple containing |
| 211 | three ``None`` values is returned. Otherwise, the values returned are |
| 212 | ``(type, value, traceback)``. Their meaning is: *type* gets the type of the |
| 213 | exception being handled (a subclass of :exc:`BaseException`); *value* gets |
| 214 | the exception instance (an instance of the exception type); *traceback* gets |
| 215 | a traceback object (see the Reference Manual) which encapsulates the call |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 216 | stack at the point where the exception originally occurred. |
| 217 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 218 | |
| 219 | .. data:: exec_prefix |
| 220 | |
| 221 | A string giving the site-specific directory prefix where the platform-dependent |
| 222 | 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] | 223 | be set at build time with the ``--exec-prefix`` argument to the |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 224 | :program:`configure` script. Specifically, all configuration files (e.g. the |
Éric Araujo | 58a9153 | 2011-10-05 01:28:24 +0200 | [diff] [blame] | 225 | :file:`pyconfig.h` header file) are installed in the directory |
Georg Brandl | eb25fb7 | 2012-02-23 21:12:39 +0100 | [diff] [blame] | 226 | :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] | 227 | installed in :file:`{exec_prefix}/lib/python{X.Y}/lib-dynload`, where *X.Y* |
| 228 | is the version number of Python, for example ``3.2``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 229 | |
Vinay Sajip | cd9b746 | 2012-07-09 10:37:01 +0100 | [diff] [blame] | 230 | .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this |
| 231 | value will be changed in ``site.py`` to point to the virtual environment. |
| 232 | The value for the Python installation will still be available, via |
| 233 | :data:`base_exec_prefix`. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 234 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 235 | |
| 236 | .. data:: executable |
| 237 | |
Petri Lehtinen | 9713321 | 2012-02-02 20:59:48 +0200 | [diff] [blame] | 238 | A string giving the absolute path of the executable binary for the Python |
| 239 | interpreter, on systems where this makes sense. If Python is unable to retrieve |
| 240 | the real path to its executable, :data:`sys.executable` will be an empty string |
| 241 | or ``None``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 242 | |
| 243 | |
| 244 | .. function:: exit([arg]) |
| 245 | |
| 246 | Exit from Python. This is implemented by raising the :exc:`SystemExit` |
| 247 | exception, so cleanup actions specified by finally clauses of :keyword:`try` |
Georg Brandl | 6f4e68d | 2010-10-17 10:51:45 +0000 | [diff] [blame] | 248 | statements are honored, and it is possible to intercept the exit attempt at |
| 249 | an outer level. |
| 250 | |
| 251 | The optional argument *arg* can be an integer giving the exit status |
| 252 | (defaulting to zero), or another type of object. If it is an integer, zero |
| 253 | is considered "successful termination" and any nonzero value is considered |
| 254 | "abnormal termination" by shells and the like. Most systems require it to be |
| 255 | in the range 0-127, and produce undefined results otherwise. Some systems |
| 256 | have a convention for assigning specific meanings to specific exit codes, but |
| 257 | these are generally underdeveloped; Unix programs generally use 2 for command |
| 258 | line syntax errors and 1 for all other kind of errors. If another type of |
| 259 | object is passed, ``None`` is equivalent to passing zero, and any other |
| 260 | object is printed to :data:`stderr` and results in an exit code of 1. In |
| 261 | particular, ``sys.exit("some error message")`` is a quick way to exit a |
| 262 | program when an error occurs. |
| 263 | |
| 264 | Since :func:`exit` ultimately "only" raises an exception, it will only exit |
| 265 | the process when called from the main thread, and the exception is not |
| 266 | intercepted. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 267 | |
| 268 | |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 269 | .. data:: flags |
| 270 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 271 | The :term:`struct sequence` *flags* exposes the status of command line |
| 272 | flags. The attributes are read only. |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 273 | |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 274 | ============================= ============================= |
| 275 | attribute flag |
| 276 | ============================= ============================= |
| 277 | :const:`debug` :option:`-d` |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 278 | :const:`inspect` :option:`-i` |
| 279 | :const:`interactive` :option:`-i` |
| 280 | :const:`optimize` :option:`-O` or :option:`-OO` |
| 281 | :const:`dont_write_bytecode` :option:`-B` |
| 282 | :const:`no_user_site` :option:`-s` |
| 283 | :const:`no_site` :option:`-S` |
| 284 | :const:`ignore_environment` :option:`-E` |
| 285 | :const:`verbose` :option:`-v` |
| 286 | :const:`bytes_warning` :option:`-b` |
Éric Araujo | 722bec4 | 2011-03-26 01:59:47 +0100 | [diff] [blame] | 287 | :const:`quiet` :option:`-q` |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 288 | :const:`hash_randomization` :option:`-R` |
Éric Araujo | 5ab4776 | 2011-03-26 00:47:04 +0100 | [diff] [blame] | 289 | ============================= ============================= |
Georg Brandl | 8aa7e99 | 2010-12-28 18:30:18 +0000 | [diff] [blame] | 290 | |
| 291 | .. versionchanged:: 3.2 |
| 292 | Added ``quiet`` attribute for the new :option:`-q` flag. |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 293 | |
Georg Brandl | 09a7c72 | 2012-02-20 21:31:46 +0100 | [diff] [blame] | 294 | .. versionadded:: 3.2.3 |
Georg Brandl | 2daf6ae | 2012-02-20 19:54:16 +0100 | [diff] [blame] | 295 | The ``hash_randomization`` attribute. |
| 296 | |
Éric Araujo | 3e89870 | 2011-04-24 04:37:00 +0200 | [diff] [blame] | 297 | .. versionchanged:: 3.3 |
| 298 | Removed obsolete ``division_warning`` attribute. |
| 299 | |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 300 | |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 301 | .. data:: float_info |
| 302 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 303 | A :term:`struct sequence` holding information about the float type. It |
| 304 | contains low level information about the precision and internal |
| 305 | representation. The values correspond to the various floating-point |
| 306 | constants defined in the standard header file :file:`float.h` for the 'C' |
| 307 | programming language; see section 5.2.4.2.2 of the 1999 ISO/IEC C standard |
| 308 | [C99]_, 'Characteristics of floating types', for details. |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 309 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 310 | +---------------------+----------------+--------------------------------------------------+ |
| 311 | | attribute | float.h macro | explanation | |
| 312 | +=====================+================+==================================================+ |
Mark Dickinson | 39af05f | 2010-07-03 09:17:16 +0000 | [diff] [blame] | 313 | | :const:`epsilon` | DBL_EPSILON | difference between 1 and the least value greater | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 314 | | | | than 1 that is representable as a float | |
| 315 | +---------------------+----------------+--------------------------------------------------+ |
| 316 | | :const:`dig` | DBL_DIG | maximum number of decimal digits that can be | |
| 317 | | | | faithfully represented in a float; see below | |
| 318 | +---------------------+----------------+--------------------------------------------------+ |
| 319 | | :const:`mant_dig` | DBL_MANT_DIG | float precision: the number of base-``radix`` | |
| 320 | | | | digits in the significand of a float | |
| 321 | +---------------------+----------------+--------------------------------------------------+ |
| 322 | | :const:`max` | DBL_MAX | maximum representable finite float | |
| 323 | +---------------------+----------------+--------------------------------------------------+ |
| 324 | | :const:`max_exp` | DBL_MAX_EXP | maximum integer e such that ``radix**(e-1)`` is | |
| 325 | | | | a representable finite float | |
| 326 | +---------------------+----------------+--------------------------------------------------+ |
| 327 | | :const:`max_10_exp` | DBL_MAX_10_EXP | maximum integer e such that ``10**e`` is in the | |
| 328 | | | | range of representable finite floats | |
| 329 | +---------------------+----------------+--------------------------------------------------+ |
| 330 | | :const:`min` | DBL_MIN | minimum positive normalized float | |
| 331 | +---------------------+----------------+--------------------------------------------------+ |
| 332 | | :const:`min_exp` | DBL_MIN_EXP | minimum integer e such that ``radix**(e-1)`` is | |
| 333 | | | | a normalized float | |
| 334 | +---------------------+----------------+--------------------------------------------------+ |
| 335 | | :const:`min_10_exp` | DBL_MIN_10_EXP | minimum integer e such that ``10**e`` is a | |
| 336 | | | | normalized float | |
| 337 | +---------------------+----------------+--------------------------------------------------+ |
| 338 | | :const:`radix` | FLT_RADIX | radix of exponent representation | |
| 339 | +---------------------+----------------+--------------------------------------------------+ |
Mark Dickinson | b1e58fe | 2011-11-19 16:26:45 +0000 | [diff] [blame] | 340 | | :const:`rounds` | FLT_ROUNDS | integer constant representing the rounding mode | |
| 341 | | | | used for arithmetic operations. This reflects | |
| 342 | | | | the value of the system FLT_ROUNDS macro at | |
| 343 | | | | interpreter startup time. See section 5.2.4.2.2 | |
| 344 | | | | of the C99 standard for an explanation of the | |
| 345 | | | | possible values and their meanings. | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 346 | +---------------------+----------------+--------------------------------------------------+ |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 347 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 348 | The attribute :attr:`sys.float_info.dig` needs further explanation. If |
| 349 | ``s`` is any string representing a decimal number with at most |
| 350 | :attr:`sys.float_info.dig` significant digits, then converting ``s`` to a |
| 351 | float and back again will recover a string representing the same decimal |
| 352 | value:: |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 353 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 354 | >>> import sys |
| 355 | >>> sys.float_info.dig |
| 356 | 15 |
| 357 | >>> s = '3.14159265358979' # decimal string with 15 significant digits |
| 358 | >>> format(float(s), '.15g') # convert to float and back -> same value |
| 359 | '3.14159265358979' |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 360 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 361 | But for strings with more than :attr:`sys.float_info.dig` significant digits, |
| 362 | this isn't always true:: |
| 363 | |
| 364 | >>> s = '9876543211234567' # 16 significant digits is too many! |
| 365 | >>> format(float(s), '.16g') # conversion changes value |
| 366 | '9876543211234568' |
Christian Heimes | 9385266 | 2007-12-01 12:22:32 +0000 | [diff] [blame] | 367 | |
Mark Dickinson | b08a53a | 2009-04-16 19:52:09 +0000 | [diff] [blame] | 368 | .. data:: float_repr_style |
| 369 | |
| 370 | A string indicating how the :func:`repr` function behaves for |
| 371 | floats. If the string has value ``'short'`` then for a finite |
| 372 | float ``x``, ``repr(x)`` aims to produce a short string with the |
| 373 | property that ``float(repr(x)) == x``. This is the usual behaviour |
| 374 | in Python 3.1 and later. Otherwise, ``float_repr_style`` has value |
| 375 | ``'legacy'`` and ``repr(x)`` behaves in the same way as it did in |
| 376 | versions of Python prior to 3.1. |
| 377 | |
| 378 | .. versionadded:: 3.1 |
| 379 | |
| 380 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 381 | .. function:: getcheckinterval() |
| 382 | |
| 383 | Return the interpreter's "check interval"; see :func:`setcheckinterval`. |
| 384 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 385 | .. deprecated:: 3.2 |
| 386 | Use :func:`getswitchinterval` instead. |
| 387 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 388 | |
| 389 | .. function:: getdefaultencoding() |
| 390 | |
| 391 | Return the name of the current default string encoding used by the Unicode |
| 392 | implementation. |
| 393 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 394 | |
| 395 | .. function:: getdlopenflags() |
| 396 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 397 | Return the current value of the flags that are used for :c:func:`dlopen` calls. |
Neal Norwitz | 6cf49cf | 2008-03-24 06:22:57 +0000 | [diff] [blame] | 398 | The flag constants are defined in the :mod:`ctypes` and :mod:`DLFCN` modules. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 399 | Availability: Unix. |
| 400 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 401 | |
| 402 | .. function:: getfilesystemencoding() |
| 403 | |
Victor Stinner | b744ba1 | 2010-05-15 12:27:16 +0000 | [diff] [blame] | 404 | Return the name of the encoding used to convert Unicode filenames into |
| 405 | system file names. The result value depends on the operating system: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 406 | |
Ezio Melotti | d5334e1 | 2010-04-29 16:24:51 +0000 | [diff] [blame] | 407 | * On Mac OS X, the encoding is ``'utf-8'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 408 | |
| 409 | * On Unix, the encoding is the user's preference according to the result of |
Victor Stinner | b744ba1 | 2010-05-15 12:27:16 +0000 | [diff] [blame] | 410 | nl_langinfo(CODESET), or ``'utf-8'`` if ``nl_langinfo(CODESET)`` failed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 411 | |
| 412 | * On Windows NT+, file names are Unicode natively, so no conversion is |
Ezio Melotti | d5334e1 | 2010-04-29 16:24:51 +0000 | [diff] [blame] | 413 | performed. :func:`getfilesystemencoding` still returns ``'mbcs'``, as |
| 414 | this is the encoding that applications should use when they explicitly |
| 415 | want to convert Unicode strings to byte strings that are equivalent when |
| 416 | used as file names. |
| 417 | |
| 418 | * On Windows 9x, the encoding is ``'mbcs'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 419 | |
Victor Stinner | b744ba1 | 2010-05-15 12:27:16 +0000 | [diff] [blame] | 420 | .. versionchanged:: 3.2 |
| 421 | On Unix, use ``'utf-8'`` instead of ``None`` if ``nl_langinfo(CODESET)`` |
| 422 | failed. :func:`getfilesystemencoding` result cannot be ``None``. |
| 423 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 424 | |
| 425 | .. function:: getrefcount(object) |
| 426 | |
| 427 | Return the reference count of the *object*. The count returned is generally one |
| 428 | higher than you might expect, because it includes the (temporary) reference as |
| 429 | an argument to :func:`getrefcount`. |
| 430 | |
| 431 | |
| 432 | .. function:: getrecursionlimit() |
| 433 | |
| 434 | Return the current value of the recursion limit, the maximum depth of the Python |
| 435 | interpreter stack. This limit prevents infinite recursion from causing an |
| 436 | overflow of the C stack and crashing Python. It can be set by |
| 437 | :func:`setrecursionlimit`. |
| 438 | |
| 439 | |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 440 | .. function:: getsizeof(object[, default]) |
Martin v. Löwis | 00709aa | 2008-06-04 14:18:43 +0000 | [diff] [blame] | 441 | |
| 442 | Return the size of an object in bytes. The object can be any type of |
| 443 | object. All built-in objects will return correct results, but this |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 444 | 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] | 445 | specific. |
| 446 | |
Martin v. Löwis | 1e5d0ff | 2012-06-17 10:40:16 +0200 | [diff] [blame] | 447 | Only the memory consumption directly attributed to the object is |
| 448 | accounted for, not the memory consumption of objects it refers to. |
| 449 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 450 | 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] | 451 | retrieve the size. Otherwise a :exc:`TypeError` will be raised. |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 452 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 453 | :func:`getsizeof` calls the object's ``__sizeof__`` method and adds an |
| 454 | additional garbage collector overhead if the object is managed by the garbage |
| 455 | collector. |
Robert Schuppenies | fbe94c5 | 2008-07-14 10:13:31 +0000 | [diff] [blame] | 456 | |
Raymond Hettinger | c539a2a | 2010-12-17 23:31:30 +0000 | [diff] [blame] | 457 | See `recursive sizeof recipe <http://code.activestate.com/recipes/577504>`_ |
| 458 | for an example of using :func:`getsizeof` recursively to find the size of |
| 459 | containers and all their contents. |
Martin v. Löwis | 00709aa | 2008-06-04 14:18:43 +0000 | [diff] [blame] | 460 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 461 | .. function:: getswitchinterval() |
| 462 | |
| 463 | Return the interpreter's "thread switch interval"; see |
| 464 | :func:`setswitchinterval`. |
| 465 | |
Antoine Pitrou | 79707ca | 2009-11-11 22:03:32 +0000 | [diff] [blame] | 466 | .. versionadded:: 3.2 |
| 467 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 468 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 469 | .. function:: _getframe([depth]) |
| 470 | |
| 471 | Return a frame object from the call stack. If optional integer *depth* is |
| 472 | given, return the frame object that many calls below the top of the stack. If |
| 473 | that is deeper than the call stack, :exc:`ValueError` is raised. The default |
| 474 | for *depth* is zero, returning the frame at the top of the call stack. |
| 475 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 476 | .. impl-detail:: |
| 477 | |
| 478 | This function should be used for internal and specialized purposes only. |
| 479 | It is not guaranteed to exist in all implementations of Python. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 480 | |
| 481 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 482 | .. function:: getprofile() |
| 483 | |
| 484 | .. index:: |
| 485 | single: profile function |
| 486 | single: profiler |
| 487 | |
| 488 | Get the profiler function as set by :func:`setprofile`. |
| 489 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 490 | |
| 491 | .. function:: gettrace() |
| 492 | |
| 493 | .. index:: |
| 494 | single: trace function |
| 495 | single: debugger |
| 496 | |
| 497 | Get the trace function as set by :func:`settrace`. |
| 498 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 499 | .. impl-detail:: |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 500 | |
| 501 | The :func:`gettrace` function is intended only for implementing debuggers, |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 502 | profilers, coverage tools and the like. Its behavior is part of the |
| 503 | implementation platform, rather than part of the language definition, and |
| 504 | thus may not be available in all Python implementations. |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 505 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 506 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 507 | .. function:: getwindowsversion() |
| 508 | |
Eric Smith | 7338a39 | 2010-01-27 00:56:30 +0000 | [diff] [blame] | 509 | Return a named tuple describing the Windows version |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 510 | currently running. The named elements are *major*, *minor*, |
| 511 | *build*, *platform*, *service_pack*, *service_pack_minor*, |
| 512 | *service_pack_major*, *suite_mask*, and *product_type*. |
| 513 | *service_pack* contains a string while all other values are |
| 514 | integers. The components can also be accessed by name, so |
| 515 | ``sys.getwindowsversion()[0]`` is equivalent to |
| 516 | ``sys.getwindowsversion().major``. For compatibility with prior |
| 517 | versions, only the first 5 elements are retrievable by indexing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 518 | |
| 519 | *platform* may be one of the following values: |
| 520 | |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 521 | +-----------------------------------------+-------------------------+ |
| 522 | | Constant | Platform | |
| 523 | +=========================================+=========================+ |
| 524 | | :const:`0 (VER_PLATFORM_WIN32s)` | Win32s on Windows 3.1 | |
| 525 | +-----------------------------------------+-------------------------+ |
| 526 | | :const:`1 (VER_PLATFORM_WIN32_WINDOWS)` | Windows 95/98/ME | |
| 527 | +-----------------------------------------+-------------------------+ |
| 528 | | :const:`2 (VER_PLATFORM_WIN32_NT)` | Windows NT/2000/XP/x64 | |
| 529 | +-----------------------------------------+-------------------------+ |
| 530 | | :const:`3 (VER_PLATFORM_WIN32_CE)` | Windows CE | |
| 531 | +-----------------------------------------+-------------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 532 | |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 533 | *product_type* may be one of the following values: |
| 534 | |
| 535 | +---------------------------------------+---------------------------------+ |
| 536 | | Constant | Meaning | |
| 537 | +=======================================+=================================+ |
| 538 | | :const:`1 (VER_NT_WORKSTATION)` | The system is a workstation. | |
| 539 | +---------------------------------------+---------------------------------+ |
| 540 | | :const:`2 (VER_NT_DOMAIN_CONTROLLER)` | The system is a domain | |
| 541 | | | controller. | |
| 542 | +---------------------------------------+---------------------------------+ |
| 543 | | :const:`3 (VER_NT_SERVER)` | The system is a server, but not | |
| 544 | | | a domain controller. | |
| 545 | +---------------------------------------+---------------------------------+ |
| 546 | |
| 547 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 548 | This function wraps the Win32 :c:func:`GetVersionEx` function; see the |
| 549 | Microsoft documentation on :c:func:`OSVERSIONINFOEX` for more information |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 550 | about these fields. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 551 | |
| 552 | Availability: Windows. |
| 553 | |
Ezio Melotti | 83fc6dd | 2010-01-27 22:44:03 +0000 | [diff] [blame] | 554 | .. versionchanged:: 3.2 |
Eric Smith | f7bb578 | 2010-01-27 00:44:57 +0000 | [diff] [blame] | 555 | Changed to a named tuple and added *service_pack_minor*, |
| 556 | *service_pack_major*, *suite_mask*, and *product_type*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 557 | |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 558 | |
| 559 | .. data:: hash_info |
| 560 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 561 | A :term:`struct sequence` giving parameters of the numeric hash |
| 562 | implementation. For more details about hashing of numeric types, see |
| 563 | :ref:`numeric-hash`. |
Mark Dickinson | dc787d2 | 2010-05-23 13:33:13 +0000 | [diff] [blame] | 564 | |
| 565 | +---------------------+--------------------------------------------------+ |
| 566 | | attribute | explanation | |
| 567 | +=====================+==================================================+ |
| 568 | | :const:`width` | width in bits used for hash values | |
| 569 | +---------------------+--------------------------------------------------+ |
| 570 | | :const:`modulus` | prime modulus P used for numeric hash scheme | |
| 571 | +---------------------+--------------------------------------------------+ |
| 572 | | :const:`inf` | hash value returned for a positive infinity | |
| 573 | +---------------------+--------------------------------------------------+ |
| 574 | | :const:`nan` | hash value returned for a nan | |
| 575 | +---------------------+--------------------------------------------------+ |
| 576 | | :const:`imag` | multiplier used for the imaginary part of a | |
| 577 | | | complex number | |
| 578 | +---------------------+--------------------------------------------------+ |
| 579 | |
| 580 | .. versionadded:: 3.2 |
| 581 | |
| 582 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 583 | .. data:: hexversion |
| 584 | |
| 585 | The version number encoded as a single integer. This is guaranteed to increase |
| 586 | with each version, including proper support for non-production releases. For |
| 587 | example, to test that the Python interpreter is at least version 1.5.2, use:: |
| 588 | |
| 589 | if sys.hexversion >= 0x010502F0: |
| 590 | # use some advanced feature |
| 591 | ... |
| 592 | else: |
| 593 | # use an alternative implementation or warn the user |
| 594 | ... |
| 595 | |
| 596 | This is called ``hexversion`` since it only really looks meaningful when viewed |
| 597 | 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] | 598 | :term:`struct sequence` :data:`sys.version_info` may be used for a more |
| 599 | human-friendly encoding of the same information. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 600 | |
Nick Coghlan | 7d82c86 | 2013-03-07 23:14:44 +1000 | [diff] [blame] | 601 | More details of ``hexversion`` can be found at :ref:`apiabiversion` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 602 | |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 603 | |
| 604 | .. data:: implementation |
| 605 | |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 606 | An object containing information about the implementation of the |
| 607 | currently running Python interpreter. The following attributes are |
| 608 | required to exist in all Python implementations. |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 609 | |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 610 | *name* is the implementation's identifier, e.g. ``'cpython'``. The actual |
| 611 | string is defined by the Python implementation, but it is guaranteed to be |
| 612 | lower case. |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 613 | |
| 614 | *version* is a named tuple, in the same format as |
| 615 | :data:`sys.version_info`. It represents the version of the Python |
| 616 | *implementation*. This has a distinct meaning from the specific |
| 617 | version of the Python *language* to which the currently running |
| 618 | interpreter conforms, which ``sys.version_info`` represents. For |
| 619 | example, for PyPy 1.8 ``sys.implementation.version`` might be |
| 620 | ``sys.version_info(1, 8, 0, 'final', 0)``, whereas ``sys.version_info`` |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 621 | 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] | 622 | are the same value, since it is the reference implementation. |
| 623 | |
| 624 | *hexversion* is the implementation version in hexadecimal format, like |
| 625 | :data:`sys.hexversion`. |
| 626 | |
| 627 | *cache_tag* is the tag used by the import machinery in the filenames of |
| 628 | cached modules. By convention, it would be a composite of the |
| 629 | implementation's name and version, like ``'cpython-33'``. However, a |
| 630 | Python implementation may use some other value if appropriate. If |
| 631 | ``cache_tag`` is set to ``None``, it indicates that module caching should |
| 632 | be disabled. |
| 633 | |
Barry Warsaw | 9b10e1f | 2012-06-04 11:06:45 -0400 | [diff] [blame] | 634 | :data:`sys.implementation` may contain additional attributes specific to |
| 635 | the Python implementation. These non-standard attributes must start with |
| 636 | an underscore, and are not described here. Regardless of its contents, |
| 637 | :data:`sys.implementation` will not change during a run of the interpreter, |
| 638 | nor between implementation versions. (It may change between Python |
| 639 | language versions, however.) See `PEP 421` for more information. |
Barry Warsaw | 409da15 | 2012-06-03 16:18:47 -0400 | [diff] [blame] | 640 | |
| 641 | .. versionadded:: 3.3 |
| 642 | |
| 643 | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 644 | .. data:: int_info |
| 645 | |
Benjamin Peterson | 2b8ef2d | 2011-04-20 18:31:22 -0500 | [diff] [blame] | 646 | A :term:`struct sequence` that holds information about Python's internal |
| 647 | representation of integers. The attributes are read only. |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 648 | |
| 649 | +-------------------------+----------------------------------------------+ |
R David Murray | 9beb34e | 2011-04-30 16:35:29 -0400 | [diff] [blame] | 650 | | Attribute | Explanation | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 651 | +=========================+==============================================+ |
| 652 | | :const:`bits_per_digit` | number of bits held in each digit. Python | |
| 653 | | | integers are stored internally in base | |
| 654 | | | ``2**int_info.bits_per_digit`` | |
| 655 | +-------------------------+----------------------------------------------+ |
| 656 | | :const:`sizeof_digit` | size in bytes of the C type used to | |
| 657 | | | represent a digit | |
| 658 | +-------------------------+----------------------------------------------+ |
| 659 | |
Mark Dickinson | d72c7b6 | 2009-03-20 16:00:49 +0000 | [diff] [blame] | 660 | .. versionadded:: 3.1 |
| 661 | |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 662 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 663 | .. function:: intern(string) |
| 664 | |
| 665 | Enter *string* in the table of "interned" strings and return the interned string |
| 666 | -- which is *string* itself or a copy. Interning strings is useful to gain a |
| 667 | little performance on dictionary lookup -- if the keys in a dictionary are |
| 668 | interned, and the lookup key is interned, the key comparisons (after hashing) |
| 669 | can be done by a pointer compare instead of a string compare. Normally, the |
| 670 | names used in Python programs are automatically interned, and the dictionaries |
| 671 | used to hold module, class or instance attributes have interned keys. |
| 672 | |
Georg Brandl | 55ac8f0 | 2007-09-01 13:51:09 +0000 | [diff] [blame] | 673 | Interned strings are not immortal; you must keep a reference to the return |
| 674 | value of :func:`intern` around to benefit from it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 675 | |
| 676 | |
| 677 | .. data:: last_type |
| 678 | last_value |
| 679 | last_traceback |
| 680 | |
| 681 | These three variables are not always defined; they are set when an exception is |
| 682 | not handled and the interpreter prints an error message and a stack traceback. |
| 683 | Their intended use is to allow an interactive user to import a debugger module |
| 684 | and engage in post-mortem debugging without having to re-execute the command |
| 685 | 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] | 686 | post-mortem debugger; see :mod:`pdb` module for |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 687 | more information.) |
| 688 | |
| 689 | 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] | 690 | :func:`exc_info` above. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 691 | |
| 692 | |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 693 | .. data:: maxsize |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 694 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 695 | 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] | 696 | take. It's usually ``2**31 - 1`` on a 32-bit platform and ``2**63 - 1`` on a |
| 697 | 64-bit platform. |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 698 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 699 | |
| 700 | .. data:: maxunicode |
| 701 | |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 702 | An integer giving the value of the largest Unicode code point, |
| 703 | i.e. ``1114111`` (``0x10FFFF`` in hexadecimal). |
| 704 | |
| 705 | .. versionchanged:: 3.3 |
Éric Araujo | 525b1e9 | 2011-10-05 01:06:31 +0200 | [diff] [blame] | 706 | Before :pep:`393`, ``sys.maxunicode`` used to be either ``0xFFFF`` |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 707 | or ``0x10FFFF``, depending on the configuration option that specified |
| 708 | whether Unicode characters were stored as UCS-2 or UCS-4. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 709 | |
| 710 | |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 711 | .. data:: meta_path |
| 712 | |
| 713 | A list of :term:`finder` objects that have their :meth:`find_module` |
| 714 | methods called to see if one of the objects can find the module to be |
| 715 | imported. The :meth:`find_module` method is called at least with the |
| 716 | absolute name of the module being imported. If the module to be imported is |
| 717 | contained in package then the parent package's :attr:`__path__` attribute |
Georg Brandl | 375aec2 | 2011-01-15 17:03:02 +0000 | [diff] [blame] | 718 | is passed in as a second argument. The method returns ``None`` if |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 719 | the module cannot be found, else returns a :term:`loader`. |
| 720 | |
| 721 | :data:`sys.meta_path` is searched before any implicit default finders or |
| 722 | :data:`sys.path`. |
| 723 | |
| 724 | See :pep:`302` for the original specification. |
| 725 | |
| 726 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 727 | .. data:: modules |
| 728 | |
| 729 | This is a dictionary that maps module names to modules which have already been |
| 730 | loaded. This can be manipulated to force reloading of modules and other tricks. |
| 731 | |
| 732 | |
| 733 | .. data:: path |
| 734 | |
| 735 | .. index:: triple: module; search; path |
| 736 | |
| 737 | A list of strings that specifies the search path for modules. Initialized from |
| 738 | the environment variable :envvar:`PYTHONPATH`, plus an installation-dependent |
| 739 | default. |
| 740 | |
| 741 | As initialized upon program startup, the first item of this list, ``path[0]``, |
| 742 | is the directory containing the script that was used to invoke the Python |
| 743 | interpreter. If the script directory is not available (e.g. if the interpreter |
| 744 | is invoked interactively or if the script is read from standard input), |
| 745 | ``path[0]`` is the empty string, which directs Python to search modules in the |
| 746 | current directory first. Notice that the script directory is inserted *before* |
| 747 | the entries inserted as a result of :envvar:`PYTHONPATH`. |
| 748 | |
Barry Warsaw | 82c1c78 | 2012-11-20 15:22:51 -0500 | [diff] [blame] | 749 | A program is free to modify this list for its own purposes. Only strings |
| 750 | and bytes should be added to :data:`sys.path`; all other data types are |
| 751 | ignored during import. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 752 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 753 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 754 | .. seealso:: |
| 755 | Module :mod:`site` This describes how to use .pth files to extend |
| 756 | :data:`sys.path`. |
| 757 | |
| 758 | |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 759 | .. data:: path_hooks |
| 760 | |
| 761 | A list of callables that take a path argument to try to create a |
| 762 | :term:`finder` for the path. If a finder can be created, it is to be |
| 763 | returned by the callable, else raise :exc:`ImportError`. |
| 764 | |
| 765 | Originally specified in :pep:`302`. |
| 766 | |
| 767 | |
| 768 | .. data:: path_importer_cache |
| 769 | |
| 770 | A dictionary acting as a cache for :term:`finder` objects. The keys are |
| 771 | paths that have been passed to :data:`sys.path_hooks` and the values are |
| 772 | the finders that are found. If a path is a valid file system path but no |
Georg Brandl | 375aec2 | 2011-01-15 17:03:02 +0000 | [diff] [blame] | 773 | explicit finder is found on :data:`sys.path_hooks` then ``None`` is |
Brett Cannon | e43b060 | 2009-03-21 03:11:16 +0000 | [diff] [blame] | 774 | stored to represent the implicit default finder should be used. If the path |
| 775 | is not an existing path then :class:`imp.NullImporter` is set. |
| 776 | |
| 777 | Originally specified in :pep:`302`. |
| 778 | |
| 779 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 780 | .. data:: platform |
| 781 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 782 | This string contains a platform identifier that can be used to append |
| 783 | platform-specific components to :data:`sys.path`, for instance. |
| 784 | |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 785 | For Unix systems, except on Linux, this is the lowercased OS name as |
| 786 | returned by ``uname -s`` with the first part of the version as returned by |
| 787 | ``uname -r`` appended, e.g. ``'sunos5'`` or ``'freebsd8'``, *at the time |
| 788 | when Python was built*. Unless you want to test for a specific system |
| 789 | version, it is therefore recommended to use the following idiom:: |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 790 | |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 791 | if sys.platform.startswith('freebsd'): |
| 792 | # FreeBSD-specific code here... |
Georg Brandl | a47e53e | 2011-09-03 09:26:09 +0200 | [diff] [blame] | 793 | elif sys.platform.startswith('linux'): |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 794 | # Linux-specific code here... |
| 795 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 796 | For other systems, the values are: |
| 797 | |
| 798 | ================ =========================== |
Éric Araujo | 3f7c0e4 | 2012-12-08 22:53:43 -0500 | [diff] [blame] | 799 | System ``platform`` value |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 800 | ================ =========================== |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 801 | Linux ``'linux'`` |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 802 | Windows ``'win32'`` |
| 803 | Windows/Cygwin ``'cygwin'`` |
Georg Brandl | c575c90 | 2008-09-13 17:46:05 +0000 | [diff] [blame] | 804 | Mac OS X ``'darwin'`` |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 805 | OS/2 ``'os2'`` |
| 806 | OS/2 EMX ``'os2emx'`` |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 807 | ================ =========================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 808 | |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 809 | .. versionchanged:: 3.3 |
| 810 | On Linux, :attr:`sys.platform` doesn't contain the major version anymore. |
Georg Brandl | fbd1e04 | 2011-09-04 08:42:26 +0200 | [diff] [blame] | 811 | It is always ``'linux'``, instead of ``'linux2'`` or ``'linux3'``. Since |
| 812 | older Python versions include the version number, it is recommended to |
| 813 | always use the ``startswith`` idiom presented above. |
Victor Stinner | 795eaeb | 2011-08-21 12:08:11 +0200 | [diff] [blame] | 814 | |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 815 | .. seealso:: |
Georg Brandl | eb25fb7 | 2012-02-23 21:12:39 +0100 | [diff] [blame] | 816 | |
Antoine Pitrou | a83cdaa | 2011-07-09 15:54:23 +0200 | [diff] [blame] | 817 | :attr:`os.name` has a coarser granularity. :func:`os.uname` gives |
| 818 | system-dependent version information. |
| 819 | |
| 820 | The :mod:`platform` module provides detailed checks for the |
| 821 | system's identity. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 822 | |
Georg Brandl | fbd1e04 | 2011-09-04 08:42:26 +0200 | [diff] [blame] | 823 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 824 | .. data:: prefix |
| 825 | |
| 826 | A string giving the site-specific directory prefix where the platform |
| 827 | independent Python files are installed; by default, this is the string |
Éric Araujo | 713d303 | 2010-11-18 16:38:46 +0000 | [diff] [blame] | 828 | ``'/usr/local'``. This can be set at build time with the ``--prefix`` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 829 | argument to the :program:`configure` script. The main collection of Python |
Georg Brandl | a673eb8 | 2012-03-04 16:17:05 +0100 | [diff] [blame] | 830 | 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] | 831 | while the platform independent header files (all except :file:`pyconfig.h`) are |
Georg Brandl | eb25fb7 | 2012-02-23 21:12:39 +0100 | [diff] [blame] | 832 | 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] | 833 | number of Python, for example ``3.2``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 834 | |
Vinay Sajip | cd9b746 | 2012-07-09 10:37:01 +0100 | [diff] [blame] | 835 | .. note:: If a :ref:`virtual environment <venv-def>` is in effect, this |
| 836 | value will be changed in ``site.py`` to point to the virtual |
| 837 | environment. The value for the Python installation will still be |
| 838 | available, via :data:`base_prefix`. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 839 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 840 | |
| 841 | .. data:: ps1 |
| 842 | ps2 |
| 843 | |
| 844 | .. index:: |
| 845 | single: interpreter prompts |
| 846 | single: prompts, interpreter |
| 847 | |
| 848 | Strings specifying the primary and secondary prompt of the interpreter. These |
| 849 | are only defined if the interpreter is in interactive mode. Their initial |
| 850 | values in this case are ``'>>> '`` and ``'... '``. If a non-string object is |
| 851 | assigned to either variable, its :func:`str` is re-evaluated each time the |
| 852 | interpreter prepares to read a new interactive command; this can be used to |
| 853 | implement a dynamic prompt. |
| 854 | |
| 855 | |
| 856 | .. function:: setcheckinterval(interval) |
| 857 | |
| 858 | Set the interpreter's "check interval". This integer value determines how often |
| 859 | the interpreter checks for periodic things such as thread switches and signal |
| 860 | handlers. The default is ``100``, meaning the check is performed every 100 |
| 861 | Python virtual instructions. Setting it to a larger value may increase |
| 862 | performance for programs using threads. Setting it to a value ``<=`` 0 checks |
| 863 | every virtual instruction, maximizing responsiveness as well as overhead. |
| 864 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 865 | .. deprecated:: 3.2 |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 866 | This function doesn't have an effect anymore, as the internal logic for |
| 867 | thread switching and asynchronous tasks has been rewritten. Use |
| 868 | :func:`setswitchinterval` instead. |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 869 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 870 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 871 | .. function:: setdlopenflags(n) |
| 872 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 873 | 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] | 874 | the interpreter loads extension modules. Among other things, this will enable a |
| 875 | lazy resolving of symbols when importing a module, if called as |
| 876 | ``sys.setdlopenflags(0)``. To share symbols across extension modules, call as |
Victor Stinner | 8b905bd | 2011-10-25 13:34:04 +0200 | [diff] [blame] | 877 | ``sys.setdlopenflags(os.RTLD_GLOBAL)``. Symbolic names for the flag modules |
| 878 | can be found in the :mod:`os` module (``RTLD_xxx`` constants, e.g. |
| 879 | :data:`os.RTLD_LAZY`). |
| 880 | |
| 881 | Availability: Unix. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 882 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 883 | .. function:: setprofile(profilefunc) |
| 884 | |
| 885 | .. index:: |
| 886 | single: profile function |
| 887 | single: profiler |
| 888 | |
| 889 | Set the system's profile function, which allows you to implement a Python source |
| 890 | code profiler in Python. See chapter :ref:`profile` for more information on the |
| 891 | Python profiler. The system's profile function is called similarly to the |
| 892 | system's trace function (see :func:`settrace`), but it isn't called for each |
| 893 | executed line of code (only on call and return, but the return event is reported |
| 894 | even when an exception has been set). The function is thread-specific, but |
| 895 | there is no way for the profiler to know about context switches between threads, |
| 896 | so it does not make sense to use this in the presence of multiple threads. Also, |
| 897 | its return value is not used, so it can simply return ``None``. |
| 898 | |
| 899 | |
| 900 | .. function:: setrecursionlimit(limit) |
| 901 | |
| 902 | Set the maximum depth of the Python interpreter stack to *limit*. This limit |
| 903 | prevents infinite recursion from causing an overflow of the C stack and crashing |
| 904 | Python. |
| 905 | |
| 906 | 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] | 907 | 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] | 908 | that supports a higher limit. This should be done with care, because a too-high |
| 909 | limit can lead to a crash. |
| 910 | |
| 911 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 912 | .. function:: setswitchinterval(interval) |
| 913 | |
| 914 | Set the interpreter's thread switch interval (in seconds). This floating-point |
| 915 | value determines the ideal duration of the "timeslices" allocated to |
| 916 | concurrently running Python threads. Please note that the actual value |
| 917 | can be higher, especially if long-running internal functions or methods |
| 918 | are used. Also, which thread becomes scheduled at the end of the interval |
| 919 | is the operating system's decision. The interpreter doesn't have its |
| 920 | own scheduler. |
| 921 | |
Antoine Pitrou | 79707ca | 2009-11-11 22:03:32 +0000 | [diff] [blame] | 922 | .. versionadded:: 3.2 |
| 923 | |
Antoine Pitrou | d42bc51 | 2009-11-10 23:18:31 +0000 | [diff] [blame] | 924 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 925 | .. function:: settrace(tracefunc) |
| 926 | |
| 927 | .. index:: |
| 928 | single: trace function |
| 929 | single: debugger |
| 930 | |
| 931 | 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] | 932 | source code debugger in Python. The function is thread-specific; for a |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 933 | debugger to support multiple threads, it must be registered using |
| 934 | :func:`settrace` for each thread being debugged. |
| 935 | |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 936 | Trace functions should have three arguments: *frame*, *event*, and |
| 937 | *arg*. *frame* is the current stack frame. *event* is a string: ``'call'``, |
| 938 | ``'line'``, ``'return'``, ``'exception'``, ``'c_call'``, ``'c_return'``, or |
| 939 | ``'c_exception'``. *arg* depends on the event type. |
| 940 | |
| 941 | The trace function is invoked (with *event* set to ``'call'``) whenever a new |
| 942 | local scope is entered; it should return a reference to a local trace |
| 943 | function to be used that scope, or ``None`` if the scope shouldn't be traced. |
| 944 | |
| 945 | The local trace function should return a reference to itself (or to another |
| 946 | function for further tracing in that scope), or ``None`` to turn off tracing |
| 947 | in that scope. |
| 948 | |
| 949 | The events have the following meaning: |
| 950 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 951 | ``'call'`` |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 952 | A function is called (or some other code block entered). The |
| 953 | global trace function is called; *arg* is ``None``; the return value |
| 954 | specifies the local trace function. |
| 955 | |
| 956 | ``'line'`` |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 957 | The interpreter is about to execute a new line of code or re-execute the |
| 958 | condition of a loop. The local trace function is called; *arg* is |
| 959 | ``None``; the return value specifies the new local trace function. See |
| 960 | :file:`Objects/lnotab_notes.txt` for a detailed explanation of how this |
| 961 | works. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 962 | |
| 963 | ``'return'`` |
| 964 | 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] | 965 | function is called; *arg* is the value that will be returned, or ``None`` |
| 966 | if the event is caused by an exception being raised. The trace function's |
| 967 | return value is ignored. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 968 | |
| 969 | ``'exception'`` |
| 970 | An exception has occurred. The local trace function is called; *arg* is a |
| 971 | tuple ``(exception, value, traceback)``; the return value specifies the |
| 972 | new local trace function. |
| 973 | |
| 974 | ``'c_call'`` |
| 975 | A C function is about to be called. This may be an extension function or |
Georg Brandl | 22b3431 | 2009-07-26 14:54:51 +0000 | [diff] [blame] | 976 | a built-in. *arg* is the C function object. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 977 | |
| 978 | ``'c_return'`` |
Georg Brandl | d0b0e1d | 2010-10-15 16:42:37 +0000 | [diff] [blame] | 979 | A C function has returned. *arg* is the C function object. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 980 | |
| 981 | ``'c_exception'`` |
Georg Brandl | d0b0e1d | 2010-10-15 16:42:37 +0000 | [diff] [blame] | 982 | A C function has raised an exception. *arg* is the C function object. |
Amaury Forgeot d'Arc | b0c2916 | 2008-11-22 22:18:04 +0000 | [diff] [blame] | 983 | |
| 984 | Note that as an exception is propagated down the chain of callers, an |
| 985 | ``'exception'`` event is generated at each level. |
| 986 | |
| 987 | For more information on code and frame objects, refer to :ref:`types`. |
| 988 | |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 989 | .. impl-detail:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 990 | |
| 991 | The :func:`settrace` function is intended only for implementing debuggers, |
Georg Brandl | 495f7b5 | 2009-10-27 15:28:25 +0000 | [diff] [blame] | 992 | profilers, coverage tools and the like. Its behavior is part of the |
| 993 | implementation platform, rather than part of the language definition, and |
| 994 | thus may not be available in all Python implementations. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 995 | |
| 996 | |
| 997 | .. function:: settscdump(on_flag) |
| 998 | |
| 999 | Activate dumping of VM measurements using the Pentium timestamp counter, if |
| 1000 | *on_flag* is true. Deactivate these dumps if *on_flag* is off. The function is |
Éric Araujo | 713d303 | 2010-11-18 16:38:46 +0000 | [diff] [blame] | 1001 | available only if Python was compiled with ``--with-tsc``. To understand |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1002 | the output of this dump, read :file:`Python/ceval.c` in the Python sources. |
| 1003 | |
Benjamin Peterson | 21896a3 | 2010-03-21 22:03:03 +0000 | [diff] [blame] | 1004 | .. impl-detail:: |
| 1005 | This function is intimately bound to CPython implementation details and |
| 1006 | thus not likely to be implemented elsewhere. |
| 1007 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1008 | |
| 1009 | .. data:: stdin |
| 1010 | stdout |
| 1011 | stderr |
| 1012 | |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1013 | :term:`File objects <file object>` used by the interpreter for standard |
| 1014 | input, output and errors: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1015 | |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1016 | * ``stdin`` is used for all interactive input (including calls to |
| 1017 | :func:`input`); |
| 1018 | * ``stdout`` is used for the output of :func:`print` and :term:`expression` |
| 1019 | statements and for the prompts of :func:`input`; |
| 1020 | * The interpreter's own prompts and its error messages go to ``stderr``. |
| 1021 | |
| 1022 | By default, these streams are regular text streams as returned by the |
| 1023 | :func:`open` function. Their parameters are chosen as follows: |
| 1024 | |
| 1025 | * The character encoding is platform-dependent. Under Windows, if the stream |
| 1026 | is interactive (that is, if its :meth:`isatty` method returns True), the |
| 1027 | console codepage is used, otherwise the ANSI code page. Under other |
| 1028 | platforms, the locale encoding is used (see :meth:`locale.getpreferredencoding`). |
| 1029 | |
| 1030 | Under all platforms though, you can override this value by setting the |
| 1031 | :envvar:`PYTHONIOENCODING` environment variable. |
| 1032 | |
| 1033 | * When interactive, standard streams are line-buffered. Otherwise, they |
| 1034 | are block-buffered like regular text files. You can override this |
| 1035 | value with the :option:`-u` command-line option. |
| 1036 | |
| 1037 | To write or read binary data from/to the standard streams, use the |
| 1038 | underlying binary :data:`~io.TextIOBase.buffer`. For example, to write |
| 1039 | bytes to :data:`stdout`, use ``sys.stdout.buffer.write(b'abc')``. Using |
| 1040 | :meth:`io.TextIOBase.detach`, streams can be made binary by default. This |
Benjamin Peterson | 995bb47 | 2009-06-14 18:41:18 +0000 | [diff] [blame] | 1041 | function sets :data:`stdin` and :data:`stdout` to binary:: |
Benjamin Peterson | 4199d60 | 2009-05-12 20:47:57 +0000 | [diff] [blame] | 1042 | |
| 1043 | def make_streams_binary(): |
| 1044 | sys.stdin = sys.stdin.detach() |
Benjamin Peterson | 4487f53 | 2009-05-13 21:15:03 +0000 | [diff] [blame] | 1045 | sys.stdout = sys.stdout.detach() |
Benjamin Peterson | 995bb47 | 2009-06-14 18:41:18 +0000 | [diff] [blame] | 1046 | |
Antoine Pitrou | 7158e06 | 2011-12-15 16:25:34 +0100 | [diff] [blame] | 1047 | Note that the streams may be replaced with objects (like :class:`io.StringIO`) |
| 1048 | that do not support the :attr:`~io.BufferedIOBase.buffer` attribute or the |
Benjamin Peterson | 995bb47 | 2009-06-14 18:41:18 +0000 | [diff] [blame] | 1049 | :meth:`~io.BufferedIOBase.detach` method and can raise :exc:`AttributeError` |
| 1050 | or :exc:`io.UnsupportedOperation`. |
Benjamin Peterson | eb9fc52 | 2008-12-07 14:58:03 +0000 | [diff] [blame] | 1051 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1052 | |
| 1053 | .. data:: __stdin__ |
| 1054 | __stdout__ |
| 1055 | __stderr__ |
| 1056 | |
| 1057 | These objects contain the original values of ``stdin``, ``stderr`` and |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1058 | ``stdout`` at the start of the program. They are used during finalization, |
| 1059 | and could be useful to print to the actual standard stream no matter if the |
| 1060 | ``sys.std*`` object has been redirected. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1061 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1062 | It can also be used to restore the actual files to known working file objects |
| 1063 | in case they have been overwritten with a broken object. However, the |
| 1064 | preferred way to do this is to explicitly save the previous stream before |
| 1065 | replacing it, and restore the saved object. |
Christian Heimes | 58cb1b8 | 2007-11-13 02:19:40 +0000 | [diff] [blame] | 1066 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 1067 | .. note:: |
| 1068 | Under some conditions ``stdin``, ``stdout`` and ``stderr`` as well as the |
| 1069 | original values ``__stdin__``, ``__stdout__`` and ``__stderr__`` can be |
| 1070 | None. It is usually the case for Windows GUI apps that aren't connected |
| 1071 | to a console and Python apps started with :program:`pythonw`. |
Christian Heimes | 58cb1b8 | 2007-11-13 02:19:40 +0000 | [diff] [blame] | 1072 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1073 | |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 1074 | .. data:: thread_info |
| 1075 | |
| 1076 | A :term:`struct sequence` holding information about the thread |
| 1077 | implementation. |
| 1078 | |
| 1079 | +------------------+---------------------------------------------------------+ |
| 1080 | | Attribute | Explanation | |
| 1081 | +==================+=========================================================+ |
| 1082 | | :const:`name` | Name of the thread implementation: | |
| 1083 | | | | |
| 1084 | | | * ``'nt'``: Windows threads | |
| 1085 | | | * ``'os2'``: OS/2 threads | |
| 1086 | | | * ``'pthread'``: POSIX threads | |
| 1087 | | | * ``'solaris'``: Solaris threads | |
| 1088 | +------------------+---------------------------------------------------------+ |
| 1089 | | :const:`lock` | Name of the lock implementation: | |
| 1090 | | | | |
| 1091 | | | * ``'semaphore'``: a lock uses a semaphore | |
| 1092 | | | * ``'mutex+cond'``: a lock uses a mutex | |
| 1093 | | | and a condition variable | |
| 1094 | | | * ``None`` if this information is unknown | |
| 1095 | +------------------+---------------------------------------------------------+ |
| 1096 | | :const:`version` | Name and version of the thread library. It is a string, | |
| 1097 | | | or ``None`` if these informations are unknown. | |
| 1098 | +------------------+---------------------------------------------------------+ |
| 1099 | |
| 1100 | .. versionadded:: 3.3 |
| 1101 | |
| 1102 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1103 | .. data:: tracebacklimit |
| 1104 | |
| 1105 | When this variable is set to an integer value, it determines the maximum number |
| 1106 | of levels of traceback information printed when an unhandled exception occurs. |
| 1107 | The default is ``1000``. When set to ``0`` or less, all traceback information |
| 1108 | is suppressed and only the exception type and value are printed. |
| 1109 | |
| 1110 | |
| 1111 | .. data:: version |
| 1112 | |
| 1113 | A string containing the version number of the Python interpreter plus additional |
Georg Brandl | e42a59d | 2010-07-31 20:05:31 +0000 | [diff] [blame] | 1114 | information on the build number and compiler used. This string is displayed |
| 1115 | when the interactive interpreter is started. Do not extract version information |
| 1116 | out of it, rather, use :data:`version_info` and the functions provided by the |
| 1117 | :mod:`platform` module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1118 | |
| 1119 | |
| 1120 | .. data:: api_version |
| 1121 | |
| 1122 | The C API version for this interpreter. Programmers may find this useful when |
| 1123 | debugging version conflicts between Python and extension modules. |
| 1124 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1125 | |
| 1126 | .. data:: version_info |
| 1127 | |
| 1128 | A tuple containing the five components of the version number: *major*, *minor*, |
| 1129 | *micro*, *releaselevel*, and *serial*. All values except *releaselevel* are |
| 1130 | integers; the release level is ``'alpha'``, ``'beta'``, ``'candidate'``, or |
| 1131 | ``'final'``. The ``version_info`` value corresponding to the Python version 2.0 |
Eric Smith | 0e5b562 | 2009-02-06 01:32:42 +0000 | [diff] [blame] | 1132 | is ``(2, 0, 0, 'final', 0)``. The components can also be accessed by name, |
| 1133 | so ``sys.version_info[0]`` is equivalent to ``sys.version_info.major`` |
| 1134 | and so on. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1135 | |
Raymond Hettinger | 35a8836 | 2009-04-09 00:08:24 +0000 | [diff] [blame] | 1136 | .. versionchanged:: 3.1 |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 1137 | Added named component attributes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1138 | |
| 1139 | .. data:: warnoptions |
| 1140 | |
| 1141 | This is an implementation detail of the warnings framework; do not modify this |
| 1142 | value. Refer to the :mod:`warnings` module for more information on the warnings |
| 1143 | framework. |
| 1144 | |
| 1145 | |
| 1146 | .. data:: winver |
| 1147 | |
| 1148 | The version number used to form registry keys on Windows platforms. This is |
| 1149 | stored as string resource 1000 in the Python DLL. The value is normally the |
| 1150 | first three characters of :const:`version`. It is provided in the :mod:`sys` |
| 1151 | module for informational purposes; modifying this value has no effect on the |
| 1152 | registry keys used by Python. Availability: Windows. |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 1153 | |
Antoine Pitrou | 9583cac | 2010-10-21 13:42:28 +0000 | [diff] [blame] | 1154 | |
| 1155 | .. data:: _xoptions |
| 1156 | |
| 1157 | A dictionary of the various implementation-specific flags passed through |
| 1158 | the :option:`-X` command-line option. Option names are either mapped to |
| 1159 | their values, if given explicitly, or to :const:`True`. Example:: |
| 1160 | |
| 1161 | $ ./python -Xa=b -Xc |
| 1162 | Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50) |
| 1163 | [GCC 4.4.3] on linux2 |
| 1164 | Type "help", "copyright", "credits" or "license" for more information. |
| 1165 | >>> import sys |
| 1166 | >>> sys._xoptions |
| 1167 | {'a': 'b', 'c': True} |
| 1168 | |
| 1169 | .. impl-detail:: |
| 1170 | |
| 1171 | This is a CPython-specific way of accessing options passed through |
| 1172 | :option:`-X`. Other implementations may export them through other |
| 1173 | means, or not at all. |
| 1174 | |
| 1175 | .. versionadded:: 3.2 |
| 1176 | |
| 1177 | |
Mark Dickinson | be5846b | 2010-07-02 20:26:07 +0000 | [diff] [blame] | 1178 | .. rubric:: Citations |
| 1179 | |
| 1180 | .. [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 . |
| 1181 | |