Skip to content

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.

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
merged 24 commits into from
May 26, 2025
Merged

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

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8d8b366
Update docs
neonene May 19, 2025
88c5f3f
Don't change an unrelated example
neonene May 20, 2025
a4ade5c
Apply suggestions from code review
neonene May 21, 2025
d6c42e2
ditto
neonene May 21, 2025
97eae13
Suggested module names
neonene May 21, 2025
8ae6bae
Avoid modernization
neonene May 21, 2025
bc78288
typo
neonene May 21, 2025
c3ab022
Correction: "error"
neonene May 21, 2025
d65303c
Rephrase warning
neonene May 21, 2025
aec6781
keywdarg_module
neonene May 21, 2025
7dfd5ad
Update Doc/extending/extending.rst
neonene May 22, 2025
f7c72dd
Indicate xxlimited
neonene May 22, 2025
c84638c
Add seealso to index
neonene May 22, 2025
4e59e88
Update Doc/extending/embedding.rst
neonene May 22, 2025
d68e3e3
ditto (for copy-paste)
neonene May 22, 2025
f6465bd
Shrink slots
neonene May 22, 2025
1a65816
Remove module states
neonene May 22, 2025
a83e266
Correction: "SpamError"
neonene May 22, 2025
2d10958
Add a Py_mod_multiple_interpreters slot
neonene May 22, 2025
a28e67c
Cancel the prvious addition as needless
neonene May 22, 2025
9e6bff5
Merge remote-tracking branch 'upstream/main' into multi
AA-Turner May 26, 2025
d35a6b4
updates
AA-Turner May 26, 2025
9cb3092
PEP 7
AA-Turner May 26, 2025
6e5b1c5
revert module state for SpamError
AA-Turner May 26, 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
6 changes: 4 additions & 2 deletions Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,17 @@ complete listing.
item defined in the module file. Example::

static struct PyModuleDef spam_module = {
PyModuleDef_HEAD_INIT,
.m_base = PyModuleDef_HEAD_INIT,
.m_name = "spam",
.m_size = 0,
.m_slots = spam_module_slots,
...
};

PyMODINIT_FUNC
PyInit_spam(void)
{
return PyModule_Create(&spam_module);
return PyModuleDef_Init(&spam_module);
}


Expand Down
19 changes: 14 additions & 5 deletions Doc/extending/embedding.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,21 +245,30 @@ Python extension. For example::
return PyLong_FromLong(numargs);
}

static PyMethodDef EmbMethods[] = {
static PyMethodDef emb_module_methods[] = {
{"numargs", emb_numargs, METH_VARARGS,
"Return the number of arguments received by the process."},
{NULL, NULL, 0, NULL}
};

static PyModuleDef EmbModule = {
PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,
NULL, NULL, NULL, NULL
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-Turner AA-Turner May 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}
};

Copy link
Member

Choose a reason for hiding this comment

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

Can this 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.

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
Contributor Author

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.


struct PyModuleDef emb_module = {
.m_base = PyModuleDef_HEAD_INIT,
.m_name = "emb",
.m_size = 0,
.m_methods = emb_module_methods,
.m_slots = emb_module_slots,
};

static PyObject*
PyInit_emb(void)
{
return PyModule_Create(&EmbModule);
return PyModuleDef_Init(&emb_module);
}

Insert the above code just above the :c:func:`main` function. Also, insert the
Expand Down
Loading
Loading