gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init #135126
+386
−210
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…asize multi-phase init Document behaviour of single-phase init. Call it "legacy". Reorganize PyModule docs. Move PyInit_modulename docs from the tutorial to reference documentation. Move PyMODINIT_FUNC docs from generic macros to the new page. Add doc stubs for `PYTHON_API_VERSION` & `PYTHON_ABI_VERSION` Remove incorrect refcounts.dat entry for `PyModuleDef_Init`. This removes the "Return value: Borrowed reference." note. Instead, note that the function sometimes returns a borrowed reference, sometimes as strong one. (IMO, it's best to not think of `PyModuleDef` as a `PyObject` at all, and act like it can't be reference-counted.) Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Stan Ulbrych <[email protected]>
|
Thank you! |
hugovk
approved these changes
Jun 11, 2025
Comment on lines
+5
to
+6
| Defining Extension Modules | ||
| -------------------------- |
There was a problem hiding this comment.
Use sentence case for headers:
Suggested change
| Defining Extension Modules | |
| -------------------------- | |
| Defining extension modules | |
| -------------------------- |
|
|
||
| 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 |
There was a problem hiding this comment.
Suggested change
| One suitable tool is ``setuptools``, whose documentation can be found at | |
| One suitable tool is Setuptools, whose documentation can be found at |
| By default, extension modules are not singletons. | ||
| For example, if the :py:attr:`sys.modules` entry is removed and the module | ||
| is re-imported, a new module object is created, and typically populated with | ||
| fresh method and type objects. |
There was a problem hiding this comment.
?
Suggested change
| fresh method and type objects. | |
| fresh methods and type objects. |
| defining multiple initialization functions. However, importing them requires | ||
| using symbolic links or a custom importer, because by default only the | ||
| function corresponding to the filename is found. | ||
| See the *"Multiple modules in one library"* section in :pep:`489` for details. |
There was a problem hiding this comment.
Add a direct link to this section?
| @@ -111,33 +111,11 @@ Useful macros | |||
| ============= | |||
|
|
|||
| Several useful macros are defined in the Python header files. Many are | |||
| defined closer to where they are useful (e.g. :c:macro:`Py_RETURN_NONE`). | |||
| defined closer to where they are useful (e.g. :c:macro:`Py_RETURN_NONE`, | |||
There was a problem hiding this comment.
Suggested change
| defined closer to where they are useful (e.g. :c:macro:`Py_RETURN_NONE`, | |
| defined closer to where they are useful (for example, :c:macro:`Py_RETURN_NONE`, |
Comment on lines
+26
to
+30
| One suitable tool is ``setuptools``, whose documentation can be found at | ||
| https://setuptools.readthedocs.io/en/latest/setuptools.html. | ||
|
|
||
| The :mod:`distutils` module, which was included in the standard library | ||
| until Python 3.12, is now maintained as part of ``setuptools``. |
There was a problem hiding this comment.
Suggested change
| One suitable tool is ``setuptools``, whose documentation can be found at | |
| https://setuptools.readthedocs.io/en/latest/setuptools.html. | |
| The :mod:`distutils` module, which was included in the standard library | |
| until Python 3.12, is now maintained as part of ``setuptools``. | |
| One suitable tool is Setuptools, whose documentation can be found at | |
| https://setuptools.readthedocs.io/en/latest/setuptools.html. | |
| The :mod:`distutils` module, which was included in the standard library | |
| until Python 3.12, is now maintained as part of Setuptools. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#134764 moved a section around; I don't think that's enough.
Split extension module init from
PyModuledocs; emphasize multi-phase initThere's a difference between working with module objects in general
(which just needs garden-variety API docs), and defining the init
function (which covers things like correctly exporting a function
defined by the user, and lots of behaviour that's unrelated to generic
module objects).
Document behaviour of single-phase init. Call it "legacy".
Reorganize
PyModuledocs.Move PyInit_modulename docs from the tutorial, and PyMODINIT_FUNC docs
from the generic macros section, to the new page.
Add docs
Add doc stubs for
PYTHON_API_VERSION&PYTHON_ABI_VERSIONRemove incorrect
refcounts.datentry forPyModuleDef_Init;instead note that the function sometimes returns a borrowed reference,
sometimes as strong one.
(IMO, it's best to pretend
PyModuleDefisn't aPyObjectat all,but, reference docs should be correct.)
📚 Documentation preview 📚: https://cpython-previews--135126.org.readthedocs.build/