Gecko [ v99win.today ]

Name	Size	Permission
abstract.html	7.8 KB	-rw-r--r--
allocation.html	24.04 KB	-rw-r--r--
arg.html	64.25 KB	-rw-r--r--
bool.html	11.44 KB	-rw-r--r--
buffer.html	58.49 KB	-rw-r--r--
bytearray.html	18.39 KB	-rw-r--r--
capsule.html	26.78 KB	-rw-r--r--
cell.html	13.74 KB	-rw-r--r--
class.html	14.3 KB	-rw-r--r--
cobject.html	15.67 KB	-rw-r--r--
code.html	15.57 KB	-rw-r--r--
codec.html	29.28 KB	-rw-r--r--
complex.html	25.03 KB	-rw-r--r--
concrete.html	15.93 KB	-rw-r--r--
conversion.html	29.24 KB	-rw-r--r--
datetime.html	35.92 KB	-rw-r--r--
descriptor.html	15.74 KB	-rw-r--r--
dict.html	42.03 KB	-rw-r--r--
exceptions.html	112.66 KB	-rw-r--r--
file.html	28.8 KB	-rw-r--r--
float.html	21.5 KB	-rw-r--r--
function.html	17.69 KB	-rw-r--r--
gcsupport.html	29.5 KB	-rw-r--r--
gen.html	9.84 KB	-rw-r--r--
import.html	43.14 KB	-rw-r--r--
index.html	13.69 KB	-rw-r--r--
init.html	122.91 KB	-rw-r--r--
int.html	24.28 KB	-rw-r--r--
intro.html	57.73 KB	-rw-r--r--
iter.html	11.38 KB	-rw-r--r--
iterator.html	13.32 KB	-rw-r--r--
list.html	31.45 KB	-rw-r--r--
long.html	39.54 KB	-rw-r--r--
mapping.html	20.85 KB	-rw-r--r--
marshal.html	18.82 KB	-rw-r--r--
memory.html	37.51 KB	-rw-r--r--
method.html	16.77 KB	-rw-r--r--
module.html	21.95 KB	-rw-r--r--
none.html	8.76 KB	-rw-r--r--
number.html	64.95 KB	-rw-r--r--
objbuffer.html	14.62 KB	-rw-r--r--
object.html	74.9 KB	-rw-r--r--
objimpl.html	7.59 KB	-rw-r--r--
refcounting.html	14.46 KB	-rw-r--r--
reflection.html	12.81 KB	-rw-r--r--
sequence.html	41.73 KB	-rw-r--r--
set.html	35.44 KB	-rw-r--r--
slice.html	16.89 KB	-rw-r--r--
string.html	46.73 KB	-rw-r--r--
structures.html	41.96 KB	-rw-r--r--
sys.html	26.72 KB	-rw-r--r--
tuple.html	27.17 KB	-rw-r--r--
type.html	19.18 KB	-rw-r--r--
typeobj.html	209.91 KB	-rw-r--r--
unicode.html	160.87 KB	-rw-r--r--
utilities.html	7.88 KB	-rw-r--r--
veryhigh.html	66.91 KB	-rw-r--r--
weakref.html	15.68 KB	-rw-r--r--

Code Editor : sys.html

<!DOCTYPE html>

<title>Operating System Utilities &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Importing Modules" href="import.html" />
 <link rel="prev" title="Utilities" href="utilities.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/c-api/sys.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/c-api/sys.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="import.html" title="Importing Modules"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="utilities.html" title="Utilities"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="utilities.html" accesskey="U">Utilities</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Operating System Utilities</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="operating-system-utilities">
