操作系统实用工具 ¶

PyObject * PyOS_FSPath ( PyObject * path ) ¶

返回值：新引用。 属于稳定 ABI (应用程序二进制接口) since version 3.6.

返回文件系统表示为 path 。若对象是 str or bytes object, then a new 强引用 is returned. If the object implements the os.PathLike 接口，那么 __fspath__() is returned as long as it is a str or bytes object. Otherwise TypeError is raised and NULL 被返回。

Added in version 3.6.

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 PyConfig.interactive is non-zero, this function also returns true if the filename pointer is NULL or if the name is equal to one of the strings '<stdin>' or '???' .

This function must not be called before Python is initialized.

void PyOS_BeforeFork ( ) ¶: 属于稳定 ABI (应用程序二进制接口) on platforms with fork() since version 3.7.
Function to prepare some internal state before a process fork. This should be called before calling fork() or any similar function that clones the current process. Only available on systems where fork() 有定义。

警告

The C fork() call should only be made from the “main” thread (of the “main” interpreter ). The same is true for PyOS_BeforeFork() .

3.7 版添加。

void PyOS_AfterFork_Parent ( ) ¶: 属于稳定 ABI (应用程序二进制接口) on platforms with fork() since version 3.7.
Function to update some internal state after a process fork. This should be called from the parent process after calling fork() or any similar function that clones the current process, regardless of whether process cloning was successful. Only available on systems where fork() 有定义。

警告

The C fork() call should only be made from the “main” thread (of the “main” interpreter ). The same is true for PyOS_AfterFork_Parent() .

3.7 版添加。

void PyOS_AfterFork_Child ( ) ¶: 属于稳定 ABI (应用程序二进制接口) on platforms with fork() since version 3.7.
Function to update internal interpreter state after a process fork. This must be called from the child process after calling fork() , or any similar function that clones the current process, if there is any chance the process will call back into the Python interpreter. Only available on systems where fork() 有定义。

警告

The C fork() call should only be made from the “main” thread (of the “main” interpreter ). The same is true for PyOS_AfterFork_Child() .

3.7 版添加。

另请参阅

os.register_at_fork() allows registering custom Python functions to be called by PyOS_BeforeFork() , PyOS_AfterFork_Parent() and PyOS_AfterFork_Child() .

void PyOS_AfterFork ( ) ¶: 属于稳定 ABI (应用程序二进制接口) on platforms with fork().
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.

从 3.7 版起弃用： This function is superseded by PyOS_AfterFork_Child() .

int PyOS_CheckStack ( ) ¶: 属于稳定 ABI (应用程序二进制接口) on platforms with USE_STACKCHECK since version 3.7.
Return true when the interpreter runs out of stack space. This is a reliable check, but is only available when USE_STACKCHECK is defined (currently on certain versions of Windows using the Microsoft Visual C++ compiler). USE_STACKCHECK will be defined automatically; you should never change the definition in your own code.

typedef void ( * PyOS_sighandler_t ) ( int ) ¶: 属于稳定 ABI (应用程序二进制接口) .

PyOS_sighandler_t PyOS_getsig ( int i ) ¶: 属于稳定 ABI (应用程序二进制接口) .
Return the current signal handler for signal i . This is a thin wrapper around either sigaction() or signal() 。不要直接调用这些函数！

PyOS_sighandler_t PyOS_setsig ( int i , PyOS_sighandler_t h ) ¶: 属于稳定 ABI (应用程序二进制接口) .
Set the signal handler for signal i 到 h ; return the old signal handler. This is a thin wrapper around either sigaction() or signal() 。不要直接调用这些函数！

wchar_t * Py_DecodeLocale ( const char * arg , size_t * size ) ¶: 属于稳定 ABI (应用程序二进制接口) since version 3.7.

警告

This function should not be called directly: use the PyConfig API with the PyConfig_SetBytesString() function which ensures that Python is preinitialized .

This function must not be called before Python is preinitialized and so that the LC_CTYPE locale is properly configured: see the Py_PreInitialize() 函数。

Decode a byte string from the 文件系统编码和错误处理程序 . If the error handler is surrogateescape (替代转义) 错误处理程序 , undecodable bytes are decoded as characters in range U+DC80..U+DCFF; and if a byte sequence can be decoded as a surrogate character, the bytes are escaped using the surrogateescape error handler instead of decoding them.

Return a pointer to a newly allocated wide character string, use PyMem_RawFree() 来释放内存。若尺寸不是 NULL , write the number of wide characters excluding the null character into *size

返回 NULL 当解码错误或内存分配出错时。若 size 不是 NULL , *size 被设为 (size_t)-1 当内存出错时或设为 (size_t)-2 当解码错误时。

The 文件系统编码和错误处理程序 are selected by PyConfig_Read() : see filesystem_encoding and filesystem_errors 成员对于 PyConfig .

解码错误应从不发生，除非 C 库存在 Bug。

