gh-141004: Document PyOS_InterruptOccurred (GH-141526)
This commit is contained in:
@@ -123,6 +123,24 @@ Operating System Utilities
|
||||
This is a thin wrapper around either :c:func:`!sigaction` or :c:func:`!signal`. Do
|
||||
not call those functions directly!
|
||||
|
||||
|
||||
.. c:function:: int PyOS_InterruptOccurred(void)
|
||||
|
||||
Check if a :c:macro:`!SIGINT` signal has been received.
|
||||
|
||||
Returns ``1`` if a :c:macro:`!SIGINT` has occurred and clears the signal flag,
|
||||
or ``0`` otherwise.
|
||||
|
||||
In most cases, you should prefer :c:func:`PyErr_CheckSignals` over this function.
|
||||
:c:func:`!PyErr_CheckSignals` invokes the appropriate signal handlers
|
||||
for all pending signals, allowing Python code to handle the signal properly.
|
||||
This function only detects :c:macro:`!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 :term:`attached thread state`.
|
||||
|
||||
|
||||
.. c:function:: wchar_t* Py_DecodeLocale(const char* arg, size_t *size)
|
||||
|
||||
.. warning::
|
||||
|
||||
Reference in New Issue
Block a user