Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-134160: Use multi-phase init in documentation examples#134296

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.

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

Already on GitHub?Sign in to your account

Merged
AA-Turner merged 24 commits intopython:mainfromneonene:multi
May 26, 2025

Conversation

neonene
Copy link
Contributor

@neoneneneonene commentedMay 19, 2025
edited by github-actionsbot
Loading

ReplacesPyModule_Create() withPyModuleDef_Init().

Static types still remain unchanged in the doc.


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

@neonene
Copy link
ContributorAuthor

cc@erlend-aasland@encukou Just in case you're interested.

@AA-TurnerAA-Turner changed the titlegh-134160: Docs: Ensure single-phase init is no longer used in examplesgh-134160: Use multi-phase init in documentation examplesMay 21, 2025
@AA-TurnerAA-Turner added the docsDocumentation in the Doc dir labelMay 21, 2025
@AA-TurnerAA-Turner added needs backport to 3.13bugs and security fixes needs backport to 3.14bugs and security fixes labelsMay 21, 2025
Comment on lines 254 to 258
static PyModuleDef_Slot emb_module_slots[] = {
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
{Py_mod_gil, Py_MOD_GIL_NOT_USED},
{0, NULL}
};
Copy link
Member

@AA-TurnerAA-TurnerMay 22, 2025
edited
Loading

Choose a reason for hiding this comment

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

Having done trial conversions of NumPy to multi-phase, I think we should include the relevant PY_VERSION_HEX checks. Both Py_mod_multiple_interpreters and Py_mod_gil were added very recently.

If we agree on adding these checks, we should add them for all relevant PyModuleDef_Slot structs. It is verbose, but aids in the copy-and-paste scenario.

Suggested change
static PyModuleDef_Slot emb_module_slots[] = {
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
{Py_mod_gil, Py_MOD_GIL_NOT_USED},
{0, NULL}
};
static PyModuleDef_Slot emb_module_slots[] = {
#if PY_VERSION_HEX >= 0x030C00F0 // Python 3.12+
// signal that this module can be imported in isolated subinterpreters
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
#endif
#if PY_VERSION_HEX >= 0x030D00F0 // Python 3.13+
// signal that this module supports running without an active GIL
{Py_mod_gil, Py_MOD_GIL_NOT_USED},
#endif
{0, NULL}
};

Copy link
Member

Choose a reason for hiding this comment

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

Alternative:

Suggested change
static PyModuleDef_Slot emb_module_slots[] = {
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
{Py_mod_gil, Py_MOD_GIL_NOT_USED},
{0, NULL}
};
static PyModuleDef_Slot emb_module_slots[] = {
#ifdef Py_mod_multiple_interpreters
// signal that this module can be imported in isolated subinterpreters
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
#endif
#ifdef Py_mod_gil
// signal that this module supports running without an active GIL
{Py_mod_gil, Py_MOD_GIL_NOT_USED},
#endif
{0, NULL}
};

neonene reacted with thumbs up emoji
Copy link
Member

Choose a reason for hiding this comment

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

Canthis PR omit these slots entirely?

IMO, they should be introduced later, after you compile your first module, along with a longer discussion about isolated state & thread safety.

AA-Turner reacted with thumbs up emoji
Copy link
Member

Choose a reason for hiding this comment

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

Agree better to keep simple.@neonene perhaps remove the gil and interpreter slots from where we've added them in this PR unless they were already present?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Removed, but not all. I can complete.

@AA-Turner
Copy link
Member

Other places to update:

neoneneand others added3 commitsMay 22, 2025 16:05
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@neonene
Copy link
ContributorAuthor

Other places to update:

I tried, but I conclude thatPyModule_Create() needs to be deprecated.

@neonene
Copy link
ContributorAuthor

@AA-TurnerAA-Turnerenabled auto-merge (squash)May 26, 2025 21:39
@AA-TurnerAA-Turner merged commit96905bd intopython:mainMay 26, 2025
24 checks passed
@github-project-automationgithub-project-automationbot moved this fromTodo toDone inDocs PRsMay 26, 2025
@miss-islington-app
Copy link

Thanks@neonene for the PR, and@AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 26, 2025
…onGH-134296)(cherry picked from commit96905bd)Co-authored-by: neonene <53406459+neonene@users.noreply.github.com>Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 26, 2025
…onGH-134296)(cherry picked from commit96905bd)Co-authored-by: neonene <53406459+neonene@users.noreply.github.com>Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

GH-134753 is a backport of this pull request to the3.14 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.14bugs and security fixes labelMay 26, 2025
@bedevere-app
Copy link

GH-134754 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelMay 26, 2025
AA-Turner added a commit that referenced this pull requestMay 26, 2025
…134296) (#134753)gh-134160: Use multi-phase init in documentation examples (GH-134296)(cherry picked from commit96905bd)Co-authored-by: neonene <53406459+neonene@users.noreply.github.com>Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this pull requestMay 26, 2025
…134296) (#134754)gh-134160: Use multi-phase init in documentation examples (GH-134296)(cherry picked from commit96905bd)Co-authored-by: neonene <53406459+neonene@users.noreply.github.com>Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Comment on lines +206 to +208
You can also define a new exception that is unique to your module.
For this, you can declare a static global object variable at the beginning
of the file::
Copy link
Member

Choose a reason for hiding this comment

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

This isnot correct for multi-phase initialization, without preventing theexec function from other module instances from overriding this pointer.

Copy link
Member

Choose a reason for hiding this comment

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

@encukou I added but then reverted (6e5b1c5) module state for this error type -- should we un-revert that commit? Sorry for my mistake here.

A

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine -- module state deserves a better explanation a bit later in the tutorial. And theImportError being added in the next PR is a good thing to show.

The main thing I'd do differently is not backporting to 3.13 -- that's like pushing directly to production. 3.14 is out in a few months; that sounds like a good amount of time for this all to spend in prerelease.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@encukouencukouencukou left review comments

@AA-TurnerAA-TurnerAA-Turner approved these changes

@ericsnowcurrentlyericsnowcurrentlyAwaiting requested review from ericsnowcurrently

Assignees
No one assigned
Labels
docsDocumentation in the Doc dirskip news
Projects
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@neonene@AA-Turner@encukou

[8]ページ先頭

©2009-2025 Movatter.jp