55Operating System Utilities
66==========================
77
8+
89.. c :function :: PyObject* PyOS_FSPath (PyObject *path)
910
1011 Return the file system representation for *path *. If the object is a
@@ -95,27 +96,30 @@ Operating System Utilities
9596
9697.. c :function :: int PyOS_CheckStack ()
9798
99+ .. index:: single: USE_STACKCHECK (C macro)
100+
98101 Return true when the interpreter runs out of stack space. This is a reliable
99- check, but is only available when :c:macro:`USE_STACKCHECK` is defined (currently
102+ check, but is only available when :c:macro:`! USE_STACKCHECK` is defined (currently
100103 on certain versions of Windows using the Microsoft Visual C++ compiler).
101- :c:macro:`USE_STACKCHECK` will be defined automatically; you should never
104+ :c:macro:`! USE_STACKCHECK` will be defined automatically; you should never
102105
103106
104107
108+ .. c :type :: void (*PyOS_sighandler_t)(int )
109+
110+
105111c :function :: PyOS_sighandler_t PyOS_getsig (int i)
106112
107113 Return the current signal handler for signal *i*. This is a thin wrapper around
108114 either :c:func:`!sigaction` or :c:func:`!signal`. Do not call those functions
109- directly! :c:type:`PyOS_sighandler_t` is a typedef alias for :c:expr:`void
110- (\* )(int)`.
115+ directly!
111116
112117
113118.. c:function:: PyOS_sighandler_t PyOS_setsig(int i, PyOS_sighandler_t h)
114119
115120 Set the signal handler for signal *i* to be *h*; return the old signal handler.
116121:c:func: `!sigaction ` or :c:func: `!signal `. Do
117- not call those functions directly! :c:type: `PyOS_sighandler_t ` is a typedef
118- alias for :c:expr: `void (\* )(int) `.
122+ not call those functions directly!
119123
120124.. c :function :: wchar_t * Py_DecodeLocale (const char* arg, size_t *size)
121125
@@ -378,10 +382,8 @@ accessible to C code. They all work with the current interpreter thread's
378382 silently abort the operation by raising an error subclassed from
379383 :class: `Exception ` (other errors will not be silenced).
380384
381- The hook function is of type :c:expr:`int (*)(const char *event, PyObject
382- *args, void *userData)`, where *args * is guaranteed to be a
383- :c:type: `PyTupleObject `. The hook function is always called with the GIL
384- held by the Python interpreter that raised the event.
385+ The hook function is always called with the GIL held by the Python
386+ interpreter that raised the event.
385387
386388 See :pep:`578` for a detailed description of auditing. Functions in the
387389 runtime and standard library that raise events are listed in the
@@ -390,12 +392,20 @@ accessible to C code. They all work with the current interpreter thread's
390392
391393 .. audit-event:: sys.addaudithook "" c.PySys_AddAuditHook
392394
393- If the interpreter is initialized, this function raises a auditing event
395+ If the interpreter is initialized, this function raises an auditing event
394396 ``sys.addaudithook`` with no arguments. If any existing hooks raise an
395397 exception derived from :class:`Exception`, the new hook will not be
396398 added and the exception is cleared. As a result, callers cannot assume
397399 that their hook has been added unless they control all existing hooks.
398400
401+ .. c:namespace:: NULL
402+ .. c:type:: int (*Py_AuditHookFunction) (const char *event, PyObject *args, void *userData)
403+
404+ The type of the hook function.
405+ *event * is the C string event argument passed to :c:func: `PySys_Audit `.
406+ *args * is guaranteed to be a :c:type: `PyTupleObject `.
407+ *userData * is the argument passed to PySys_AddAuditHook().
408+
399409 .. versionadded :: 3.8
400410
401411
0 commit comments