<h1>Operating System Utilities<a class="headerlink" href="#operating-system-utilities" title="Permalink to this headline">¶</a></h1>
<dl class="c function">
<dt class="sig sig-object c" id="c.Py_FdIsInteractive">
int Py_FdIsInteractive(FILE *fp, const char *filename)<a class="headerlink" href="#c.Py_FdIsInteractive" title="Permalink to this definition">¶</a> </dt>
<dd>Return true (nonzero) if the standard I/O file fp with name filename is
deemed interactive. This is the case for files for which <code class="docutils literal notranslate">isatty(fileno(fp))</code>
is true. If the global flag <code class="xref c c-data docutils literal notranslate">Py_InteractiveFlag</code> is true, this function
also returns true if the filename pointer is NULL or if the name is equal to
one of the strings <code class="docutils literal notranslate">'&lt;stdin&gt;'</code> or <code class="docutils literal notranslate">'???'</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyOS_AfterFork">
void PyOS_AfterFork()<a class="headerlink" href="#c.PyOS_AfterFork" title="Permalink to this definition">¶</a> </dt>
<dd>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.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyOS_CheckStack">
int PyOS_CheckStack()<a class="headerlink" href="#c.PyOS_CheckStack" title="Permalink to this definition">¶</a> </dt>
<dd>Return true when the interpreter runs out of stack space. This is a reliable
check, but is only available when <code class="xref py py-const docutils literal notranslate">USE_STACKCHECK</code> is defined (currently
on Windows using the Microsoft Visual C++ compiler). <code class="xref py py-const docutils literal notranslate">USE_STACKCHECK</code>
will be defined automatically; you should never change the definition in your
own code.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyOS_getsig">
PyOS_sighandler_t PyOS_getsig(int i)<a class="headerlink" href="#c.PyOS_getsig" title="Permalink to this definition">¶</a> </dt>
<dd>Return the current signal handler for signal i. This is a thin wrapper around
either <code class="xref c c-func docutils literal notranslate">sigaction()</code> or <code class="xref c c-func docutils literal notranslate">signal()</code>. Do not call those functions
directly! <code class="xref c c-type docutils literal notranslate">PyOS_sighandler_t</code> is a typedef alias for <code class="xref c c-type docutils literal notranslate">void
(*)(int)</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyOS_setsig">
PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h)<a class="headerlink" href="#c.PyOS_setsig" title="Permalink to this definition">¶</a> </dt>
<dd>Set the signal handler for signal i to be h; return the old signal handler.
This is a thin wrapper around either <code class="xref c c-func docutils literal notranslate">sigaction()</code> or <code class="xref c c-func docutils literal notranslate">signal()</code>. Do
not call those functions directly! <code class="xref c c-type docutils literal notranslate">PyOS_sighandler_t</code> is a typedef
alias for <code class="xref c c-type docutils literal notranslate">void (*)(int)</code>.
</dd></dl>

