gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)

This commit is contained in:
Petr Viktorin 2024-09-18 14:15:43 +02:00 committed by GitHub
parent 42c8b0556c
commit 32119fc377
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 42 additions and 2 deletions

View File

@ -1004,6 +1004,7 @@ the variables:
single: PyExc_OverflowError (C var) single: PyExc_OverflowError (C var)
single: PyExc_PermissionError (C var) single: PyExc_PermissionError (C var)
single: PyExc_ProcessLookupError (C var) single: PyExc_ProcessLookupError (C var)
single: PyExc_PythonFinalizationError (C var)
single: PyExc_RecursionError (C var) single: PyExc_RecursionError (C var)
single: PyExc_ReferenceError (C var) single: PyExc_ReferenceError (C var)
single: PyExc_RuntimeError (C var) single: PyExc_RuntimeError (C var)
@ -1096,6 +1097,8 @@ the variables:
+-----------------------------------------+---------------------------------+----------+ +-----------------------------------------+---------------------------------+----------+
| :c:data:`PyExc_ProcessLookupError` | :exc:`ProcessLookupError` | | | :c:data:`PyExc_ProcessLookupError` | :exc:`ProcessLookupError` | |
+-----------------------------------------+---------------------------------+----------+ +-----------------------------------------+---------------------------------+----------+
| :c:data:`PyExc_PythonFinalizationError` | :exc:`PythonFinalizationError` | |
+-----------------------------------------+---------------------------------+----------+
| :c:data:`PyExc_RecursionError` | :exc:`RecursionError` | | | :c:data:`PyExc_RecursionError` | :exc:`RecursionError` | |
+-----------------------------------------+---------------------------------+----------+ +-----------------------------------------+---------------------------------+----------+
| :c:data:`PyExc_ReferenceError` | :exc:`ReferenceError` | | | :c:data:`PyExc_ReferenceError` | :exc:`ReferenceError` | |

View File

@ -509,6 +509,8 @@ distinguished from a number. Use :c:func:`PyErr_Occurred` to disambiguate.
Currently, ``-1`` corresponds to Currently, ``-1`` corresponds to
``Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER``. ``Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER``.
.. c:namespace:: NULL
============================================= ====== ============================================= ======
Flag Value Flag Value
============================================= ====== ============================================= ======

View File

@ -421,6 +421,8 @@ The available slot types are:
Specifies one of the following values: Specifies one of the following values:
.. c:namespace:: NULL
.. c:macro:: Py_MOD_GIL_USED .. c:macro:: Py_MOD_GIL_USED
The module depends on the presence of the global interpreter lock (GIL), The module depends on the presence of the global interpreter lock (GIL),

View File

