Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-11-25 22:52:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs/advanced] Refer to deadlock.md from misc.rst

Browse Source
This commit is contained in:
Thomas Köppe 2024-10-02 20:17:40 +01:00
parent 4de4ad6d0e
commit 365cbe96cd
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/advanced/misc.rst
View File

@ -62,7 +62,11 @@ will acquire the GIL before calling the Python callback. Similarly, the
back into Python. back into Python.
When writing C++ code that is called from other C++ code, if that code accesses When writing C++ code that is called from other C++ code, if that code accesses
Python state, it must explicitly acquire and release the GIL. Python state, it must explicitly acquire and release the GIL. A separate
document on deadlocks [#f8]_ elaborates on a particularly subtle interaction
with C++'s block-scope static variable initializer guard mutexes.
.. [#f8] deadlock.md
The classes :class:`gil_scoped_release` and :class:`gil_scoped_acquire` can be The classes :class:`gil_scoped_release` and :class:`gil_scoped_acquire` can be
used to acquire and release the global interpreter lock in the body of a C++ used to acquire and release the global interpreter lock in the body of a C++
@ -142,6 +146,9 @@ following checklist.
destructors can sometimes get invoked in weird and unexpected circumstances as a result destructors can sometimes get invoked in weird and unexpected circumstances as a result
of exceptions. of exceptions.
- C++ static block-scope variable initialization that calls back into Python can
cause deadlocks; see [#f8]_ for a detailed discussion.
- You should try running your code in a debug build. That will enable additional assertions - You should try running your code in a debug build. That will enable additional assertions
within pybind11 that will throw exceptions on certain GIL handling errors within pybind11 that will throw exceptions on certain GIL handling errors
(reference counting operations). (reference counting operations).