diff options
author | Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> | 2019-08-02 15:50:22 (GMT) |
---|---|---|
committer | Eric Snow <ericsnowcurrently@gmail.com> | 2019-08-02 15:50:22 (GMT) |
commit | 854d0a4b98b13629252e21edaf2b785b429e5135 (patch) | |
tree | 60965e489af2552709b518aaf962ad167e564a32 | |
parent | bf8162c8c45338470bbe487c8769bba20bde66c2 (diff) | |
download | cpython-854d0a4b98b13629252e21edaf2b785b429e5135.zip cpython-854d0a4b98b13629252e21edaf2b785b429e5135.tar.gz cpython-854d0a4b98b13629252e21edaf2b785b429e5135.tar.bz2 |
bpo-36487: Make C-API docs clear about what the main interpreter is. (gh-12666)
-rw-r--r-- | Doc/c-api/init.rst | 16 | ||||
-rwxr-xr-x | Misc/NEWS.d/next/Documentation/2019-04-02-19-23-00.bpo-36487.Jg6-MG.rst | 1 |
2 files changed, 13 insertions, 4 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index a0ac4d2..4985a1d 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -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() diff --git a/Misc/NEWS.d/next/Documentation/2019-04-02-19-23-00.bpo-36487.Jg6-MG.rst b/Misc/NEWS.d/next/Documentation/2019-04-02-19-23-00.bpo-36487.Jg6-MG.rst new file mode 100755 index 0000000..c8eb05b --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2019-04-02-19-23-00.bpo-36487.Jg6-MG.rst @@ -0,0 +1 @@ +Make C-API docs clear about what the "main" interpreter is.
\ No newline at end of file |