mirror of
https://github.com/python/cpython.git
synced 2025-08-04 17:08:35 +00:00
Migrate to Sphinx 1.0 C language constructs.
This commit is contained in:
Georg Brandl
parent
64a41edb03
commit
60203b41b0
106 changed files with 2573 additions and 2569 deletions
|
|
@ -6,16 +6,16 @@ Operating System Utilities
|
|||
==========================
|
||||
|
||||
|
||||
.. cfunction:: int Py_FdIsInteractive(FILE *fp, const char *filename)
|
||||
.. 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 :cdata:`Py_InteractiveFlag` is true, this function
|
||||
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 ``'<stdin>'`` or ``'???'``.
|
||||
|
||||
|
||||
.. cfunction:: void PyOS_AfterFork()
|
||||
.. 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.
|
||||
|
|
@ -23,7 +23,7 @@ Operating System Utilities
|
|||
to be called.
|
||||
|
||||
|
||||
.. cfunction:: int PyOS_CheckStack()
|
||||
.. 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
|
||||
|
|
@ -32,20 +32,20 @@ Operating System Utilities
|
|||
own code.
|
||||
|
||||
|
||||
.. cfunction:: PyOS_sighandler_t PyOS_getsig(int i)
|
||||
.. c:function:: PyOS_sighandler_t PyOS_getsig(int i)
|
||||
|
||||
Return the current signal handler for signal *i*. This is a thin wrapper around
|
||||
either :cfunc:`sigaction` or :cfunc:`signal`. Do not call those functions
|
||||
directly! :ctype:`PyOS_sighandler_t` is a typedef alias for :ctype:`void
|
||||
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)`.
|
||||
|
||||
|
||||
.. cfunction:: PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h)
|
||||
.. 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 :cfunc:`sigaction` or :cfunc:`signal`. Do
|
||||
not call those functions directly! :ctype:`PyOS_sighandler_t` is a typedef
|
||||
alias for :ctype:`void (\*)(int)`.
|
||||
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:
|
||||
|
||||
|
|
@ -56,42 +56,42 @@ 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.
|
||||
|
||||
.. cfunction:: PyObject *PySys_GetObject(char *name)
|
||||
.. 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.
|
||||
|
||||
.. cfunction:: FILE *PySys_GetFile(char *name, FILE *def)
|
||||
.. c:function:: FILE *PySys_GetFile(char *name, FILE *def)
|
||||
|
||||
Return the :ctype:`FILE*` associated with the object *name* in the
|
||||
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 :ctype:`FILE*`.
|
||||
with a :c:type:`FILE*`.
|
||||
|
||||
.. cfunction:: int PySys_SetObject(char *name, PyObject *v)
|
||||
.. 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.
|
||||
|
||||
.. cfunction:: void PySys_ResetWarnOptions()
|
||||
.. c:function:: void PySys_ResetWarnOptions()
|
||||
|
||||
Reset :data:`sys.warnoptions` to an empty list.
|
||||
|
||||
.. cfunction:: void PySys_AddWarnOption(wchar_t *s)
|
||||
.. c:function:: void PySys_AddWarnOption(wchar_t *s)
|
||||
|
||||
Append *s* to :data:`sys.warnoptions`.
|
||||
|
||||
.. cfunction:: void PySys_AddWarnOptionUnicode(PyObject *unicode)
|
||||
.. c:function:: void PySys_AddWarnOptionUnicode(PyObject *unicode)
|
||||
|
||||
Append *unicode* to :data:`sys.warnoptions`.
|
||||
|
||||
.. cfunction:: void PySys_SetPath(wchar_t *path)
|
||||
.. c:function:: void PySys_SetPath(wchar_t *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).
|
||||
|
||||
.. cfunction:: void PySys_WriteStdout(const char *format, ...)
|
||||
.. 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).
|
||||
|
|
@ -107,22 +107,22 @@ accessible to C code. They all work with the current interpreter thread's
|
|||
If a problem occurs, or :data:`sys.stdout` is unset, the formatted message
|
||||
is written to the real (C level) *stdout*.
|
||||
|
||||
.. cfunction:: void PySys_WriteStderr(const char *format, ...)
|
||||
.. c:function:: void PySys_WriteStderr(const char *format, ...)
|
||||
|
||||
As :cfunc:`PySys_WriteStdout`, but write to :data:`sys.stderr` or *stderr*
|
||||
As :c:func:`PySys_WriteStdout`, but write to :data:`sys.stderr` or *stderr*
|
||||
instead.
|
||||
|
||||
.. cfunction:: void PySys_FormatStdout(const char *format, ...)
|
||||
.. c:function:: void PySys_FormatStdout(const char *format, ...)
|
||||
|
||||
Function similar to PySys_WriteStdout() but format the message using
|
||||
:cfunc:`PyUnicode_FromFormatV` and don't truncate the message to an
|
||||
:c:func:`PyUnicode_FromFormatV` and don't truncate the message to an
|
||||
arbitrary length.
|
||||
|
||||
.. versionadded:: 3.2
|
||||
|
||||
.. cfunction:: void PySys_FormatStderr(const char *format, ...)
|
||||
.. c:function:: void PySys_FormatStderr(const char *format, ...)
|
||||
|
||||
As :cfunc:`PySys_FormatStdout`, but write to :data:`sys.stderr` or *stderr*
|
||||
As :c:func:`PySys_FormatStdout`, but write to :data:`sys.stderr` or *stderr*
|
||||
instead.
|
||||
|
||||
.. versionadded:: 3.2
|
||||
|
|
@ -134,7 +134,7 @@ Process Control
|
|||
===============
|
||||
|
||||
|
||||
.. cfunction:: void Py_FatalError(const char *message)
|
||||
.. c:function:: void Py_FatalError(const char *message)
|
||||
|
||||
.. index:: single: abort()
|
||||
|
||||
|
|
@ -142,30 +142,30 @@ Process Control
|
|||
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 :cfunc:`abort` is called which will attempt to produce a :file:`core`
|
||||
function :c:func:`abort` is called which will attempt to produce a :file:`core`
|
||||
file.
|
||||
|
||||
|
||||
.. cfunction:: void Py_Exit(int status)
|
||||
.. c:function:: void Py_Exit(int status)
|
||||
|
||||
.. index::
|
||||
single: Py_Finalize()
|
||||
single: exit()
|
||||
|
||||
Exit the current process. This calls :cfunc:`Py_Finalize` and then calls the
|
||||
Exit the current process. This calls :c:func:`Py_Finalize` and then calls the
|
||||
standard C library function ``exit(status)``.
|
||||
|
||||
|
||||
.. cfunction:: int Py_AtExit(void (*func) ())
|
||||
.. c:function:: int Py_AtExit(void (*func) ())
|
||||
|
||||
.. index::
|
||||
single: Py_Finalize()
|
||||
single: cleanup functions
|
||||
|
||||
Register a cleanup function to be called by :cfunc:`Py_Finalize`. The cleanup
|
||||
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,
|
||||
:cfunc:`Py_AtExit` returns ``0``; on failure, it returns ``-1``. The cleanup
|
||||
: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*.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue