Name	Size	Mode	Actions
abstract.rst.txt	702	0644	editdlrm
allocation.rst.txt	4796	0644	editdlrm
arg.rst.txt	26004	0644	editdlrm
bool.rst.txt	1304	0644	editdlrm
buffer.rst.txt	22965	0644	editdlrm
bytearray.rst.txt	2181	0644	editdlrm
capsule.rst.txt	5741	0644	editdlrm
cell.rst.txt	1940	0644	editdlrm
class.rst.txt	1866	0644	editdlrm
cobject.rst.txt	1870	0644	editdlrm
code.rst.txt	1635	0644	editdlrm
codec.rst.txt	4643	0644	editdlrm
complex.rst.txt	4079	0644	editdlrm
concrete.rst.txt	1963	0644	editdlrm
conversion.rst.txt	7092	0644	editdlrm
datetime.rst.txt	6413	0644	editdlrm
descriptor.rst.txt	1296	0644	editdlrm
dict.rst.txt	7757	0644	editdlrm
exceptions.rst.txt	35304	0644	editdlrm
file.rst.txt	6198	0644	editdlrm
float.rst.txt	3371	0644	editdlrm
function.rst.txt	2421	0644	editdlrm
gcsupport.rst.txt	6587	0644	editdlrm
gen.rst.txt	920	0644	editdlrm
import.rst.txt	11221	0644	editdlrm
index.rst.txt	578	0644	editdlrm
init.rst.txt	49160	0644	editdlrm
int.rst.txt	4578	0644	editdlrm
intro.rst.txt	28473	0644	editdlrm
iter.rst.txt	1390	0644	editdlrm
iterator.rst.txt	1796	0644	editdlrm
list.rst.txt	6362	0644	editdlrm
long.rst.txt	7987	0644	editdlrm
mapping.rst.txt	2874	0644	editdlrm
marshal.rst.txt	3985	0644	editdlrm
memory.rst.txt	11556	0644	editdlrm
method.rst.txt	2099	0644	editdlrm
module.rst.txt	3867	0644	editdlrm
none.rst.txt	697	0644	editdlrm
number.rst.txt	11939	0644	editdlrm
objbuffer.rst.txt	2516	0644	editdlrm
object.rst.txt	17491	0644	editdlrm
objimpl.rst.txt	305	0644	editdlrm
refcounting.rst.txt	2934	0644	editdlrm
reflection.rst.txt	1567	0644	editdlrm
sequence.rst.txt	8716	0644	editdlrm
set.rst.txt	6588	0644	editdlrm
slice.rst.txt	2979	0644	editdlrm
string.rst.txt	15422	0644	editdlrm
structures.rst.txt	14966	0644	editdlrm
sys.rst.txt	5714	0644	editdlrm
tuple.rst.txt	5491	0644	editdlrm
type.rst.txt	2761	0644	editdlrm
typeobj.rst.txt	66936	0644	editdlrm
unicode.rst.txt	45126	0644	editdlrm
utilities.rst.txt	415	0644	editdlrm
veryhigh.rst.txt	13363	0644	editdlrm
weakref.rst.txt	2820	0644	editdlrm

