languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-14 16:26:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

bpo-36487: Make C-API docs clear about what the main interpreter is. (gh-12666)

Browse source
This commit is contained in:
Joannah Nanjekye 2019-08-02 12:50:22 -03:00 committed by Eric Snow
parent bf8162c8c4
commit 854d0a4b98
2 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
Doc/c-api/init.rst
View file

@ -1141,10 +1141,18 @@ Sub-interpreter support
While in most uses, you will only embed a single Python interpreter, there
are cases where you need to create several independent interpreters in the
same process and perhaps even in the same thread. Sub-interpreters allow
you to do that. You can switch between sub-interpreters using the
:c:func:`PyThreadState_Swap` function. You can create and destroy them
using the following functions:
same process and perhaps even in the same thread. Sub-interpreters allow
you to do that.
The "main" interpreter is the first one created when the runtime initializes.
It is usually the only Python interpreter in a process. Unlike sub-interpreters,
the main interpreter has unique process-global responsibilities like signal
handling. It is also responsible for execution during runtime initialization and
is usually the active interpreter during runtime finalization. The
:c:func:`PyInterpreterState_Main` funtion returns a pointer to its state.
You can switch between sub-interpreters using the :c:func:`PyThreadState_Swap`
function. You can create and destroy them using the following functions:
.. c:function:: PyThreadState* Py_NewInterpreter()

1
Misc/NEWS.d/next/Documentation/2019-04-02-19-23-00.bpo-36487.Jg6-MG.rst Executable file
View file

@ -0,0 +1 @@
Make C-API docs clear about what the "main" interpreter is.