Utilitários do sistema operacional¶
-
PyObject*
PyOS_FSPath
(PyObject *path)¶ - Return value: New reference.
Return the file system representation for path. If the object is a
str
orbytes
object, then its reference count is incremented. If the object implements theos.PathLike
interface, then__fspath__()
is returned as long as it is astr
orbytes
object. OtherwiseTypeError
is raised andNULL
is returned.Novo na versão 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 global flagPy_InteractiveFlag
is true, this function also returns true if the filename pointer isNULL
or if the name is equal to one of the strings'<stdin>'
or'???'
.
-
void
PyOS_BeforeFork
()¶ Função para preparar algum estado interno antes de ser feito um fork do processo. Isso deve ser chamado antes de chamar
fork()
ou qualquer função semelhante que clone o processo atual. Disponível apenas em sistemas ondefork()
é definido.Aviso
A chamada C
fork()
só deve ser feita a partir da thread “main” (do interpretador “main”). O mesmo vale paraPyOS_BeforeFork()
.Novo na versão 3.7.
-
void
PyOS_AfterFork_Parent
()¶ Função para atualizar algum estado interno depois de ser feito um fork do processo. Isso deve ser chamado a partir do processo pai depois de chamar
fork()
ou qualquer função semelhante que clone o processo atual, independentemente da clonagem do processo ter sido bem-sucedida ou não. Disponível apenas em sistemas ondefork()
é definido.Aviso
A chamada C
fork()
só deve ser feita a partir da thread “main” (do interpretador “main”). O mesmo vale paraPyOS_AfterFork_Parent()
.Novo na versão 3.7.
-
void
PyOS_AfterFork_Child
()¶ Função para atualizar o estado interno do interpretador depois de ser feito um fork do processo. Isso deve ser chamado a partir do processo filho depois de chamar
fork()
ou qualquer função semelhante que clone o processo atual, se houver alguma chance do processo ter uma chamada de retorno para o interpretador Python. Disponível apenas em sistemas ondefork()
é definido.Aviso
A chamada C
fork()
só deve ser feita a partir da thread “main” (do interpretador “main”). O mesmo vale paraPyOS_AfterFork_Child()
.Novo na versão 3.7.
Ver também
os.register_at_fork()
permite registrar funções personalizadas do Python para serem chamadas porPyOS_BeforeFork()
,PyOS_AfterFork_Parent()
ePyOS_AfterFork_Child()
.
-
void
PyOS_AfterFork
()¶ Função para atualizar algum estado interno após ser feito um fork de processo; isso deve ser chamado no novo processo se o interpretador do Python continuar a ser usado. Se um novo executável é carregado no novo processo, esta função não precisa ser chamada.
Obsoleto desde a versão 3.7: Esta função foi sucedida por
PyOS_AfterFork_Child()
.
-
int
PyOS_CheckStack
()¶ Retorna verdadeiro quando o interpretador ficar sem espaço de pilha. Esta é uma verificação confiável, mas só está disponível quando
USE_STACKCHECK
está definido (atualmente no Windows usando o compilador Microsoft Visual C++).USE_STACKCHECK
será definido automaticamente; você nunca deve mudar a definição em seu próprio código.
-
PyOS_sighandler_t
PyOS_getsig
(int i)¶ Retorna o manipulador de sinal atual para o sinal i. Este é um invólucro fino em torno de
sigaction()
ousignal()
. Não ligue para essas funções diretamente!PyOS_sighandler_t
é um alias de typedef paravoid (*)(int)
.
-
PyOS_sighandler_t
PyOS_setsig
(int i, PyOS_sighandler_t h)¶ Defina o manipulador de sinal para que o sinal i seja h; Devolva o antigo manipulador de sinal. Este é um invólucro fino em torno de
sigaction()
ousignal()
. Não ligue para essas funções diretamente!PyOS_sighandler_t
é um alias de typedef paravoid (*)(int)
.
-
wchar_t*
Py_DecodeLocale
(const char* arg, size_t *size)¶ Decode a byte string from the locale encoding with the surrogateescape error handler: undecodable bytes are decoded as characters in range U+DC80..U+DCFF. If a byte sequence can be decoded as a surrogate character, escape the bytes using the surrogateescape error handler instead of decoding them.
Encoding, highest priority to lowest priority:
UTF-8
on macOS, Android, and VxWorks;UTF-8
on Windows ifPy_LegacyWindowsFSEncodingFlag
is zero;UTF-8
if the Python UTF-8 mode is enabled;ASCII
if theLC_CTYPE
locale is"C"
,nl_langinfo(CODESET)
returns theASCII
encoding (or an alias), andmbstowcs()
andwcstombs()
functions uses theISO-8859-1
encoding.the current locale encoding.
Retorna um ponteiro para uma string de caracteres largos recém-alocada, usa
PyMem_RawFree()
para liberar a memória. Se o tamanho não forNULL
, escreve o número de caracteres largos excluindo o caractere nulo em*size
Retorna
NULL
em erro de decodificação ou erro de alocação de memória. Se size não forNULL
,*size
é definido como(size_t)-1
em erro de memória ou definido como(size_t)-2
em erro de decodificação.Erros de decodificação nunca devem acontecer, a menos que haja um bug na biblioteca C.
Use a função
Py_EncodeLocale()
para codificar a string de caracteres de volta para uma string de bytes.Ver também
As funções
PyUnicode_DecodeFSDefaultAndSize()
ePyUnicode_DecodeLocaleAndSize()
.Novo na versão 3.5.
Alterado na versão 3.7: The function now uses the UTF-8 encoding in the UTF-8 mode.
Alterado na versão 3.8: The function now uses the UTF-8 encoding on Windows if
Py_LegacyWindowsFSEncodingFlag
is zero;
-
char*
Py_EncodeLocale
(const wchar_t *text, size_t *error_pos)¶ Encode a wide character string to the locale encoding with the surrogateescape error handler: surrogate characters in the range U+DC80..U+DCFF are converted to bytes 0x80..0xFF.
Encoding, highest priority to lowest priority:
UTF-8
on macOS, Android, and VxWorks;UTF-8
on Windows ifPy_LegacyWindowsFSEncodingFlag
is zero;UTF-8
if the Python UTF-8 mode is enabled;ASCII
if theLC_CTYPE
locale is"C"
,nl_langinfo(CODESET)
returns theASCII
encoding (or an alias), andmbstowcs()
andwcstombs()
functions uses theISO-8859-1
encoding.the current locale encoding.
The function uses the UTF-8 encoding in the Python UTF-8 mode.
Return a pointer to a newly allocated byte string, use
PyMem_Free()
to free the memory. ReturnNULL
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.Use the
Py_DecodeLocale()
function to decode the bytes string back to a wide character string.Ver também
The
PyUnicode_EncodeFSDefault()
andPyUnicode_EncodeLocale()
functions.Novo na versão 3.5.
Alterado na versão 3.7: The function now uses the UTF-8 encoding in the UTF-8 mode.
Alterado na versão 3.8: The function now uses the UTF-8 encoding on Windows if
Py_LegacyWindowsFSEncodingFlag
is zero.
System Functions¶
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)¶ - Return value: Borrowed reference.
Return the object name from the
sys
module orNULL
if it does not exist, without setting an exception.
-
int
PySys_SetObject
(const char *name, PyObject *v)¶ Set name in the
sys
module to v unless v isNULL
, in which case name is deleted from the sys module. Returns0
on success,-1
on error.
-
void
PySys_ResetWarnOptions
()¶ Reset
sys.warnoptions
to an empty list. This function may be called prior toPy_Initialize()
.
-
void
PySys_AddWarnOption
(const wchar_t *s)¶ Append s to
sys.warnoptions
. This function must be called prior toPy_Initialize()
in order to affect the warnings filter list.
-
void
PySys_AddWarnOptionUnicode
(PyObject *unicode)¶ Append 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
inPy_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 (:
on Unix,;
on 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()
, but write tosys.stderr
or stderr instead.
-
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.Novo na versão 3.2.
-
void
PySys_FormatStderr
(const char *format, ...)¶ As
PySys_FormatStdout()
, but write tosys.stderr
or stderr instead.Novo na versão 3.2.
-
void
PySys_AddXOption
(const wchar_t *s)¶ Parse s as a set of
-X
options and add them to the current options mapping as returned byPySys_GetXOptions()
. This function may be called prior toPy_Initialize()
.Novo na versão 3.2.
-
PyObject *
PySys_GetXOptions
()¶ - Return value: Borrowed reference.
Return the current dictionary of
-X
options, similarly tosys._xoptions
. On error,NULL
is returned and an exception is set.Novo na versão 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 inPy_BuildValue()
are available. If the built value is not a tuple, it will be added into a single-element tuple. (TheN
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.)Note that
#
format characters should always be treated asPy_ssize_t
, regardless of whetherPY_SSIZE_T_CLEAN
was defined.sys.audit()
performs the same function from Python code.Novo na versão 3.8.
Alterado na versão 3.8.2: Require
Py_ssize_t
for#
format characters. Previously, an unavoidable deprecation warning was raised.
-
int
PySys_AddAuditHook
(Py_AuditHookFunction 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.
O ponteiro userData é passado para a função de gancho. Como as funções de gancho podem ser chamadas de diferentes tempos de execução, esse ponteiro não deve se referir diretamente ao estado do Python.
This function is safe to call before
Py_Initialize()
. When called after runtime initialization, existing audit hooks are notified and may silently abort the operation by raising an error subclassed fromException
(other errors will not be silenced).The hook function is of type
int (*)(const char *event, PyObject *args, void *userData)
, where args is guaranteed to be aPyTupleObject
. The hook function is always called with the GIL held by the Python interpreter that raised the event.See PEP 578 for a detailed description of auditing. Functions in the runtime and standard library that raise events are listed in the audit events table. Details are in each function’s documentation.
If the interpreter is initialized, this function raises a auditing event
sys.addaudithook
with no arguments. If any existing hooks raise an exception derived fromException
, 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.Novo na versão 3.8.
Process Control¶
-
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 acore
file.The
Py_FatalError()
function is replaced with a macro which logs automatically the name of the current function, unless thePy_LIMITED_API
macro is defined.Alterado na versão 3.9: Log the function name automatically.
-
void
Py_Exit
(int status)¶ Exit the current process. This calls
Py_FinalizeEx()
and then calls the standard C library functionexit(status)
. IfPy_FinalizeEx()
indicates an error, the exit status is set to 120.Alterado na versão 3.6: Errors from finalization no longer ignored.
-
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()
returns0
; 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.