FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init by encukou · Pull Request #135126 · python/cpython · GitHub

/ cpython Public

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

Merged
encukou merged 5 commits into
python:mainfrom
encukou:prefer-multi-phase-i
Jun 13, 2025
ConversationCommits (5)ChecksFiles changed
Merged

gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init#135126
encukou merged 5 commits into
python:mainfrom
encukou:prefer-multi-phase-i

Conversation

encukou commented Jun 4, 2025 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

#134764 moved a section around; I don't think that's enough.

  • Split extension module init from PyModule docs; emphasize multi-phase init

    There'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 PyModule docs.

  • 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_VERSION

  • Remove incorrect refcounts.dat entry for PyModuleDef_Init;
    instead note that the function sometimes returns a borrowed reference,
    sometimes as strong one.
    (IMO, it's best to pretend PyModuleDef isn't a PyObject at all,
    but, reference docs should be correct.)

📚 Documentation preview 📚: https://cpython-previews--135126.org.readthedocs.build/

pythongh-134160: Split extension module init from PyModule docs; emph…
39b670d 
…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 <9087854+AA-Turner@users.noreply.github.com>
encukou requested a review from AA-Turner June 4, 2025 12:34
bedevere-app Bot mentioned this pull request Jun 4, 2025
Open
encukou mentioned this pull request Jun 4, 2025
Closed
StanFromIreland reviewed Jun 4, 2025
View reviewed changes

StanFromIreland left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

From a quick look, though I assume some are existing errors.

Comment thread Doc/c-api/extension-modules.rst Outdated
Comment thread Doc/c-api/extension-modules.rst Outdated
Comment thread Doc/c-api/extension-modules.rst Outdated
Comment thread Doc/c-api/extension-modules.rst Outdated
Apply suggestions from code review
e706afd 
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

encukou commented Jun 5, 2025

Copy link
Copy Markdown
Member Author

Thank you!

encukou mentioned this pull request Jun 10, 2025
Merged
hugovk approved these changes Jun 11, 2025
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thank you!

Comment thread Doc/c-api/extension-modules.rst Outdated
Comment thread Doc/c-api/extension-modules.rst Outdated
Comment thread Doc/c-api/extension-modules.rst
Comment thread Doc/c-api/extension-modules.rst Outdated
Comment thread Doc/c-api/intro.rst Outdated
Comment thread Doc/extending/building.rst Outdated
Apply suggestions from code review
a53f207 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
StanFromIreland reviewed Jun 12, 2025
View reviewed changes
Comment thread Doc/extending/building.rst Outdated
Update Setuptools URL
5380348 
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
encukou added the needs backport to 3.14 bugs and security fixes label Jun 13, 2025
encukou merged commit f4bc3a9 into python:main Jun 13, 2025

miss-islington-app Bot commented Jun 13, 2025

Copy link
Copy Markdown

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

encukou deleted the prefer-multi-phase-i branch June 13, 2025 14:39
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 13, 2025
pythongh-134160: Split extension module init from PyModule docs; emph…
1f7a3ff 
…asize multi-phase init (pythonGH-135126)

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.)

(cherry picked from commit f4bc3a9)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

bedevere-app Bot commented Jun 13, 2025

Copy link
Copy Markdown

GH-135470 is a backport of this pull request to the 3.14 branch.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jun 13, 2025
hugovk added a commit that referenced this pull request Jun 16, 2025
[3.14] gh-134160: Split extension module init from PyModule docs; emp…
0e0ad7b 
…hasize multi-phase init (GH-135126) (#135470)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
lkollar pushed a commit to lkollar/cpython that referenced this pull request Jun 19, 2025
pythongh-134160: Split extension module init from PyModule docs; emph…
807196f 
…asize multi-phase init (pythonGH-135126)

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 <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
encukou mentioned this pull request Jul 9, 2025
Merged
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
pythongh-134160: Split extension module init from PyModule docs; emph…
289f36b 
…asize multi-phase init (pythonGH-135126)

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 <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025
pythongh-134160: Split extension module init from PyModule docs; emph…
6edcbba 
…asize multi-phase init (pythonGH-135126)

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 <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
pythongh-134160: Split extension module init from PyModule docs; emph…
57e1f84 
…asize multi-phase init (pythonGH-135126)

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 <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

StanFromIreland StanFromIreland left review comments
hugovk hugovk approved these changes
AA-Turner Awaiting requested review from AA-Turner
ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL