*PyOS_FSPath(
*path)
Return value: New reference. Part of the
since version 3.6.Return the file system representation for path. If the object is a
or
object, then a new
is returned. If the object implements the
interface, then
is returned as long as it is a str or bytes object. Otherwise
is raised and NULL is returned.
Added in version 3.6.
intPy_FdIsInteractive(FILE*fp, constchar*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
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.
voidPyOS_BeforeFork()
Part of the
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() is defined.
Added in version 3.7.
voidPyOS_AfterFork_Parent()
Part of the
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() is defined.
Added in version 3.7.
voidPyOS_AfterFork_Child()
Part of the
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() is defined.
Added in version 3.7.
voidPyOS_AfterFork()
Part of the
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.
Deprecated since version 3.7: This function is superseded by
.
intPyOS_CheckStack()
Part of the
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.
typedefvoid(*PyOS_sighandler_t)(int)
Part of the
.
PyOS_getsig(inti)
Part of the
.Return the current signal handler for signal i. This is a thin wrapper around either sigaction() or signal(). Do not call those functions directly!
PyOS_setsig(inti,
h)
Part of the
.Set the signal handler for signal i to be h; return the old signal handler. This is a thin wrapper around either sigaction() or signal(). Do not call those functions directly!
intPyOS_InterruptOccurred(void)
Part of the
.Check if a SIGINT signal has been received.
Returns 1 if a SIGINT has occurred and clears the signal flag, or 0 otherwise.
In most cases, you should prefer
over this function. PyErr_CheckSignals() invokes the appropriate signal handlers for all pending signals, allowing Python code to handle the signal properly. This function only detects SIGINT and does not invoke any Python signal handlers.
This function is async-signal-safe and this function cannot fail. The caller must hold an
.
wchar_t*Py_DecodeLocale(constchar*arg, size_t*size)
Part of the
since version 3.7.Decode a byte string from the
filesystem encoding and error handler
. If the error handler is
, 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
to free the memory. If size is not NULL, write the number of wide characters excluding the null character into *size
Return NULL on decoding error or memory allocation error. If size is not NULL, *size is set to (size_t)-1 on memory error or set to (size_t)-2 on decoding error.
The
filesystem encoding and error handler
are selected by
: see
and
members of
.
Decoding errors should never happen, unless there is a bug in the C library.
Use the
function to encode the character string back to a byte string.
Added in version 3.5.
Changed in version 3.7: The function now uses the UTF-8 encoding in the
.
char*Py_EncodeLocale(constwchar_t*text, size_t*error_pos)
Part of the
since version 3.7.Encode a wide character string to the
filesystem encoding and error handler
. If the error handler is
, 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
to free the memory. Return NULL on encoding error or memory allocation error.
If error_pos is not NULL, *error_pos is set to (size_t)-1 on success, or set to the index of the invalid character on encoding error.
The
filesystem encoding and error handler
are selected by
: see
and
members of
.
Use the
function to decode the bytes string back to a wide character string.
Added in version 3.5.
Changed in version 3.7: The function now uses the UTF-8 encoding in the
.
FILE*Py_fopen(
*path, constchar*mode)
Similar to fopen(), but path is a Python object and an exception is set on error.
path must be a
object, a
object, or a
.
On success, return the new file pointer. On error, set an exception and return NULL.
The file must be closed by
rather than calling directly fclose().
The file descriptor is created non-inheritable (
).
The caller must have an
.
Added in version 3.14.
intPy_fclose(FILE*file)
Close a file that was opened by
.
On success, return 0. On error, return EOF and errno is set to indicate the error. In either case, any further access (including another call to
) to the stream results in undefined behavior.
Added in version 3.14.
System Functions
These are utility functions that make functionality from the
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.
*PySys_GetAttr(
*name)
Part of the
since version 3.15.Get the attribute name of the
module. Return a
. Raise
and return NULL if it does not exist or if the sys module cannot be found.
If the non-existing object should not be treated as a failure, you can use
instead.
Added in version 3.15.
*PySys_GetAttrString(constchar*name)
Part of the
since version 3.15.This is the same as
, but name is specified as a constchar* UTF-8 encoded bytes string, rather than a
*.
If the non-existing object should not be treated as a failure, you can use
instead.
Added in version 3.15.
intPySys_GetOptionalAttr(
*name,
**result)
Part of the
since version 3.15.Variant of
which doesn’t raise exception if the object does not exist.
Set *result to a new
to the object and return 1 if the object exists.
Set *result to NULL and return 0 without setting an exception if the object does not exist.
Set an exception, set *result to NULL, and return -1, if an error occurred.
Added in version 3.15.
intPySys_GetOptionalAttrString(constchar*name,
**result)
Part of the
since version 3.15.This is the same as
, but name is specified as a constchar* UTF-8 encoded bytes string, rather than a
*.
Added in version 3.15.
*PySys_GetObject(constchar*name)
Return value: Borrowed reference. Part of the
.Similar to
, but return a
and return NULLwithout setting exception on failure.
Preserves exception that was set before the call.
intPySys_SetObject(constchar*name,
*v)
Part of the
.Set name in the
module to v unless v is NULL, in which case name is deleted from the sys module. Returns 0 on success, -1 on error.
voidPySys_WriteStdout(constchar*format, ...)
Part of the
.Write the output string described by format to
. 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
is unset, the formatted message is written to the real (C level) stdout.
voidPySys_WriteStderr(constchar*format, ...)
Part of the
.As
, but write to
or stderr instead.
voidPySys_FormatStdout(constchar*format, ...)
Part of the
.Function similar to PySys_WriteStdout() but format the message using
and don’t truncate the message to an arbitrary length.
Added in version 3.2.
voidPySys_FormatStderr(constchar*format, ...)
Part of the
.As
, but write to
or stderr instead.
Added in version 3.2.
*PySys_GetXOptions()
Return value: Borrowed reference. Part of the
since version 3.7.Return the current dictionary of
options, similarly to
. On error, NULL is returned and an exception is set.
Added in version 3.2.
intPySys_Audit(constchar*event, constchar*format, ...)
Part of the
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
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.
Note that # format characters should always be treated as
, regardless of whether PY_SSIZE_T_CLEAN was defined.
performs the same function from Python code.
See also
.
Added in version 3.8.
Changed in version 3.8.2: Require
for # format characters. Previously, an unavoidable deprecation warning was raised.
intPySys_AuditTuple(constchar*event,
*args)
Part of the
since version 3.13.Similar to
, but pass arguments as a Python object. args must be a
. To pass no arguments, args can be NULL.
Added in version 3.13.
intPySys_AddAuditHook(
hook, void*userData)
Append the callable 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 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.
This function is safe to call before
. When called after runtime initialization, existing audit hooks are notified and may silently abort the operation by raising an error subclassed from
(other errors will not be silenced).
The hook function is always called with an
by the Python interpreter that raised the event.
See
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 with no arguments. If any existing hooks raise an exception derived from
, 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.
typedefint(*Py_AuditHookFunction)(constchar*event,
*args,void*userData)
The type of the hook function. event is the C string event argument passed to
or
. args is guaranteed to be a
. userData is the argument passed to PySys_AddAuditHook().
Added in version 3.8.
Changed in version 3.8.1: Exceptions derived from
but not
are no longer suppressed.
Process Control
voidPy_FatalError(constchar*message)
Part of the
.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 file.
The Py_FatalError() function is replaced with a macro which logs automatically the name of the current function, unless the Py_LIMITED_API macro is defined.
Changed in version 3.9: Log the function name automatically.
voidPy_Exit(intstatus)
Part of the
.Exit the current process. This calls
and then calls the standard C library function exit(status). If Py_FinalizeEx() indicates an error, the exit status is set to 120.
Changed in version 3.6: Errors from finalization no longer ignored.
intPy_AtExit(void(*func)())
Part of the
.Register a cleanup function to be called by
. 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,
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.