@ -133,7 +133,7 @@ Managing the Monitoring State
Monitoring states can be managed with the help of monitoring scopes. A scope Monitoring states can be managed with the help of monitoring scopes. A scope
would typically correspond to a python function. would typically correspond to a python function.
.. :c:function:: int PyMonitoring_EnterScope(PyMonitoringState *state_array, uint64_t *version, const uint8_t *event_types, Py_ssize_t length) .. c:function:: int PyMonitoring_EnterScope(PyMonitoringState *state_array, uint64_t *version, const uint8_t *event_types, Py_ssize_t length)
Enter a monitored scope. ``event_types`` is an array of the event IDs for Enter a monitored scope. ``event_types`` is an array of the event IDs for
events that may be fired from the scope. For example, the ID of a ``PY_START`` events that may be fired from the scope. For example, the ID of a ``PY_START``
@ -158,7 +158,35 @@ would typically correspond to a python function.
execution is paused, such as when emulating a generator, the scope needs to execution is paused, such as when emulating a generator, the scope needs to
be exited and re-entered. be exited and re-entered.
The macros for *event_types* are:
.. :c:function:: int PyMonitoring_ExitScope(void) .. c:namespace:: NULL
.. The table is here to make the docs searchable, and to allow automatic
links to the identifiers.
================================================== =====================================
Macro Event
================================================== =====================================
.. c:macro:: PY_MONITORING_EVENT_BRANCH :monitoring-event:`BRANCH`
.. c:macro:: PY_MONITORING_EVENT_CALL :monitoring-event:`CALL`
.. c:macro:: PY_MONITORING_EVENT_C_RAISE :monitoring-event:`C_RAISE`
.. c:macro:: PY_MONITORING_EVENT_C_RETURN :monitoring-event:`C_RETURN`
.. c:macro:: PY_MONITORING_EVENT_EXCEPTION_HANDLED :monitoring-event:`EXCEPTION_HANDLED`
.. c:macro:: PY_MONITORING_EVENT_INSTRUCTION :monitoring-event:`INSTRUCTION`
.. c:macro:: PY_MONITORING_EVENT_JUMP :monitoring-event:`JUMP`
.. c:macro:: PY_MONITORING_EVENT_LINE :monitoring-event:`LINE`
.. c:macro:: PY_MONITORING_EVENT_PY_RESUME :monitoring-event:`PY_RESUME`
.. c:macro:: PY_MONITORING_EVENT_PY_RETURN :monitoring-event:`PY_RETURN`
.. c:macro:: PY_MONITORING_EVENT_PY_START :monitoring-event:`PY_START`
.. c:macro:: PY_MONITORING_EVENT_PY_THROW :monitoring-event:`PY_THROW`
.. c:macro:: PY_MONITORING_EVENT_PY_UNWIND :monitoring-event:`PY_UNWIND`
.. c:macro:: PY_MONITORING_EVENT_PY_YIELD :monitoring-event:`PY_YIELD`
.. c:macro:: PY_MONITORING_EVENT_RAISE :monitoring-event:`RAISE`
.. c:macro:: PY_MONITORING_EVENT_RERAISE :monitoring-event:`RERAISE`
.. c:macro:: PY_MONITORING_EVENT_STOP_ITERATION :monitoring-event:`STOP_ITERATION`
================================================== =====================================
.. c:function:: int PyMonitoring_ExitScope(void)
Exit the last scope that was entered with ``PyMonitoring_EnterScope``. Exit the last scope that was entered with ``PyMonitoring_EnterScope``.

View File

@ -132,6 +132,8 @@ nitpick_ignore = [
('c:func', 'vsnprintf'), ('c:func', 'vsnprintf'),
# Standard C types # Standard C types
('c:type', 'FILE'), ('c:type', 'FILE'),
('c:type', 'int8_t'),
('c:type', 'int16_t'),
('c:type', 'int32_t'), ('c:type', 'int32_t'),
('c:type', 'int64_t'), ('c:type', 'int64_t'),
('c:type', 'intmax_t'), ('c:type', 'intmax_t'),
@ -141,6 +143,8 @@ nitpick_ignore = [
('c:type', 'size_t'), ('c:type', 'size_t'),
('c:type', 'ssize_t'), ('c:type', 'ssize_t'),
('c:type', 'time_t'), ('c:type', 'time_t'),
('c:type', 'uint8_t'),
('c:type', 'uint16_t'),
('c:type', 'uint32_t'), ('c:type', 'uint32_t'),
('c:type', 'uint64_t'), ('c:type', 'uint64_t'),
('c:type', 'uintmax_t'), ('c:type', 'uintmax_t'),
@ -244,6 +248,7 @@ nitpick_ignore += [
('c:data', 'PyExc_OverflowError'), ('c:data', 'PyExc_OverflowError'),
('c:data', 'PyExc_PermissionError'), ('c:data', 'PyExc_PermissionError'),
('c:data', 'PyExc_ProcessLookupError'), ('c:data', 'PyExc_ProcessLookupError'),
('c:data', 'PyExc_PythonFinalizationError'),
('c:data', 'PyExc_RecursionError'), ('c:data', 'PyExc_RecursionError'),
('c:data', 'PyExc_ReferenceError'), ('c:data', 'PyExc_ReferenceError'),
('c:data', 'PyExc_RuntimeError'), ('c:data', 'PyExc_RuntimeError'),