使用 Py_EncodeLocale() 函数将字符串编码回字节字符串。

另请参阅

The PyUnicode_DecodeFSDefaultAndSize() and PyUnicode_DecodeLocaleAndSize() 函数。

Added in version 3.5.

3.7 版改变： The function now uses the UTF-8 encoding in the Python UTF-8 模式 .

3.8 版改变：函数现在在 Windows 使用 UTF-8 编码若 PyPreConfig.legacy_windows_fs_encoding 为 0；

char * Py_EncodeLocale ( const wchar_t * text , size_t * error_pos ) ¶

属于稳定 ABI (应用程序二进制接口) since version 3.7.

Encode a wide character string to the 文件系统编码和错误处理程序 . If the error handler is surrogateescape (替代转义) 错误处理程序 , surrogate characters in the range U+DC80..U+DCFF are converted to bytes 0x80..0xFF.

Return a pointer to a newly allocated byte string, use PyMem_Free() to free the memory. Return NULL on encoding error or memory allocation error.

若 error_pos 不是 NULL , *error_pos 被设为 (size_t)-1 on success, or set to the index of the invalid character on encoding error.

The 文件系统编码和错误处理程序 are selected by PyConfig_Read() : see filesystem_encoding and filesystem_errors 成员对于 PyConfig .

使用 Py_DecodeLocale() 函数将字节字符串解码回宽字符串。

警告

This function must not be called before Python is preinitialized and so that the LC_CTYPE locale is properly configured: see the Py_PreInitialize() 函数。

另请参阅

The PyUnicode_EncodeFSDefault() and PyUnicode_EncodeLocale() 函数。

Added in version 3.5.

3.7 版改变： The function now uses the UTF-8 encoding in the Python UTF-8 模式 .

3.8 版改变：函数现在在 Windows 使用 UTF-8 编码若 PyPreConfig.legacy_windows_fs_encoding 为 0。

系统函数 ¶

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 * 名称 ) ¶: 返回值：借位引用。 属于稳定 ABI (应用程序二进制接口) .
返回对象 name 从 sys 模块或 NULL 若不存在，则不设置异常。

int PySys_SetObject ( const char * 名称 , PyObject * v ) ¶: 属于稳定 ABI (应用程序二进制接口) .
Set name 在 sys module to v unless v is NULL ，在这种情况下 name is deleted from the sys module. Returns 0 当成功时， -1 当出错时。

void PySys_ResetWarnOptions ( ) ¶

属于稳定 ABI (应用程序二进制接口) .

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

Deprecated since version 3.13, will be removed in version 3.15: Clear sys.warnoptions and warnings.filters 代替。

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

属于稳定 ABI (应用程序二进制接口) .

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 , ... ) ¶: 属于稳定 ABI (应用程序二进制接口) .
As PySys_WriteStdout() ，但写入 sys.stderr or stderr 代替。

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

属于稳定 ABI (应用程序二进制接口) .

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

Added in version 3.2.

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

属于稳定 ABI (应用程序二进制接口) .

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

Added in version 3.2.

PyObject * PySys_GetXOptions ( ) ¶

返回值：借位引用。 属于稳定 ABI (应用程序二进制接口) since version 3.7.

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

Added in version 3.2.

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

属于稳定 ABI (应用程序二进制接口) since version 3.13.

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

The event string argument must not be NULL .

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 must not be used. It 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 代码履行相同函数。

另请参阅 PySys_AuditTuple() .

Added in version 3.8.

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

int PySys_AuditTuple ( const char * event , PyObject * args ) ¶

属于稳定 ABI (应用程序二进制接口) since version 3.13.

类似于 PySys_Audit() , but pass arguments as a Python object. args 必须为 tuple . To pass no arguments, args 可以是 NULL .

3.13 版添加。

int PySys_AddAuditHook ( Py_AuditHookFunction hook , void * userData ) ¶

追加可调用 hook to the list of active auditing hooks. Return zero on 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.

The userData 指针会被传入挂钩函数。由于可以从不同运行时调用挂钩函数，此指针不应直接引用 Python 状态。

调用此函数是安全的先于 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 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 an 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.

typedef int ( * Py_AuditHookFunction ) ( const char * event , PyObject * args , void * userData ) ¶: The type of the hook function. event is the C string event argument passed to PySys_Audit() or PySys_AuditTuple() . args is guaranteed to be a PyTupleObject . userData is the argument passed to PySys_AddAuditHook().

Added in version 3.8.

进程控制 ¶

void Py_FatalError ( const char * message ) ¶

属于稳定 ABI (应用程序二进制接口) .

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 文件。

The 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 ) ¶

属于稳定 ABI (应用程序二进制接口) .

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

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

int Py_AtExit ( void ( * func ) ( ) ) ¶: 属于稳定 ABI (应用程序二进制接口) .
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 .

操作系统实用工具 ¶

系统函数 ¶

进程控制 ¶

内容表

上一话题

下一话题

本页