summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Snow <ericsnowcurrently@gmail.com>2024-06-21 19:05:53 (GMT)
committerGitHub <noreply@github.com>2024-06-21 19:05:53 (GMT)
commit03fa2df92707b543c304a426732214002f81d671 (patch)
tree063766fdf5baea8736dc4185d2729bc62d8b1c48
parent462832041e342f8aaf8c88ec44f7b14c70042575 (diff)
downloadcpython-03fa2df92707b543c304a426732214002f81d671.zip
cpython-03fa2df92707b543c304a426732214002f81d671.tar.gz
cpython-03fa2df92707b543c304a426732214002f81d671.tar.bz2
gh-120838: Add a Note in the Docs About Expectations for Py_Finalize() (gh-120839)
-rw-r--r--Doc/c-api/init.rst13
1 files changed, 10 insertions, 3 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 58c7903..6b45413 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -396,9 +396,16 @@ Initializing and finalizing the interpreter
:c:func:`Py_NewInterpreter` below) that were created and not yet destroyed since
the last call to :c:func:`Py_Initialize`. Ideally, this frees all memory
allocated by the Python interpreter. This is a no-op when called for a second
- time (without calling :c:func:`Py_Initialize` again first). Normally the
- return value is ``0``. If there were errors during finalization
- (flushing buffered data), ``-1`` is returned.
+ time (without calling :c:func:`Py_Initialize` again first).
+
+ Since this is the reverse of :c:func:`Py_Initialize`, it should be called
+ in the same thread with the same interpreter active. That means
+ the main thread and the main interpreter.
+ This should never be called while :c:func:`Py_RunMain` is running.
+
+ Normally the return value is ``0``.
+ If there were errors during finalization (flushing buffered data),
+ ``-1`` is returned.
This function is provided for a number of reasons. An embedding application
might want to restart Python without having to restart the application itself.