Skip to content

gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init #135126

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 5 commits into from
Jun 13, 2025
Merged

gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init #135126

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39b670d
gh-134160: Split extension module init from PyModule docs; emphasize …
encukou Jun 3, 2025
e706afd
Apply suggestions from code review
encukou Jun 5, 2025
fe2f5b6
Single-phase init shares objects across interpreters
encukou Jun 6, 2025
a53f207
Apply suggestions from code review
encukou Jun 12, 2025
5380348
Update Setuptools URL
encukou Jun 13, 2025
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
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
  • Loading branch information
@encukou @StanFromIreland
encukou and StanFromIreland authored Jun 5, 2025
commit e706afd831ecf18e483b113d60aee57ec61babb7
8 changes: 4 additions & 4 deletions Doc/c-api/extension-modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ and must be named after the module name plus an extension listed in
Building, packaging and distributing extension modules is best done with
third-party tools, and is out of scope of this document.
One suitable tool is ``setuptools``, whose documentation can be found at
Comment thread
encukou marked this conversation as resolved.
Outdated
https://setuptools.readthedocs.io/en/latest/setuptools.html.
https://setuptools.pypa.io/en/latest/setuptools.html.

Normally, the initialization function returns a module definition initialized
using :c:func:`PyModuleDef_Init`.
Expand Down Expand Up @@ -60,7 +60,7 @@ This mirrors the behavior of pure-Python modules.

Additional module instances may be created in
:ref:`sub-interpreters <sub-interpreter-support>`
or after after Python runtime reinitialization
or after Python runtime reinitialization
(:c:func:`Py_Finalize` and :c:func:`Py_Initialize`).
In these cases, sharing Python objects between module instances would likely
cause crashes or undefined behavior.
Expand Down Expand Up @@ -88,7 +88,7 @@ the :c:data:`Py_mod_multiple_interpreters` slot.
Initialization function
.......................

The initialization function defined by an extension module have the
The initialization function defined by an extension module has the
following signature:

.. c:function:: PyObject* PyInit_modulename(void)
Expand Down Expand Up @@ -167,7 +167,7 @@ using the following function:
Return *def* cast to ``PyObject*``, or ``NULL`` if an error occurred.

Calling this function is required for :ref:`multi-phase-initialization`.
It should not be used other contexts.
It should not be used in other contexts.

Note that Python assumes that ``PyModuleDef`` structures are statically
allocated.
Expand Down