Skip to content

gh-143883: Add missing named parameters in public PyModExport C bindings #143884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
encukou merged 6 commits into from
Jan 27, 2026
Merged

gh-143883: Add missing named parameters in public PyModExport C bindings #143884

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
50108c5
Add missing named parameters in public PyModExport C bindings (gh-143…
ngoldbaum Jan 15, 2026
3833584
Rename PyModule_GetToken argument to mod
ngoldbaum Jan 16, 2026
9e93f02
Update argument names in the docs
ngoldbaum Jan 16, 2026
f7927d3
Switch back to `module`
encukou Jan 23, 2026
b195a1c
Merge pull request #1 from encukou/fix-wrapper-decl
ngoldbaum Jan 26, 2026
7f61488
Remove repetition
encukou Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Doc/c-api/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,10 +426,10 @@ To retrieve the state from a given module, use the following functions:
module state.


.. c:function:: int PyModule_GetStateSize(PyObject *, Py_ssize_t *result)
.. c:function:: int PyModule_GetStateSize(PyObject *module, Py_ssize_t *result)

Set *\*result* to the size of the module's state, as specified using
:c:macro:`Py_mod_state_size` (or :c:member:`PyModuleDef.m_size`),
Set *\*result* to the size of the state for the module *module*, as specified
Comment thread
encukou marked this conversation as resolved.
Outdated
using :c:macro:`Py_mod_state_size` (or :c:member:`PyModuleDef.m_size`),
and return 0.

On error, set *\*result* to -1, and return -1 with an exception set.
Expand Down Expand Up @@ -597,7 +597,7 @@ A module's token -- and the *your_token* value to use in the above code -- is:

.. c:function:: int PyModule_GetToken(PyObject *module, void** result)

Set *\*result* to the module's token and return 0.
Set *\*result* to the module token for the module *module* and return 0.
Comment thread
encukou marked this conversation as resolved.
Outdated

On error, set *\*result* to NULL, and return -1 with an exception set.

Expand Down Expand Up @@ -645,7 +645,7 @@ rather than from an extension's :ref:`export hook <extension-export-hook>`.

.. c:function:: int PyModule_Exec(PyObject *module)

Execute the :c:data:`Py_mod_exec` slot(s) of the given *module*.
Execute the :c:data:`Py_mod_exec` slot(s) of the given module, *module*.
Comment thread
encukou marked this conversation as resolved.
Outdated

On success, return 0.
On error, return -1 with an exception set.
Expand Down
8 changes: 4 additions & 4 deletions Include/moduleobject.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,11 @@ PyAPI_FUNC(int) PyUnstable_Module_SetGIL(PyObject *module, void *gil);
#endif

#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= _Py_PACK_VERSION(3, 15)
PyAPI_FUNC(PyObject *) PyModule_FromSlotsAndSpec(const PyModuleDef_Slot *,
PyAPI_FUNC(PyObject *) PyModule_FromSlotsAndSpec(const PyModuleDef_Slot *slots,
PyObject *spec);
PyAPI_FUNC(int) PyModule_Exec(PyObject *mod);
PyAPI_FUNC(int) PyModule_GetStateSize(PyObject *mod, Py_ssize_t *result);
PyAPI_FUNC(int) PyModule_GetToken(PyObject *, void **result);
PyAPI_FUNC(int) PyModule_Exec(PyObject *module);
PyAPI_FUNC(int) PyModule_GetStateSize(PyObject *module, Py_ssize_t *result);
PyAPI_FUNC(int) PyModule_GetToken(PyObject *module, void **result);
#endif

#ifndef _Py_OPAQUE_PYOBJECT
Expand Down
Loading