Module sys

This module provides access to some objects used or maintained by the
interpreter and to functions that interact strongly with the interpreter.

Dynamic objects:

argv -- command line arguments; argv[0] is the script pathname if known
path -- module search path; path[0] is the script directory, else ''
modules -- dictionary of loaded modules

displayhook -- called to show results in an interactive session
excepthook -- called to handle any uncaught exception other than SystemExit
  To customize printing in an interactive session or to install a custom
  top-level exception handler, assign other functions to replace these.

exitfunc -- if sys.exitfunc exists, this routine is called when Python exits
  Assigning to sys.exitfunc is deprecated; use the atexit module instead.

stdin -- standard input file object; used by raw_input() and input()
stdout -- standard output file object; used by the print statement
stderr -- standard error object; used for error messages
  By assigning other file objects (or objects that behave like files)
  to these, it is possible to redirect all of the interpreter's I/O.

last_type -- type of last uncaught exception
last_value -- value of last uncaught exception
last_traceback -- traceback of last uncaught exception
  These three are only available in an interactive session after a
  traceback has been printed.

exc_type -- type of exception currently being handled
exc_value -- value of exception currently being handled
exc_traceback -- traceback of exception currently being handled
  The function exc_info() should be used instead of these three,
  because it is thread-safe.

Static objects:

float_info -- a dict with information about the float inplementation.
long_info -- a struct sequence with information about the long implementation.
maxint -- the largest supported integer (the smallest is -maxint-1)
maxsize -- the largest supported length of containers.
maxunicode -- the largest supported character
builtin_module_names -- tuple of module names built into this interpreter
version -- the version of this interpreter as a string
version_info -- version information as a named tuple
hexversion -- version information encoded as a single integer
copyright -- copyright notice pertaining to this interpreter
platform -- platform identifier
executable -- absolute path of the executable binary of the Python interpreter
prefix -- prefix used to find the Python library
exec_prefix -- prefix used to find the machine-specific Python library
float_repr_style -- string indicating the style of repr() output for floats
__stdin__ -- the original stdin; don't touch!
__stdout__ -- the original stdout; don't touch!
__stderr__ -- the original stderr; don't touch!
__displayhook__ -- the original displayhook; don't touch!
__excepthook__ -- the original excepthook; don't touch!

Functions:

displayhook() -- print an object to the screen, and save it in __builtin__._
excepthook() -- print an exception and its traceback to sys.stderr
exc_info() -- return thread-safe information about the current exception
exc_clear() -- clear the exception state for the current thread
exit() -- exit the interpreter by raising SystemExit
getdlopenflags() -- returns flags to be used for dlopen() calls
getprofile() -- get the global profiling function
getrefcount() -- return the reference count for an object (plus one :-)
getrecursionlimit() -- return the max recursion depth for the interpreter
getsizeof() -- return the size of an object in bytes
gettrace() -- get the global debug tracing function
setcheckinterval() -- control how often the interpreter checks for events
setdlopenflags() -- set the flags to be used for dlopen() calls
setprofile() -- set the global profiling function
setrecursionlimit() -- set the max recursion depth for the interpreter
settrace() -- set the global debug tracing function

Functions

[hide private]

None

__displayhook__(object)
Print an object to sys.stdout and also save it in __builtin__._

None

__excepthook__(exctype, value, traceback)
Handle an exception by displaying it with a traceback on sys.stderr.

None

_clear_type_cache()
Clear the internal type lookup cache.

dictionary

_current_frames()
Return a dictionary mapping each current thread T's thread id to T's current stack frame.

frameobject

_getframe(depth=...)
Return a frame object from the call stack.

object

call_tracing(func, args)
Call func(*args), while tracing is enabled.

tuple of integers

callstats()
Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built.

None

displayhook(object)
Print an object to sys.stdout and also save it in __builtin__._

None

exc_clear()
Clear global information on the current exception.

(type, value, traceback)

exc_info()
Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

None

excepthook(exctype, value, traceback)
Handle an exception by displaying it with a traceback on sys.stderr.

exit(status=...)
Exit the interpreter by raising SystemExit(status).

current check interval; see setcheckinterval().

getcheckinterval()

string

getdefaultencoding()
Return the current default string encoding used by the Unicode implementation.

int

getdlopenflags()
Return the current value of the flags that are used for dlopen calls.

string

getfilesystemencoding()
Return the encoding used to convert Unicode filenames in operating system filenames.

getprofile()
Return the profiling function set with sys.setprofile.

getrecursionlimit()
Return the current value of the recursion limit, the maximum depth of the Python interpreter stack.

integer

getrefcount(object)
Return the reference count of object.

int

getsizeof(object, default)
Return the size of object in bytes.

gettrace()
Return the global debug tracing function set with sys.settrace.

setcheckinterval(n)
Tell the Python interpreter to check for asynchronous events every n instructions.

None

setdlopenflags(n)
Set the flags used by the interpreter for dlopen calls, such as when the interpreter loads extension modules.

setprofile(function)
Set the profiling function.

setrecursionlimit(n)
Set the maximum depth of the Python interpreter stack to n.

settrace(function)
Set the global debug tracing function.

Variables

[hide private]

__package__ = None
hash(x)

__stderr__ = <open file '<stderr>', mode 'w' at 0x7f08187461e0>

__stdin__ = <open file '<stdin>', mode 'r' at 0x7f08187460c0>

__stdout__ = <open file '<stdout>', mode 'w' at 0x7f0818746150>

_git = ('CPython', 'v2.7.16', '413a491')

api_version = 1013