.. highlightlang:: c .. _os: Operating System Utilities ========================== .. c:function:: int Py_FdIsInteractive(FILE *fp, const char *filename) Return true (nonzero) if the standard I/O file *fp* with name *filename* is deemed interactive. This is the case for files for which ``isatty(fileno(fp))`` is true. If the global flag :c:data:`Py_InteractiveFlag` is true, this function also returns true if the *filename* pointer is *NULL* or if the name is equal to one of the strings ``''`` or ``'???'``. .. c:function:: void PyOS_AfterFork() Function to update some internal state after a process fork; this should be called in the new process if the Python interpreter will continue to be used. If a new executable is loaded into the new process, this function does not need to be called. .. c:function:: int PyOS_CheckStack() Return true when the interpreter runs out of stack space. This is a reliable check, but is only available when :const:`USE_STACKCHECK` is defined (currently on Windows using the Microsoft Visual C++ compiler). :const:`USE_STACKCHECK` will be defined automatically; you should never change the definition in your own code. .. c:function:: PyOS_sighandler_t PyOS_getsig(int i) Return the current signal handler for signal *i*. This is a thin wrapper around either :c:func:`sigaction` or :c:func:`signal`. Do not call those functions directly! :c:type:`PyOS_sighandler_t` is a typedef alias for :c:type:`void (\*)(int)`. .. c:function:: PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h) Set the signal handler for signal *i* to be *h*; return the old signal handler. This is a thin wrapper around either :c:func:`sigaction` or :c:func:`signal`. Do not call those functions directly! :c:type:`PyOS_sighandler_t` is a typedef alias for :c:type:`void (\*)(int)`. .. _systemfunctions: System Functions ================ These are utility functions that make functionality from the :mod:`sys` module accessible to C code. They all work with the current interpreter thread's :mod:`sys` module's dict, which is contained in the internal thread state structure. .. c:function:: PyObject *PySys_GetObject(char *name) Return the object *name* from the :mod:`sys` module or *NULL* if it does not exist, without setting an exception. .. c:function:: FILE *PySys_GetFile(char *name, FILE *def) Return the :c:type:`FILE*` associated with the object *name* in the :mod:`sys` module, or *def* if *name* is not in the module or is not associated with a :c:type:`FILE*`. .. c:function:: int PySys_SetObject(char *name, PyObject *v) Set *name* in the :mod:`sys` module to *v* unless *v* is *NULL*, in which case *name* is deleted from the sys module. Returns ``0`` on success, ``-1`` on error. .. c:function:: void PySys_ResetWarnOptions() Reset :data:`sys.warnoptions` to an empty list. .. c:function:: void PySys_AddWarnOption(char *s) Append *s* to :data:`sys.warnoptions`. .. c:function:: void PySys_SetPath(char *path) Set :data:`sys.path` to a list object of paths found in *path* which should be a list of paths separated with the platform's search path delimiter (``:`` on Unix, ``;`` on Windows). .. c:function:: void PySys_WriteStdout(const char *format, ...) Write the output string described by *format* to :data:`sys.stdout`. No exceptions are raised, even if truncation occurs (see below). *format* should limit the total size of the formatted output string to 1000 bytes or less -- after 1000 bytes, the output string is truncated. In particular, this means that no unrestricted "%s" formats should occur; these should be limited using "%.s" where is a decimal number calculated so that plus the maximum size of other formatted text does not exceed 1000 bytes. Also watch out for "%f", which can print hundreds of digits for very large numbers. If a problem occurs, or :data:`sys.stdout` is unset, the formatted message is written to the real (C level) *stdout*. .. c:function:: void PySys_WriteStderr(const char *format, ...) As above, but write to :data:`sys.stderr` or *stderr* instead. .. _processcontrol: Process Control =============== .. c:function:: void Py_FatalError(const char *message) .. index:: single: abort() Print a fatal error message and kill the process. No cleanup is performed. This function should only be invoked when a condition is detected that would make it dangerous to continue using the Python interpreter; e.g., when the object administration appears to be corrupted. On Unix, the standard C library function :c:func:`abort` is called which will attempt to produce a :file:`core` file. .. c:function:: void Py_Exit(int status) .. index:: single: Py_Finalize() single: exit() Exit the current process. This calls :c:func:`Py_Finalize` and then calls the standard C library function ``exit(status)``. .. c:function:: int Py_AtExit(void (*func) ()) .. index:: single: Py_Finalize() single: cleanup functions Register a cleanup function to be called by :c:func:`Py_Finalize`. The cleanup function will be called with no arguments and should return no value. At most 32 cleanup functions can be registered. When the registration is successful, :c:func:`Py_AtExit` returns ``0``; on failure, it returns ``-1``. The cleanup function registered last is called first. Each cleanup function will be called at most once. Since Python's internal finalization will have completed before the cleanup function, no Python APIs should be called by *func*.