gh-149716: Document PySlot_DATA for Py_mod_gil and Py_mod_multiple_interpreters (GH-150053)

Add short code examples mirroring the existing Py_mod_abi example,
so it is clear which slot definition macro (PySlot_DATA, PySlot_INT64,
or PySlot_UINT64) to use for these two slots.
This commit is contained in:
Taeknology
2026-06-10 19:10:15 +09:00
committed by GitHub
parent 7a014f44c3
commit 11c93d6df3
+17
View File
@@ -247,6 +247,15 @@ Feature slots
If ``Py_mod_multiple_interpreters`` is not specified, the import
machinery defaults to ``Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED``.
For historical reasons, the values are declared as pointers (``void *``).
When using :c:type:`PySlot` arrays, use :c:macro:`PySlot_DATA` for
:c:macro:`!Py_mod_multiple_interpreters`:
.. code-block:: c
PySlot_DATA(Py_mod_multiple_interpreters,
Py_MOD_PER_INTERPRETER_GIL_SUPPORTED)
.. versionadded:: 3.12
.. c:macro:: Py_mod_gil
@@ -272,6 +281,14 @@ Feature slots
If ``Py_mod_gil`` is not specified, the import machinery defaults to
``Py_MOD_GIL_USED``.
For historical reasons, the values are declared as pointers (``void *``).
When using :c:type:`PySlot` arrays, use :c:macro:`PySlot_DATA` for
:c:macro:`!Py_mod_gil`:
.. code-block:: c
PySlot_DATA(Py_mod_gil, Py_MOD_GIL_NOT_USED)
.. versionadded:: 3.13