gh-107305: Update the C-API Docs for PEP 684 by ericsnowcurrently · Pull Request #107324 · python/cpython

ericsnowcurrently · 2023-07-26T22:34:39Z

Issue: Update the C-API "Sub-interpreter support" Section for PEP 684 #107305

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

…ndInterpreter().

serhiy-storchaka · 2023-07-28T15:45:46Z

Doc/c-api/init.rst

+      This determines the operation of the GIL for the sub-interpreter.
+      It may be one of the following:
+
+      - ``PyInterpreterConfig_DEFAULT_GIL``: use the default selection


You can use .. c:macro:: for declaring these constant and the :c:macro: role for referring them. They will also be added in the index.

Just add .. c:namespace:: NULL before this, otherwise they will have wrong prefix.

serhiy-storchaka · 2023-07-28T15:47:13Z

Doc/c-api/init.rst

+      Otherwise it will use (share) the main interpreter's.
+
+      If this is ``0`` then
+      :c:member:`PyInterpreterConfig.check_multi_interp_extensions`


Perhaps :c:member:`~PyInterpreterConfig.check_multi_interp_extensions` or just :c:member:`check_multi_interp_extensions` would look better.

serhiy-storchaka · 2023-07-28T15:49:50Z

Doc/c-api/init.rst

+      :c:member:`PyInterpreterConfig.use_main_obmalloc` must be ``0``.
+
+
+.. c:function:: PyThreadState* Py_NewInterpreterFromConfig(PyInterpreterConfig *config)


If config is not modified, perhaps add const?

serhiy-storchaka · 2023-07-28T15:50:40Z

Doc/c-api/init.rst

   .. index:: single: close() (in module os)


+.. c:function:: PyThreadState* Py_NewInterpreter()


Suggested change

.. c:function:: PyThreadState* Py_NewInterpreter()

.. c:function:: PyThreadState* Py_NewInterpreter(void)

serhiy-storchaka · 2023-07-28T19:02:14Z

Doc/c-api/init.rst

+      If this is ``0`` then
+      :c:member:`~PyInterpreterConfig.check_multi_interp_extensions`
+      must be ``1`` (non-zero).
+      If this is ``1`` then :c:member:`PyInterpreterConfig.gil`


I think the prefix can be omitted here too.

serhiy-storchaka · 2023-07-28T19:08:55Z

Doc/c-api/init.rst

+      including legacy (single-phase init) modules,
+      in any thread where the sub-interpreter is currently active.
+      Otherwise only multi-phase init extension modules
+      (see :ref:`Isolating Extension Modules`) may be imported.


An explicit label is required to refer across files.

serhiy-storchaka · 2023-07-28T19:12:07Z

Doc/c-api/init.rst

+   The given config controls the options with which the interpreter
+   is initialized.
+
+   Upon success, the ``tstate_p`` arg will be set to the first thread state


Function parameters are marked like *tstate_p*.

serhiy-storchaka

The formatting LGTM.

miss-islington · 2023-07-28T19:46:58Z

Thanks @ericsnowcurrently for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

ericsnowcurrently · 2023-07-28T19:47:07Z

Thanks for the reviews, @serhiy-storchaka

bedevere-bot · 2023-07-28T19:47:08Z

GH-107402 is a backport of this pull request to the 3.12 branch.

(cherry picked from commit c0b81c4) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>

…07402) gh-107305: Update the C-API Docs for PEP 684 (gh-107324) (cherry picked from commit c0b81c4) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>

ericsnowcurrently added 5 commits July 26, 2023 14:25

Add an entry for PyInterpreterConfig.

fea85c5

Add an entry for Py_NewInterpreterFromConfig().

c635e18

Add a section about the consequences of per-interpreter GIL.

4abebc9

Clarify about the GIL/current tstate for Py_NewInterpreter() and Py_E…

a160739

…ndInterpreter().

Add a NEWS entry.

badd3d6

ericsnowcurrently added the needs backport to 3.12 only security fixes label Jul 26, 2023

bedevere-bot mentioned this pull request Jul 26, 2023

Update the C-API "Sub-interpreter support" Section for PEP 684 #107305

Closed

bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 26, 2023

serhiy-storchaka reviewed Jul 28, 2023

View reviewed changes

serhiy-storchaka and others added 7 commits July 28, 2023 18:51

Merge branch 'main' into pep-684-docs-1

2b6902d

Use the c:macro role.

10d40b6

Drop the struct name when rendered.

919382d

Add a missing "void".

c9a2162

Drop some old text.

964259b

Fix the signature of Py_NewInterpreterFromConfig().

db5ecf5

Fix a ref.

a5b19f5

serhiy-storchaka reviewed Jul 28, 2023

View reviewed changes

ericsnowcurrently added 2 commits July 28, 2023 13:22

Drop the struct name when rendered.

4d81e60

Fix formatting for function arguments.

a38bb89

serhiy-storchaka approved these changes Jul 28, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Jul 28, 2023

ericsnowcurrently merged commit c0b81c4 into python:main Jul 28, 2023

bedevere-bot removed the awaiting merge label Jul 28, 2023

bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 28, 2023

ericsnowcurrently deleted the pep-684-docs-1 branch July 28, 2023 19:47

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 28, 2023

pythongh-107305: Update the C-API Docs for PEP 684 (pythongh-107324)

1c77d99

(cherry picked from commit c0b81c4) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>

		:c:member:`PyInterpreterConfig.use_main_obmalloc` must be ``0``.


		.. c:function:: PyThreadState* Py_NewInterpreterFromConfig(PyInterpreterConfig *config)

		.. index:: single: close() (in module os)


		.. c:function:: PyThreadState* Py_NewInterpreter()

Uh oh!

Conversation

ericsnowcurrently commented Jul 26, 2023 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Jul 28, 2023

Uh oh!

ericsnowcurrently commented Jul 28, 2023

Uh oh!

bedevere-bot commented Jul 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ericsnowcurrently commented Jul 26, 2023 •

edited by github-actions bot

Loading