Skip to content

bpo-36427: Document that PyEval_RestoreThread and PyGILState_Ensure can terminate the calling thread #12541

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 2 commits into from
Apr 13, 2019
Merged

bpo-36427: Document that PyEval_RestoreThread and PyGILState_Ensure can terminate the calling thread #12541

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
926525d
bpo-36427: Document that PyEval_RestoreThread and PyGILState_Ensure c…
pablogsal Mar 25, 2019
47fa8d0
Use a note instead of a warning and s/interpreter/runtime
pablogsal Apr 13, 2019
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
12 changes: 12 additions & 0 deletions Doc/c-api/init.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,6 +855,12 @@ code, or when embedding the Python interpreter:
created, the current thread must not have acquired it, otherwise deadlock
ensues.

.. note::
Calling this function from a thread when the runtime is finalizing
will terminate the thread, even if the thread was not created by Python.
You can use :c:func:`_Py_IsFinalizing` or :func:`sys.is_finalizing` to
check if the interpreter is in process of being finalized before calling
this function to avoid unwanted termination.

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

Expand Down Expand Up @@ -902,6 +908,12 @@ with sub-interpreters:
When the function returns, the current thread will hold the GIL and be able
to call arbitrary Python code. Failure is a fatal error.

.. note::
Calling this function from a thread when the runtime is finalizing
will terminate the thread, even if the thread was not created by Python.
You can use :c:func:`_Py_IsFinalizing` or :func:`sys.is_finalizing` to
check if the interpreter is in process of being finalized before calling
this function to avoid unwanted termination.

.. c:function:: void PyGILState_Release(PyGILState_STATE)

Expand Down