summaryrefslogtreecommitdiffstats
path: root/Doc/libsys.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-05-07 01:49:07 (GMT)
committerFred Drake <fdrake@acm.org>1998-05-07 01:49:07 (GMT)
commitcda63cc875f54b047018cad362aa23d5493b97f3 (patch)
treef43f888293bb4046a7622dffefd561b669e993c2 /Doc/libsys.tex
parentbbe33c559403c7e06642111c494bd32d9abe528f (diff)
downloadcpython-cda63cc875f54b047018cad362aa23d5493b97f3.zip
cpython-cda63cc875f54b047018cad362aa23d5493b97f3.tar.gz
cpython-cda63cc875f54b047018cad362aa23d5493b97f3.tar.bz2
Relocating file to Doc/lib/
Diffstat (limited to 'Doc/libsys.tex')
-rw-r--r--Doc/libsys.tex249
1 files changed, 0 insertions, 249 deletions
diff --git a/Doc/libsys.tex b/Doc/libsys.tex
deleted file mode 100644
index 1dac264..0000000
--- a/Doc/libsys.tex
+++ /dev/null
@@ -1,249 +0,0 @@
-\section{Built-in Module \module{sys}}
-\label{module-sys}
-
-\bimodindex{sys}
-This module provides access to some variables used or maintained by the
-interpreter and to functions that interact strongly with the interpreter.
-It is always available.
-
-
-\begin{datadesc}{argv}
- The list of command line arguments passed to a Python script.
- \code{argv[0]} is the script name (it is operating system
- dependent whether this is a full pathname or not).
- If the command was executed using the \samp{-c} command line option
- to the interpreter, \code{argv[0]} is set to the string
- \code{"-c"}.
- If no script name was passed to the Python interpreter,
- \code{argv} has zero length.
-\end{datadesc}
-
-\begin{datadesc}{builtin_module_names}
- A tuple of strings giving the names of all modules that are compiled
- into this Python interpreter. (This information is not available in
- any other way --- \code{modules.keys()} only lists the imported
- modules.)
-\end{datadesc}
-
-\begin{funcdesc}{exc_info}{}
-This function returns a tuple of three values that give information
-about the exception that is currently being handled. The information
-returned is specific both to the current thread and to the current
-stack frame. If the current stack frame is not handling an exception,
-the information is taken from the calling stack frame, or its caller,
-and so on until a stack frame is found that is handling an exception.
-Here, ``handling an exception'' is defined as ``executing or having
-executed an except clause.'' For any stack frame, only
-information about the most recently handled exception is accessible.
-
-If no exception is being handled anywhere on the stack, a tuple
-containing three \code{None} values is returned. Otherwise, the
-values returned are
-\code{(\var{type}, \var{value}, \var{traceback})}.
-Their meaning is: \var{type} gets the exception type of the exception
-being handled (a string or class object); \var{value} gets the
-exception parameter (its \dfn{associated value} or the second argument
-to \keyword{raise}, which is always a class instance if the exception
-type is a class object); \var{traceback} gets a traceback object (see
-the Reference Manual) which encapsulates the call stack at the point
-where the exception originally occurred.
-\obindex{traceback}
-
-\strong{Warning:} assigning the \var{traceback} return value to a
-local variable in a function that is handling an exception will cause
-a circular reference. This will prevent anything referenced by a local
-variable in the same function or by the traceback from being garbage
-collected. Since most functions don't need access to the traceback,
-the best solution is to use something like
-\code{type, value = sys.exc_info()[:2]}
-to extract only the exception type and value. If you do need the
-traceback, make sure to delete it after use (best done with a
-\keyword{try} ... \keyword{finally} statement) or to call
-\function{exc_info()} in a function that does not itself handle an
-exception.
-\end{funcdesc}
-
-\begin{datadesc}{exc_type}
-\dataline{exc_value}
-\dataline{exc_traceback}
-\deprecated {1.5}
- {Use \function{exc_info()} instead.}
-Since they are global variables, they are not specific to the current
-thread, so their use is not safe in a multi-threaded program. When no
-exception is being handled, \code{exc_type} is set to \code{None} and
-the other two are undefined.
-\end{datadesc}
-
-\begin{datadesc}{exec_prefix}
-A string giving the site-specific
-directory prefix where the platform-dependent Python files are
-installed; by default, this is also \code{"/usr/local"}. This can be
-set at build time with the \code{-}\code{-exec-prefix} argument to the
-\program{configure} script. Specifically, all configuration files
-(e.g. the \file{config.h} header file) are installed in the directory
-\code{exec_prefix + "/lib/python\var{version}/config"}, and shared library
-modules are installed in
-\code{exec_prefix + "/lib/python\var{version}/lib-dynload"},
-where \var{version} is equal to \code{version[:3]}.
-\end{datadesc}
-
-\begin{funcdesc}{exit}{n}
- Exit from Python with numeric exit status \var{n}. This is
- implemented by raising the \exception{SystemExit} exception, so cleanup
- actions specified by finally clauses of \keyword{try} statements
- are honored, and it is possible to catch the exit attempt at an outer
- level.
-\end{funcdesc}
-
-\begin{datadesc}{exitfunc}
- This value is not actually defined by the module, but can be set by
- the user (or by a program) to specify a clean-up action at program
- exit. When set, it should be a parameterless function. This function
- will be called when the interpreter exits in any way (except when a
- fatal error occurs: in that case the interpreter's internal state
- cannot be trusted).
-\end{datadesc}
-
-\begin{funcdesc}{getrefcount}{object}
-Return the reference count of the \var{object}. The count returned is
-generally one higher than you might expect, because it includes the
-(temporary) reference as an argument to \code{getrefcount()}.
-\end{funcdesc}
-
-\begin{datadesc}{last_type}
-\dataline{last_value}
-\dataline{last_traceback}
-These three variables are not always defined; they are set when an
-exception is not handled and the interpreter prints an error message
-and a stack traceback. Their intended use is to allow an interactive
-user to import a debugger module and engage in post-mortem debugging
-without having to re-execute the command that caused the error.
-(Typical use is \samp{import pdb; pdb.pm()} to enter the post-mortem
-debugger; see the chapter ``The Python Debugger'' for more
-information.)
-\refstmodindex{pdb}
-
-The meaning of the variables is the same
-as that of the return values from \function{exc_info()} above.
-(Since there is only one interactive thread, thread-safety is not a
-concern for these variables, unlike for \code{exc_type} etc.)
-\end{datadesc}
-
-\begin{datadesc}{modules}
- This is a dictionary that maps module names to modules which have
- already been loaded. This can be manipulated to force reloading of
- modules and other tricks. Note that removing a module from this
- dictionary is \emph{not} the same as calling
- \function{reload()}\bifuncindex{reload} on the corresponding module
- object.
-\end{datadesc}
-
-\begin{datadesc}{path}
-\indexiii{module}{search}{path}
- A list of strings that specifies the search path for modules.
- Initialized from the environment variable \code{\$PYTHONPATH}, or an
- installation-dependent default.
-
-The first item of this list, \code{path[0]}, is the
-directory containing the script that was used to invoke the Python
-interpreter. If the script directory is not available (e.g. if the
-interpreter is invoked interactively or if the script is read from
-standard input), \code{path[0]} is the empty string, which directs
-Python to search modules in the current directory first. Notice that
-the script directory is inserted \emph{before} the entries inserted as
-a result of \code{\$PYTHONPATH}.
-\end{datadesc}
-
-\begin{datadesc}{platform}
-This string contains a platform identifier, e.g. \code{'sunos5'} or
-\code{'linux1'}. This can be used to append platform-specific
-components to \code{path}, for instance.
-\end{datadesc}
-
-\begin{datadesc}{prefix}
-A string giving the site-specific directory prefix where the platform
-independent Python files are installed; by default, this is the string
-\code{"/usr/local"}. This can be set at build time with the
-\code{-}\code{-prefix} argument to the \program{configure} script. The main
-collection of Python library modules is installed in the directory
-\code{prefix + "/lib/python\var{version}"} while the platform
-independent header files (all except \file{config.h}) are stored in
-\code{prefix + "/include/python\var{version}"},
-where \var{version} is equal to \code{version[:3]}.
-
-\end{datadesc}
-
-\begin{datadesc}{ps1}
-\dataline{ps2}
-\index{interpreter prompts}
-\index{prompts, interpreter}
- Strings specifying the primary and secondary prompt of the
- interpreter. These are only defined if the interpreter is in
- interactive mode. Their initial values in this case are
- \code{'>>> '} and \code{'... '}. If a non-string object is assigned
- to either variable, its \function{str()} is re-evaluated each time
- the interpreter prepares to read a new interactive command; this can
- be used to implement a dynamic prompt.
-\end{datadesc}
-
-\begin{funcdesc}{setcheckinterval}{interval}
-Set the interpreter's ``check interval''. This integer value
-determines how often the interpreter checks for periodic things such
-as thread switches and signal handlers. The default is \code{10}, meaning
-the check is performed every 10 Python virtual instructions. Setting
-it to a larger value may increase performance for programs using
-threads. Setting it to a value \code{<=} 0 checks every virtual instruction,
-maximizing responsiveness as well as overhead.
-\end{funcdesc}
-
-\begin{funcdesc}{settrace}{tracefunc}
- Set the system's trace function, which allows you to implement a
- Python source code debugger in Python. See section ``How It Works''
- in the chapter on the Python Debugger.
-\end{funcdesc}
-\index{trace function}
-\index{debugger}
-
-\begin{funcdesc}{setprofile}{profilefunc}
- Set the system's profile function, which allows you to implement a
- Python source code profiler in Python. See the chapter on the
- Python Profiler. The system's profile function
- is called similarly to the system's trace function (see
- \function{settrace()}), but it isn't called for each executed line of
- code (only on call and return and when an exception occurs). Also,
- its return value is not used, so it can just return \code{None}.
-\end{funcdesc}
-\index{profile function}
-\index{profiler}
-
-\begin{datadesc}{stdin}
-\dataline{stdout}
-\dataline{stderr}
- File objects corresponding to the interpreter's standard input,
- output and error streams. \code{stdin} is used for all
- interpreter input except for scripts but including calls to
- \function{input()}\bifuncindex{input} and
- \function{raw_input()}\bifuncindex{raw_input}. \code{stdout} is used
- for the output of \keyword{print} and expression statements and for the
- prompts of \function{input()} and \function{raw_input()}. The interpreter's
- own prompts and (almost all of) its error messages go to
- \code{stderr}. \code{stdout} and \code{stderr} needn't
- be built-in file objects: any object is acceptable as long as it has
- a \method{write()} method that takes a string argument. (Changing these
- objects doesn't affect the standard I/O streams of processes
- executed by \function{os.popen()}, \function{os.system()} or the
- \function{exec*()} family of functions in the \module{os} module.)
-\refstmodindex{os}
-\end{datadesc}
-
-\begin{datadesc}{tracebacklimit}
-When this variable is set to an integer value, it determines the
-maximum number of levels of traceback information printed when an
-unhandled exception occurs. The default is \code{1000}. When set to
-0 or less, all traceback information is suppressed and only the
-exception type and value are printed.
-\end{datadesc}
-
-\begin{datadesc}{version}
-A string containing the version number of the Python interpreter.
-\end{datadesc}