blob: b35460372fe3500490a95effdffab6c24b303817 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001
2:mod:`sys` --- System-specific parameters and functions
3=======================================================
4
5.. module:: sys
6 :synopsis: Access system-specific parameters and functions.
7
8
9This module provides access to some variables used or maintained by the
10interpreter and to functions that interact strongly with the interpreter. It is
11always available.
12
13
14.. data:: argv
15
16 The list of command line arguments passed to a Python script. ``argv[0]`` is the
17 script name (it is operating system dependent whether this is a full pathname or
18 not). If the command was executed using the :option:`-c` command line option to
19 the interpreter, ``argv[0]`` is set to the string ``'-c'``. If no script name
20 was passed to the Python interpreter, ``argv[0]`` is the empty string.
21
22 To loop over the standard input, or the list of files given on the
23 command line, see the :mod:`fileinput` module.
24
25
26.. data:: byteorder
27
28 An indicator of the native byte order. This will have the value ``'big'`` on
29 big-endian (most-significant byte first) platforms, and ``'little'`` on
30 little-endian (least-significant byte first) platforms.
31
Georg Brandl116aa622007-08-15 14:28:22 +000032
33.. data:: subversion
34
35 A triple (repo, branch, version) representing the Subversion information of the
36 Python interpreter. *repo* is the name of the repository, ``'CPython'``.
37 *branch* is a string of one of the forms ``'trunk'``, ``'branches/name'`` or
38 ``'tags/name'``. *version* is the output of ``svnversion``, if the interpreter
39 was built from a Subversion checkout; it contains the revision number (range)
40 and possibly a trailing 'M' if there were local modifications. If the tree was
41 exported (or svnversion was not available), it is the revision of
42 ``Include/patchlevel.h`` if the branch is a tag. Otherwise, it is ``None``.
43
Georg Brandl116aa622007-08-15 14:28:22 +000044
45.. data:: builtin_module_names
46
47 A tuple of strings giving the names of all modules that are compiled into this
48 Python interpreter. (This information is not available in any other way ---
49 ``modules.keys()`` only lists the imported modules.)
50
51
52.. data:: copyright
53
54 A string containing the copyright pertaining to the Python interpreter.
55
56
Christian Heimes15ebc882008-02-04 18:48:49 +000057.. function:: _compact_freelists()
Christian Heimes26855632008-01-27 23:50:43 +000058
Christian Heimes15ebc882008-02-04 18:48:49 +000059 Compact the free list of floats by deallocating unused blocks.
60 It can reduce the memory usage of the Python process several tenth of
61 thousands of integers or floats have been allocated at once.
62
63 The return value is a tuple of tuples each containing three elements,
64 amount of used objects, total block count before the blocks are deallocated
65 and amount of freed blocks.
66
67 This function should be used for specialized purposes only.
68
Christian Heimes15ebc882008-02-04 18:48:49 +000069
70.. function:: _clear_type_cache()
71
72 Clear the internal type cache. The type cache is used to speed up attribute
73 and method lookups. Use the function *only* to drop unnecessary references
74 during reference leak debugging.
75
76 This function should be used for internal and specialized purposes only.
Christian Heimes26855632008-01-27 23:50:43 +000077
Christian Heimes26855632008-01-27 23:50:43 +000078
Georg Brandl116aa622007-08-15 14:28:22 +000079.. function:: _current_frames()
80
81 Return a dictionary mapping each thread's identifier to the topmost stack frame
82 currently active in that thread at the time the function is called. Note that
83 functions in the :mod:`traceback` module can build the call stack given such a
84 frame.
85
86 This is most useful for debugging deadlock: this function does not require the
87 deadlocked threads' cooperation, and such threads' call stacks are frozen for as
88 long as they remain deadlocked. The frame returned for a non-deadlocked thread
89 may bear no relationship to that thread's current activity by the time calling
90 code examines the frame.
91
92 This function should be used for internal and specialized purposes only.
93
Georg Brandl116aa622007-08-15 14:28:22 +000094
95.. data:: dllhandle
96
97 Integer specifying the handle of the Python DLL. Availability: Windows.
98
99
100.. function:: displayhook(value)
101
102 If *value* is not ``None``, this function prints it to ``sys.stdout``, and saves
Georg Brandl1a3284e2007-12-02 09:40:06 +0000103 it in ``builtins._``.
Georg Brandl116aa622007-08-15 14:28:22 +0000104
Christian Heimesd8654cf2007-12-02 15:22:16 +0000105 ``sys.displayhook`` is called on the result of evaluating an :term:`expression`
106 entered in an interactive Python session. The display of these values can be
107 customized by assigning another one-argument function to ``sys.displayhook``.
Georg Brandl116aa622007-08-15 14:28:22 +0000108
109
110.. function:: excepthook(type, value, traceback)
111
112 This function prints out a given traceback and exception to ``sys.stderr``.
113
114 When an exception is raised and uncaught, the interpreter calls
115 ``sys.excepthook`` with three arguments, the exception class, exception
116 instance, and a traceback object. In an interactive session this happens just
117 before control is returned to the prompt; in a Python program this happens just
118 before the program exits. The handling of such top-level exceptions can be
119 customized by assigning another three-argument function to ``sys.excepthook``.
120
121
122.. data:: __displayhook__
123 __excepthook__
124
125 These objects contain the original values of ``displayhook`` and ``excepthook``
126 at the start of the program. They are saved so that ``displayhook`` and
127 ``excepthook`` can be restored in case they happen to get replaced with broken
128 objects.
129
130
131.. function:: exc_info()
132
133 This function returns a tuple of three values that give information about the
134 exception that is currently being handled. The information returned is specific
135 both to the current thread and to the current stack frame. If the current stack
136 frame is not handling an exception, the information is taken from the calling
137 stack frame, or its caller, and so on until a stack frame is found that is
138 handling an exception. Here, "handling an exception" is defined as "executing
139 or having executed an except clause." For any stack frame, only information
140 about the most recently handled exception is accessible.
141
142 .. index:: object: traceback
143
144 If no exception is being handled anywhere on the stack, a tuple containing three
145 ``None`` values is returned. Otherwise, the values returned are ``(type, value,
146 traceback)``. Their meaning is: *type* gets the exception type of the exception
147 being handled (a class object); *value* gets the exception parameter (its
148 :dfn:`associated value` or the second argument to :keyword:`raise`, which is
149 always a class instance if the exception type is a class object); *traceback*
150 gets a traceback object (see the Reference Manual) which encapsulates the call
151 stack at the point where the exception originally occurred.
152
153 .. warning::
154
Georg Brandle6bcc912008-05-12 18:05:20 +0000155 Assigning the *traceback* return value to a local variable in a function
156 that is handling an exception will cause a circular reference. Since most
157 functions don't need access to the traceback, the best solution is to use
158 something like ``exctype, value = sys.exc_info()[:2]`` to extract only the
159 exception type and value. If you do need the traceback, make sure to
160 delete it after use (best done with a :keyword:`try`
161 ... :keyword:`finally` statement) or to call :func:`exc_info` in a
162 function that does not itself handle an exception.
Georg Brandl116aa622007-08-15 14:28:22 +0000163
Georg Brandle6bcc912008-05-12 18:05:20 +0000164 Such cycles are normally automatically reclaimed when garbage collection
165 is enabled and they become unreachable, but it remains more efficient to
166 avoid creating cycles.
Georg Brandl116aa622007-08-15 14:28:22 +0000167
168
169.. data:: exec_prefix
170
171 A string giving the site-specific directory prefix where the platform-dependent
172 Python files are installed; by default, this is also ``'/usr/local'``. This can
173 be set at build time with the :option:`--exec-prefix` argument to the
174 :program:`configure` script. Specifically, all configuration files (e.g. the
175 :file:`pyconfig.h` header file) are installed in the directory ``exec_prefix +
176 '/lib/pythonversion/config'``, and shared library modules are installed in
177 ``exec_prefix + '/lib/pythonversion/lib-dynload'``, where *version* is equal to
178 ``version[:3]``.
179
180
181.. data:: executable
182
183 A string giving the name of the executable binary for the Python interpreter, on
184 systems where this makes sense.
185
186
187.. function:: exit([arg])
188
189 Exit from Python. This is implemented by raising the :exc:`SystemExit`
190 exception, so cleanup actions specified by finally clauses of :keyword:`try`
191 statements are honored, and it is possible to intercept the exit attempt at an
192 outer level. The optional argument *arg* can be an integer giving the exit
193 status (defaulting to zero), or another type of object. If it is an integer,
194 zero is considered "successful termination" and any nonzero value is considered
195 "abnormal termination" by shells and the like. Most systems require it to be in
196 the range 0-127, and produce undefined results otherwise. Some systems have a
197 convention for assigning specific meanings to specific exit codes, but these are
198 generally underdeveloped; Unix programs generally use 2 for command line syntax
199 errors and 1 for all other kind of errors. If another type of object is passed,
200 ``None`` is equivalent to passing zero, and any other object is printed to
201 ``sys.stderr`` and results in an exit code of 1. In particular,
202 ``sys.exit("some error message")`` is a quick way to exit a program when an
203 error occurs.
204
205
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000206.. data:: flags
207
208 The struct sequence *flags* exposes the status of command line flags. The
209 attributes are read only.
210
211 +------------------------------+------------------------------------------+
212 | attribute | flag |
213 +==============================+==========================================+
214 | :const:`debug` | -d |
215 +------------------------------+------------------------------------------+
216 | :const:`py3k_warning` | -3 |
217 +------------------------------+------------------------------------------+
218 | :const:`division_warning` | -Q |
219 +------------------------------+------------------------------------------+
220 | :const:`division_new` | -Qnew |
221 +------------------------------+------------------------------------------+
222 | :const:`inspect` | -i |
223 +------------------------------+------------------------------------------+
224 | :const:`interactive` | -i |
225 +------------------------------+------------------------------------------+
226 | :const:`optimize` | -O or -OO |
227 +------------------------------+------------------------------------------+
228 | :const:`dont_write_bytecode` | -B |
229 +------------------------------+------------------------------------------+
230 | :const:`no_site` | -S |
231 +------------------------------+------------------------------------------+
Guido van Rossum7736b5b2008-01-15 21:44:53 +0000232 | :const:`ignore_environment` | -E |
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000233 +------------------------------+------------------------------------------+
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000234 | :const:`verbose` | -v |
235 +------------------------------+------------------------------------------+
236 | :const:`unicode` | -U |
237 +------------------------------+------------------------------------------+
238
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000239
Christian Heimes93852662007-12-01 12:22:32 +0000240.. data:: float_info
241
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000242 A structseq holding information about the float type. It contains low level
Christian Heimes93852662007-12-01 12:22:32 +0000243 information about the precision and internal representation. Please study
244 your system's :file:`float.h` for more information.
245
246 +---------------------+--------------------------------------------------+
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000247 | attribute | explanation |
Christian Heimes93852662007-12-01 12:22:32 +0000248 +=====================+==================================================+
249 | :const:`epsilon` | Difference between 1 and the next representable |
250 | | floating point number |
251 +---------------------+--------------------------------------------------+
252 | :const:`dig` | digits (see :file:`float.h`) |
253 +---------------------+--------------------------------------------------+
254 | :const:`mant_dig` | mantissa digits (see :file:`float.h`) |
255 +---------------------+--------------------------------------------------+
256 | :const:`max` | maximum representable finite float |
257 +---------------------+--------------------------------------------------+
258 | :const:`max_exp` | maximum int e such that radix**(e-1) is in the |
259 | | range of finite representable floats |
260 +---------------------+--------------------------------------------------+
261 | :const:`max_10_exp` | maximum int e such that 10**e is in the |
262 | | range of finite representable floats |
263 +---------------------+--------------------------------------------------+
264 | :const:`min` | Minimum positive normalizer float |
265 +---------------------+--------------------------------------------------+
266 | :const:`min_exp` | minimum int e such that radix**(e-1) is a |
267 | | normalized float |
268 +---------------------+--------------------------------------------------+
269 | :const:`min_10_exp` | minimum int e such that 10**e is a normalized |
270 | | float |
271 +---------------------+--------------------------------------------------+
272 | :const:`radix` | radix of exponent |
273 +---------------------+--------------------------------------------------+
274 | :const:`rounds` | addition rounds (see :file:`float.h`) |
275 +---------------------+--------------------------------------------------+
276
277 .. note::
278
279 The information in the table is simplified.
280
281
Georg Brandl116aa622007-08-15 14:28:22 +0000282.. function:: getcheckinterval()
283
284 Return the interpreter's "check interval"; see :func:`setcheckinterval`.
285
Georg Brandl116aa622007-08-15 14:28:22 +0000286
287.. function:: getdefaultencoding()
288
289 Return the name of the current default string encoding used by the Unicode
290 implementation.
291
Georg Brandl116aa622007-08-15 14:28:22 +0000292
293.. function:: getdlopenflags()
294
295 Return the current value of the flags that are used for :cfunc:`dlopen` calls.
Neal Norwitz6cf49cf2008-03-24 06:22:57 +0000296 The flag constants are defined in the :mod:`ctypes` and :mod:`DLFCN` modules.
Georg Brandl116aa622007-08-15 14:28:22 +0000297 Availability: Unix.
298
Georg Brandl116aa622007-08-15 14:28:22 +0000299
300.. function:: getfilesystemencoding()
301
302 Return the name of the encoding used to convert Unicode filenames into system
303 file names, or ``None`` if the system default encoding is used. The result value
304 depends on the operating system:
305
306 * On Windows 9x, the encoding is "mbcs".
307
308 * On Mac OS X, the encoding is "utf-8".
309
310 * On Unix, the encoding is the user's preference according to the result of
311 nl_langinfo(CODESET), or :const:`None` if the ``nl_langinfo(CODESET)`` failed.
312
313 * On Windows NT+, file names are Unicode natively, so no conversion is
314 performed. :func:`getfilesystemencoding` still returns ``'mbcs'``, as this is
315 the encoding that applications should use when they explicitly want to convert
316 Unicode strings to byte strings that are equivalent when used as file names.
317
Georg Brandl116aa622007-08-15 14:28:22 +0000318
319.. function:: getrefcount(object)
320
321 Return the reference count of the *object*. The count returned is generally one
322 higher than you might expect, because it includes the (temporary) reference as
323 an argument to :func:`getrefcount`.
324
325
326.. function:: getrecursionlimit()
327
328 Return the current value of the recursion limit, the maximum depth of the Python
329 interpreter stack. This limit prevents infinite recursion from causing an
330 overflow of the C stack and crashing Python. It can be set by
331 :func:`setrecursionlimit`.
332
333
334.. function:: _getframe([depth])
335
336 Return a frame object from the call stack. If optional integer *depth* is
337 given, return the frame object that many calls below the top of the stack. If
338 that is deeper than the call stack, :exc:`ValueError` is raised. The default
339 for *depth* is zero, returning the frame at the top of the call stack.
340
341 This function should be used for internal and specialized purposes only.
342
343
Christian Heimes9bd667a2008-01-20 15:14:11 +0000344.. function:: getprofile()
345
346 .. index::
347 single: profile function
348 single: profiler
349
350 Get the profiler function as set by :func:`setprofile`.
351
Christian Heimes9bd667a2008-01-20 15:14:11 +0000352
353.. function:: gettrace()
354
355 .. index::
356 single: trace function
357 single: debugger
358
359 Get the trace function as set by :func:`settrace`.
360
361 .. note::
362
363 The :func:`gettrace` function is intended only for implementing debuggers,
364 profilers, coverage tools and the like. Its behavior is part of the
365 implementation platform, rather than part of the language definition,
366 and thus may not be available in all Python implementations.
367
Christian Heimes9bd667a2008-01-20 15:14:11 +0000368
Georg Brandl116aa622007-08-15 14:28:22 +0000369.. function:: getwindowsversion()
370
371 Return a tuple containing five components, describing the Windows version
372 currently running. The elements are *major*, *minor*, *build*, *platform*, and
373 *text*. *text* contains a string while all other values are integers.
374
375 *platform* may be one of the following values:
376
Christian Heimes81ee3ef2008-05-04 22:42:01 +0000377 +-----------------------------------------+-------------------------+
378 | Constant | Platform |
379 +=========================================+=========================+
380 | :const:`0 (VER_PLATFORM_WIN32s)` | Win32s on Windows 3.1 |
381 +-----------------------------------------+-------------------------+
382 | :const:`1 (VER_PLATFORM_WIN32_WINDOWS)` | Windows 95/98/ME |
383 +-----------------------------------------+-------------------------+
384 | :const:`2 (VER_PLATFORM_WIN32_NT)` | Windows NT/2000/XP/x64 |
385 +-----------------------------------------+-------------------------+
386 | :const:`3 (VER_PLATFORM_WIN32_CE)` | Windows CE |
387 +-----------------------------------------+-------------------------+
Georg Brandl116aa622007-08-15 14:28:22 +0000388
389 This function wraps the Win32 :cfunc:`GetVersionEx` function; see the Microsoft
390 documentation for more information about these fields.
391
392 Availability: Windows.
393
Georg Brandl116aa622007-08-15 14:28:22 +0000394
395.. data:: hexversion
396
397 The version number encoded as a single integer. This is guaranteed to increase
398 with each version, including proper support for non-production releases. For
399 example, to test that the Python interpreter is at least version 1.5.2, use::
400
401 if sys.hexversion >= 0x010502F0:
402 # use some advanced feature
403 ...
404 else:
405 # use an alternative implementation or warn the user
406 ...
407
408 This is called ``hexversion`` since it only really looks meaningful when viewed
409 as the result of passing it to the built-in :func:`hex` function. The
410 ``version_info`` value may be used for a more human-friendly encoding of the
411 same information.
412
Georg Brandl116aa622007-08-15 14:28:22 +0000413
414.. function:: intern(string)
415
416 Enter *string* in the table of "interned" strings and return the interned string
417 -- which is *string* itself or a copy. Interning strings is useful to gain a
418 little performance on dictionary lookup -- if the keys in a dictionary are
419 interned, and the lookup key is interned, the key comparisons (after hashing)
420 can be done by a pointer compare instead of a string compare. Normally, the
421 names used in Python programs are automatically interned, and the dictionaries
422 used to hold module, class or instance attributes have interned keys.
423
Georg Brandl55ac8f02007-09-01 13:51:09 +0000424 Interned strings are not immortal; you must keep a reference to the return
425 value of :func:`intern` around to benefit from it.
Georg Brandl116aa622007-08-15 14:28:22 +0000426
427
428.. data:: last_type
429 last_value
430 last_traceback
431
432 These three variables are not always defined; they are set when an exception is
433 not handled and the interpreter prints an error message and a stack traceback.
434 Their intended use is to allow an interactive user to import a debugger module
435 and engage in post-mortem debugging without having to re-execute the command
436 that caused the error. (Typical use is ``import pdb; pdb.pm()`` to enter the
437 post-mortem debugger; see chapter :ref:`debugger` for
438 more information.)
439
440 The meaning of the variables is the same as that of the return values from
441 :func:`exc_info` above. (Since there is only one interactive thread,
442 thread-safety is not a concern for these variables, unlike for ``exc_type``
443 etc.)
444
445
Christian Heimesa37d4c62007-12-04 23:02:19 +0000446.. data:: maxsize
Georg Brandl116aa622007-08-15 14:28:22 +0000447
Georg Brandl33770552007-12-15 09:55:35 +0000448 An integer giving the maximum value a variable of type :ctype:`Py_ssize_t` can
449 take. It's usually ``2**31 - 1`` on a 32-bit platform and ``2**63 - 1`` on a
450 64-bit platform.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000451
Georg Brandl116aa622007-08-15 14:28:22 +0000452
453.. data:: maxunicode
454
455 An integer giving the largest supported code point for a Unicode character. The
456 value of this depends on the configuration option that specifies whether Unicode
457 characters are stored as UCS-2 or UCS-4.
458
459
460.. data:: modules
461
462 This is a dictionary that maps module names to modules which have already been
463 loaded. This can be manipulated to force reloading of modules and other tricks.
464
465
466.. data:: path
467
468 .. index:: triple: module; search; path
469
470 A list of strings that specifies the search path for modules. Initialized from
471 the environment variable :envvar:`PYTHONPATH`, plus an installation-dependent
472 default.
473
474 As initialized upon program startup, the first item of this list, ``path[0]``,
475 is the directory containing the script that was used to invoke the Python
476 interpreter. If the script directory is not available (e.g. if the interpreter
477 is invoked interactively or if the script is read from standard input),
478 ``path[0]`` is the empty string, which directs Python to search modules in the
479 current directory first. Notice that the script directory is inserted *before*
480 the entries inserted as a result of :envvar:`PYTHONPATH`.
481
482 A program is free to modify this list for its own purposes.
483
Georg Brandl116aa622007-08-15 14:28:22 +0000484
485.. data:: platform
486
Christian Heimes9bd667a2008-01-20 15:14:11 +0000487 This string contains a platform identifier that can be used to append
488 platform-specific components to :data:`sys.path`, for instance.
489
490 For Unix systems, this is the lowercased OS name as returned by ``uname -s``
491 with the first part of the version as returned by ``uname -r`` appended,
492 e.g. ``'sunos5'`` or ``'linux2'``, *at the time when Python was built*.
493 For other systems, the values are:
494
495 ================ ===========================
496 System :data:`platform` value
497 ================ ===========================
498 Windows ``'win32'``
499 Windows/Cygwin ``'cygwin'``
500 MacOS X ``'darwin'``
501 MacOS 9 ``'mac'``
502 OS/2 ``'os2'``
503 OS/2 EMX ``'os2emx'``
504 RiscOS ``'riscos'``
505 AtheOS ``'atheos'``
506 ================ ===========================
Georg Brandl116aa622007-08-15 14:28:22 +0000507
508
509.. data:: prefix
510
511 A string giving the site-specific directory prefix where the platform
512 independent Python files are installed; by default, this is the string
513 ``'/usr/local'``. This can be set at build time with the :option:`--prefix`
514 argument to the :program:`configure` script. The main collection of Python
515 library modules is installed in the directory ``prefix + '/lib/pythonversion'``
516 while the platform independent header files (all except :file:`pyconfig.h`) are
517 stored in ``prefix + '/include/pythonversion'``, where *version* is equal to
518 ``version[:3]``.
519
520
521.. data:: ps1
522 ps2
523
524 .. index::
525 single: interpreter prompts
526 single: prompts, interpreter
527
528 Strings specifying the primary and secondary prompt of the interpreter. These
529 are only defined if the interpreter is in interactive mode. Their initial
530 values in this case are ``'>>> '`` and ``'... '``. If a non-string object is
531 assigned to either variable, its :func:`str` is re-evaluated each time the
532 interpreter prepares to read a new interactive command; this can be used to
533 implement a dynamic prompt.
534
535
Christian Heimes790c8232008-01-07 21:14:23 +0000536.. data:: dont_write_bytecode
537
538 If this is true, Python won't try to write ``.pyc`` or ``.pyo`` files on the
539 import of source modules. This value is initially set to ``True`` or ``False``
540 depending on the ``-B`` command line option and the ``PYTHONDONTWRITEBYTECODE``
541 environment variable, but you can set it yourself to control bytecode file
542 generation.
543
Christian Heimes790c8232008-01-07 21:14:23 +0000544
Georg Brandl116aa622007-08-15 14:28:22 +0000545.. function:: setcheckinterval(interval)
546
547 Set the interpreter's "check interval". This integer value determines how often
548 the interpreter checks for periodic things such as thread switches and signal
549 handlers. The default is ``100``, meaning the check is performed every 100
550 Python virtual instructions. Setting it to a larger value may increase
551 performance for programs using threads. Setting it to a value ``<=`` 0 checks
552 every virtual instruction, maximizing responsiveness as well as overhead.
553
554
555.. function:: setdefaultencoding(name)
556
557 Set the current default string encoding used by the Unicode implementation. If
558 *name* does not match any available encoding, :exc:`LookupError` is raised.
559 This function is only intended to be used by the :mod:`site` module
560 implementation and, where needed, by :mod:`sitecustomize`. Once used by the
561 :mod:`site` module, it is removed from the :mod:`sys` module's namespace.
562
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000563 .. Note that :mod:`site` is not imported if the :option:`-S` option is passed
564 to the interpreter, in which case this function will remain available.
Georg Brandl116aa622007-08-15 14:28:22 +0000565
Georg Brandl116aa622007-08-15 14:28:22 +0000566
567.. function:: setdlopenflags(n)
568
569 Set the flags used by the interpreter for :cfunc:`dlopen` calls, such as when
570 the interpreter loads extension modules. Among other things, this will enable a
571 lazy resolving of symbols when importing a module, if called as
572 ``sys.setdlopenflags(0)``. To share symbols across extension modules, call as
Neal Norwitz6cf49cf2008-03-24 06:22:57 +0000573 ``sys.setdlopenflags(ctypes.RTLD_GLOBAL)``. Symbolic names for the
574 flag modules can be either found in the :mod:`ctypes` module, or in the :mod:`DLFCN`
Georg Brandl116aa622007-08-15 14:28:22 +0000575 module. If :mod:`DLFCN` is not available, it can be generated from
576 :file:`/usr/include/dlfcn.h` using the :program:`h2py` script. Availability:
577 Unix.
578
Georg Brandl116aa622007-08-15 14:28:22 +0000579
580.. function:: setprofile(profilefunc)
581
582 .. index::
583 single: profile function
584 single: profiler
585
586 Set the system's profile function, which allows you to implement a Python source
587 code profiler in Python. See chapter :ref:`profile` for more information on the
588 Python profiler. The system's profile function is called similarly to the
589 system's trace function (see :func:`settrace`), but it isn't called for each
590 executed line of code (only on call and return, but the return event is reported
591 even when an exception has been set). The function is thread-specific, but
592 there is no way for the profiler to know about context switches between threads,
593 so it does not make sense to use this in the presence of multiple threads. Also,
594 its return value is not used, so it can simply return ``None``.
595
596
597.. function:: setrecursionlimit(limit)
598
599 Set the maximum depth of the Python interpreter stack to *limit*. This limit
600 prevents infinite recursion from causing an overflow of the C stack and crashing
601 Python.
602
603 The highest possible limit is platform-dependent. A user may need to set the
604 limit higher when she has a program that requires deep recursion and a platform
605 that supports a higher limit. This should be done with care, because a too-high
606 limit can lead to a crash.
607
608
609.. function:: settrace(tracefunc)
610
611 .. index::
612 single: trace function
613 single: debugger
614
615 Set the system's trace function, which allows you to implement a Python
616 source code debugger in Python. See section :ref:`debugger-hooks` in the
617 chapter on the Python debugger. The function is thread-specific; for a
618 debugger to support multiple threads, it must be registered using
619 :func:`settrace` for each thread being debugged.
620
621 .. note::
622
623 The :func:`settrace` function is intended only for implementing debuggers,
624 profilers, coverage tools and the like. Its behavior is part of the
625 implementation platform, rather than part of the language definition, and thus
626 may not be available in all Python implementations.
627
628
629.. function:: settscdump(on_flag)
630
631 Activate dumping of VM measurements using the Pentium timestamp counter, if
632 *on_flag* is true. Deactivate these dumps if *on_flag* is off. The function is
633 available only if Python was compiled with :option:`--with-tsc`. To understand
634 the output of this dump, read :file:`Python/ceval.c` in the Python sources.
635
Georg Brandl116aa622007-08-15 14:28:22 +0000636
637.. data:: stdin
638 stdout
639 stderr
640
641 File objects corresponding to the interpreter's standard input, output and error
Christian Heimesd8654cf2007-12-02 15:22:16 +0000642 streams. ``stdin`` is used for all interpreter input except for scripts but
643 including calls to :func:`input`. ``stdout`` is used for
644 the output of :func:`print` and :term:`expression` statements and for the
645 prompts of :func:`input`. The interpreter's own prompts
646 and (almost all of) its error messages go to ``stderr``. ``stdout`` and
647 ``stderr`` needn't be built-in file objects: any object is acceptable as long
648 as it has a :meth:`write` method that takes a string argument. (Changing these
649 objects doesn't affect the standard I/O streams of processes executed by
650 :func:`os.popen`, :func:`os.system` or the :func:`exec\*` family of functions in
651 the :mod:`os` module.)
Georg Brandl116aa622007-08-15 14:28:22 +0000652
653
654.. data:: __stdin__
655 __stdout__
656 __stderr__
657
658 These objects contain the original values of ``stdin``, ``stderr`` and
659 ``stdout`` at the start of the program. They are used during finalization, and
660 could be useful to restore the actual files to known working file objects in
661 case they have been overwritten with a broken object.
662
Christian Heimes58cb1b82007-11-13 02:19:40 +0000663 .. note::
664
665 Under some conditions ``stdin``, ``stdout`` and ``stderr`` as well as the
666 original values ``__stdin__``, ``__stdout__`` and ``__stderr__`` can be
667 None. It is usually the case for Windows GUI apps that aren't connected to
668 a console and Python apps started with :program:`pythonw`.
669
Georg Brandl116aa622007-08-15 14:28:22 +0000670
671.. data:: tracebacklimit
672
673 When this variable is set to an integer value, it determines the maximum number
674 of levels of traceback information printed when an unhandled exception occurs.
675 The default is ``1000``. When set to ``0`` or less, all traceback information
676 is suppressed and only the exception type and value are printed.
677
678
679.. data:: version
680
681 A string containing the version number of the Python interpreter plus additional
682 information on the build number and compiler used. It has a value of the form
683 ``'version (#build_number, build_date, build_time) [compiler]'``. The first
684 three characters are used to identify the version in the installation
685 directories (where appropriate on each platform). An example::
686
687 >>> import sys
688 >>> sys.version
689 '1.5.2 (#0 Apr 13 1999, 10:51:12) [MSC 32 bit (Intel)]'
690
691
692.. data:: api_version
693
694 The C API version for this interpreter. Programmers may find this useful when
695 debugging version conflicts between Python and extension modules.
696
Georg Brandl116aa622007-08-15 14:28:22 +0000697
698.. data:: version_info
699
700 A tuple containing the five components of the version number: *major*, *minor*,
701 *micro*, *releaselevel*, and *serial*. All values except *releaselevel* are
702 integers; the release level is ``'alpha'``, ``'beta'``, ``'candidate'``, or
703 ``'final'``. The ``version_info`` value corresponding to the Python version 2.0
704 is ``(2, 0, 0, 'final', 0)``.
705
Georg Brandl116aa622007-08-15 14:28:22 +0000706
707.. data:: warnoptions
708
709 This is an implementation detail of the warnings framework; do not modify this
710 value. Refer to the :mod:`warnings` module for more information on the warnings
711 framework.
712
713
714.. data:: winver
715
716 The version number used to form registry keys on Windows platforms. This is
717 stored as string resource 1000 in the Python DLL. The value is normally the
718 first three characters of :const:`version`. It is provided in the :mod:`sys`
719 module for informational purposes; modifying this value has no effect on the
720 registry keys used by Python. Availability: Windows.
721
722
723.. seealso::
724
725 Module :mod:`site`
726 This describes how to use .pth files to extend ``sys.path``.
727
Christian Heimes58cb1b82007-11-13 02:19:40 +0000728