</section>
<section id="system-functions">
<h1>System Functions<a class="headerlink" href="#system-functions" title="Permalink to this headline">¶</a></h1>
These are utility functions that make functionality from the <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module
accessible to C code. They all work with the current interpreter thread’s
<a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module’s dict, which is contained in the internal thread state structure.
<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_GetObject">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PySys_GetObject(char *name)<a class="headerlink" href="#c.PySys_GetObject" title="Permalink to this definition">¶</a> </dt>
<dd>Return the object name from the <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module or NULL if it does
not exist, without setting an exception.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_GetFile">
FILE *PySys_GetFile(char *name, FILE *def)<a class="headerlink" href="#c.PySys_GetFile" title="Permalink to this definition">¶</a> </dt>
<dd>Return the <code class="xref c c-type docutils literal notranslate">FILE*</code> associated with the object name in the
<a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module, or def if name is not in the module or is not associated
with a <code class="xref c c-type docutils literal notranslate">FILE*</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_SetObject">
int PySys_SetObject(char *name, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *v)<a class="headerlink" href="#c.PySys_SetObject" title="Permalink to this definition">¶</a> </dt>
<dd>Set name in the <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module to v unless v is NULL, in which
case name is deleted from the sys module. Returns <code class="docutils literal notranslate">0</code> on success, <code class="docutils literal notranslate">-1</code>
on error.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_ResetWarnOptions">
void PySys_ResetWarnOptions()<a class="headerlink" href="#c.PySys_ResetWarnOptions" title="Permalink to this definition">¶</a> </dt>
<dd>Reset <a class="reference internal" href="../library/sys.html#sys.warnoptions" title="sys.warnoptions"><code class="xref py py-data docutils literal notranslate">sys.warnoptions</code></a> to an empty list.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_AddWarnOption">
void PySys_AddWarnOption(char *s)<a class="headerlink" href="#c.PySys_AddWarnOption" title="Permalink to this definition">¶</a> </dt>
<dd>Append s to <a class="reference internal" href="../library/sys.html#sys.warnoptions" title="sys.warnoptions"><code class="xref py py-data docutils literal notranslate">sys.warnoptions</code></a>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_SetPath">
void PySys_SetPath(char *path)<a class="headerlink" href="#c.PySys_SetPath" title="Permalink to this definition">¶</a> </dt>
<dd>Set <a class="reference internal" href="../library/sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> to a list object of paths found in path which should
be a list of paths separated with the platform’s search path delimiter
(<code class="docutils literal notranslate">:</code> on Unix, <code class="docutils literal notranslate">;</code> on Windows).
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_WriteStdout">
void PySys_WriteStdout(const char *format, ...)<a class="headerlink" href="#c.PySys_WriteStdout" title="Permalink to this definition">¶</a> </dt>
<dd>Write the output string described by format to <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a>. 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 “%.&lt;N&gt;s” where &lt;N&gt; is a decimal number
calculated so that &lt;N&gt; 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 <a class="reference internal" href="../library/sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a> is unset, the formatted message
is written to the real (C level) stdout.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySys_WriteStderr">
void PySys_WriteStderr(const char *format, ...)<a class="headerlink" href="#c.PySys_WriteStderr" title="Permalink to this definition">¶</a> </dt>
<dd>As above, but write to <a class="reference internal" href="../library/sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate">sys.stderr</code></a> or stderr instead.
</dd></dl>

</section>
<section id="process-control">
<h1>Process Control<a class="headerlink" href="#process-control" title="Permalink to this headline">¶</a></h1>
<dl class="c function">
<dt class="sig sig-object c" id="c.Py_FatalError">
void Py_FatalError(const char *message)<a class="headerlink" href="#c.Py_FatalError" title="Permalink to this definition">¶</a> </dt>
<dd>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 <code class="xref c c-func docutils literal notranslate">abort()</code> is called which will attempt to produce a <code class="file docutils literal notranslate">core</code>
file.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_Exit">
void Py_Exit(int status)<a class="headerlink" href="#c.Py_Exit" title="Permalink to this definition">¶</a> </dt>
<dd>Exit the current process. This calls <a class="reference internal" href="init.html#c.Py_Finalize" title="Py_Finalize"><code class="xref c c-func docutils literal notranslate">Py_Finalize()</code></a> and then calls the
standard C library function <code class="docutils literal notranslate">exit(status)</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_AtExit">
int Py_AtExit(void (*func)())<a class="headerlink" href="#c.Py_AtExit" title="Permalink to this definition">¶</a> </dt>
<dd>Register a cleanup function to be called by <a class="reference internal" href="init.html#c.Py_Finalize" title="Py_Finalize"><code class="xref c c-func docutils literal notranslate">Py_Finalize()</code></a>. 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,
<a class="reference internal" href="#c.Py_AtExit" title="Py_AtExit"><code class="xref c c-func docutils literal notranslate">Py_AtExit()</code></a> returns <code class="docutils literal notranslate">0</code>; on failure, it returns <code class="docutils literal notranslate">-1</code>. 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.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Operating System Utilities</a></li>
<li><a class="reference internal" href="#system-functions">System Functions</a></li>
<li><a class="reference internal" href="#process-control">Process Control</a></li>
</ul>

<h4>Previous topic</h4>
 <a href="utilities.html"
 title="previous chapter">Utilities</a>
 <h4>Next topic</h4>
 <a href="import.html"
 title="next chapter">Importing Modules</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/c-api/sys.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="import.html" title="Importing Modules"
 >next</a> |</li>
 <li class="right" >
 <a href="utilities.html" title="Utilities"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="utilities.html" >Utilities</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Operating System Utilities</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : sys.html