系统函数 ¶

These are utility functions that make functionality from the sys module accessible to C code. They all work with the current interpreter thread’s sys module’s dict, which is contained in the internal thread state structure.

PyObject * PySys_GetObject ( const char *name ) ¶

返回值：借位引用。

返回对象 name 从 sys 模块或 NULL 若不存在，则不设置异常。

int PySys_SetObject ( const char *name , PyObject *v ) ¶

Set name 在 sys module to v unless v is NULL , in which case name is deleted from the sys module. Returns 0 当成功时， -1 当出错时。

void PySys_ResetWarnOptions ( ) ¶

重置 sys.warnoptions to an empty list. This function may be called prior to Py_Initialize() .

void PySys_AddWarnOption ( const wchar_t *s ) ¶

追加 s to sys.warnoptions . This function must be called prior to Py_Initialize() in order to affect the warnings filter list.

void PySys_AddWarnOptionUnicode ( PyObject *unicode ) ¶

追加 unicode to sys.warnoptions .

Note: this function is not currently usable from outside the CPython implementation, as it must be called prior to the implicit import of warnings in Py_Initialize() to be effective, but can’t be called until enough of the runtime has been initialized to permit the creation of Unicode objects.

void PySys_SetPath ( const wchar_t *path ) ¶

Set 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 ( : 在 Unix， ; 在 Windows)。

void PySys_WriteStdout ( const char *format , ... ) ¶

Write the output string described by format to 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 “%.<N>s” where <N> is a decimal number calculated so that <N> 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 sys.stdout is unset, the formatted message is written to the real (C level) stdout .

void PySys_WriteStderr ( const char *format , ... ) ¶

As PySys_WriteStdout() ，但写入 sys.stderr or stderr 代替。

void PySys_FormatStdout ( const char *format , ... ) ¶

Function similar to PySys_WriteStdout() but format the message using PyUnicode_FromFormatV() and don’t truncate the message to an arbitrary length.

3.2 版新增。

void PySys_FormatStderr ( const char *format , ... ) ¶

As PySys_FormatStdout() ，但写入 sys.stderr or stderr 代替。

3.2 版新增。

void PySys_AddXOption ( const wchar_t *s ) ¶

剖析 s as a set of -X options and add them to the current options mapping as returned by PySys_GetXOptions() . This function may be called prior to Py_Initialize() .

3.2 版新增。

PyObject * PySys_GetXOptions ( ) ¶

返回值：借位引用。

返回当前字典为 -X 选项，类似于 sys._xoptions 。当出错时， NULL 被返回并设置异常。

3.2 版新增。

int PySys_Audit ( const char *event , const char *format , ... ) ¶

Raise an auditing event with any active hooks. Return zero for success and non-zero with an exception set on failure.

If any hooks have been added, format and other arguments will be used to construct a tuple to pass. Apart from N , the same format characters as used in Py_BuildValue() are available. If the built value is not a tuple, it will be added into a single-element tuple. (The N format option consumes a reference, but since there is no way to know whether arguments to this function will be consumed, using it may cause reference leaks.)

注意， # format characters should always be treated as Py_ssize_t , regardless of whether PY_SSIZE_T_CLEAN 有定义。

sys.audit() 从 Python 代码履行相同函数。

3.8 版新增。

3.8.2 版改变： 要求 Py_ssize_t for # format characters. Previously, an unavoidable deprecation warning was raised.

int PySys_AddAuditHook ( Py_AuditHookFunction hook , void *userData ) ¶

追加可调用 hook to the list of active auditing hooks. Return zero for success and non-zero on failure. If the runtime has been initialized, also set an error on failure. Hooks added through this API are called for all interpreters created by the runtime.

userData pointer is passed into the hook function. Since hook functions may be called from different runtimes, this pointer should not refer directly to Python state.

调用此函数是安全的先于 Py_Initialize() . When called after runtime initialization, existing audit hooks are notified and may silently abort the operation by raising an error subclassed from Exception (other errors will not be silenced).

The hook function is of type int (*)(const char *event, PyObject *args, void *userData) ，其中 args is guaranteed to be a PyTupleObject . The hook function is always called with the GIL held by the Python interpreter that raised the event.

见 PEP 578 for a detailed description of auditing. Functions in the runtime and standard library that raise events are listed in the 审计事件表 . Details are in each function’s documentation.

If the interpreter is initialized, this function raises a auditing event sys.addaudithook 不带自变量。若任何现有挂钩引发的异常派生自 Exception , the new hook will not be added and the exception is cleared. As a result, callers cannot assume that their hook has been added unless they control all existing hooks.

3.8 版新增。

进程控制 ¶

void Py_FatalError ( const char *message ) ¶

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 abort() is called which will attempt to produce a core 文件。

Py_FatalError() function is replaced with a macro which logs automatically the name of the current function, unless the Py_LIMITED_API 宏有定义。

3.9 版改变： Log the function name automatically.

void Py_Exit ( int status ) ¶

退出当前进程。这调用 Py_FinalizeEx() 然后调用标准 C 库函数 exit(status) 。若 Py_FinalizeEx() 指示出错，退出状态被设为 120。

3.6 版改变： 不再忽略来自定稿的错误。

int Py_AtExit ( void ( *func )() ) ¶

Register a cleanup function to be called by Py_FinalizeEx() . 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, Py_AtExit() 返回 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 .