argv = ['/workspace/workspace/Docs/0/doc_src/src/nuke_epydoc.p...

builtin_module_names = ('__builtin__', '__main__', '_ast', '_c...

byteorder = 'little'

dont_write_bytecode = False

exc_type = None
hash(x)

exec_prefix = '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1...

executable = '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v...

flags = sys.flags(debug=0, py3k_warning=0, division_warning=0,...

float_info = sys.float_info(max=1.7976931348623157e+308, max_e...

float_repr_style = 'short'

hexversion = 34017520

long_info = sys.long_info(bits_per_digit=30, sizeof_digit=4)

maxint = 9223372036854775807

maxsize = 9223372036854775807

maxunicode = 1114111

meta_path = [<six._SixMetaPathImporter object at 0x7f07b00fb790>]

modules = {'CameraTrackerExport2_1': <module 'CameraTrackerExp...

path = [u'/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.58...

path_hooks = [<type 'zipimport.zipimporter'>]

path_importer_cache = {'': None, '/workspace/workspace/Docs/0/...

platform = 'linux2'

prefix = '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.58...

py3kwarning = False

pyside_uses_embedding = False

stderr = <open file '<stderr>', mode 'w' at 0x7f08187461e0>

stdin = <open file '<stdin>', mode 'r' at 0x7f08187460c0>

stdout = <open file '<stdout>', mode 'w' at 0x7f0818746150>

subversion = ('CPython', '', '')

version = '2.7.16 (v2.7.16:413a491, Aug 6 2019, 14:35:43) \n[...

version_info = sys.version_info(major=2, minor=7, micro=16, re...

warnoptions = []

Function Details

[hide private]

_current_frames()

Return a dictionary mapping each current thread T's thread id to T's current stack frame.

This function should be used for specialized purposes only.

Returns: dictionary

_getframe(depth=...)

Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack.

This function should be used for internal and specialized purposes only.

Returns: frameobject

call_tracing(func, args)

Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

Returns: object

callstats()

Return a tuple of function call statistics, if CALL_PROFILE was defined
when Python was built.  Otherwise, return None.

When enabled, this function returns detailed, implementation-specific
details about the number of function calls executed. The return value is
a 11-tuple where the entries in the tuple are counts of:
0. all function calls
1. calls to PyFunction_Type objects
2. PyFunction calls that do not create an argument tuple
3. PyFunction calls that do not create an argument tuple
   and bypass PyEval_EvalCodeEx()
4. PyMethod calls
5. PyMethod calls on bound methods
6. PyType calls
7. PyCFunction calls
8. generator calls
9. All other calls
10. Number of stack pops performed by call_function()

Returns: tuple of integers

exc_clear()

Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

Returns: None

exit(status=...)

Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is an integer, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

getdlopenflags()

Return the current value of the flags that are used for dlopen calls. The flag constants are defined in the ctypes and DLFCN modules.

Returns: int

getprofile()

Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

getrecursionlimit()

Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

getrefcount(object)

Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

Returns: integer

gettrace()

Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

setcheckinterval(n)

Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

setdlopenflags(n)

Set the flags used by the interpreter for dlopen calls, such as when the interpreter loads extension modules. Among other things, this will enable a lazy resolving of symbols when importing a module, if called as sys.setdlopenflags(0). To share symbols across extension modules, call as sys.setdlopenflags(ctypes.RTLD_GLOBAL). Symbolic names for the flag modules can be either found in the ctypes module, or in the DLFCN module. If DLFCN is not available, it can be generated from /usr/include/dlfcn.h using the h2py script.

Returns: None

setprofile(function)

Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

setrecursionlimit(n)

Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

settrace(function)

Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

Variables Details

[hide private]

argv

Value:

['/workspace/workspace/Docs/0/doc_src/src/nuke_epydoc.py',
 '--config',
 '/workspace/workspace/Docs/0/doc_src/src/nuke_epydoc.cfg',
 '-o',
 '/workspace/workspace/Docs/0/output/documentation/PythonReference',
 '--debug',
 '--simple-term']

builtin_module_names

Value:

('__builtin__',
 '__main__',
 '_ast',
 '_codecs',
 '_curveknob',
 '_curvelib',
 '_geo',
 '_localization',
...

copyright

Value:

'''Copyright (c) 2001-2019 Python Software Foundation.
All Rights Reserved.

Copyright (c) 2000 BeOpen.com.
All Rights Reserved.

Copyright (c) 1995-2001 Corporation for National Research Initiatives.
All Rights Reserved.
...

exec_prefix

Value:

'/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5-
release'

executable

Value:

'/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5-
release/Nuke12.1'

flags

Value:

sys.flags(debug=0, py3k_warning=0, division_warning=0, division_new=0,
 inspect=0, interactive=0, optimize=0, dont_write_bytecode=0, no_user_
site=0, no_site=0, ignore_environment=0, tabcheck=0, verbose=0, unicod
e=0, bytes_warning=0, hash_randomization=0)

float_info

Value:

sys.float_info(max=1.7976931348623157e+308, max_exp=1024, max_10_exp=3
08, min=2.2250738585072014e-308, min_exp=-1021, min_10_exp=-307, dig=1
5, mant_dig=53, epsilon=2.220446049250313e-16, radix=2, rounds=1)

modules

Value:

{'CameraTrackerExport2_1': <module 'CameraTrackerExport2_1' from '/wor
kspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5-relea
se/plugins/caravr/CameraTrackerExport2_1.pyc'>,
 'ColourMatcherExport2_1': <module 'ColourMatcherExport2_1' from '/wor
kspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5-relea
se/plugins/caravr/ColourMatcherExport2_1.pyc'>,
 'ConfigParser': <module 'ConfigParser' from '/workspace/workspace/Doc
s/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5-release/lib/python2.7/Con
...

path

Value:

[u'/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc
5-release/plugins',
 '/workspace/workspace/Docs/0/epydoc/bin',
 '/workspace/workspace/Docs/0/pydev_tmp/temp_home/.nuke',
 '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5
-release/plugins',
 '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5
-release/pythonextensions/site-packages',
...

path_importer_cache

Value:

{'': None,
 '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5
-release/lib/python2.7': None,
 '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5
-release/lib/python2.7/ctypes': None,
 '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5
-release/lib/python2.7/encodings': None,
 '/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5
...

prefix

Value:

'/workspace/workspace/Docs/0/bin/Nuke-12.1.112.1v1.582522-Release-rc5-
release'

version

Value:

'''2.7.16 (v2.7.16:413a491, Aug  6 2019, 14:35:43) 
[GCC 6.3.1 20170216 (Red Hat 6.3.1-3)]'''

version_info

Value:

sys.version_info(major=2, minor=7, micro=16, releaselevel='final', ser
ial=0)