Skip to content
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.

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

Added a comment about GIL acquisition vs. multithreading vs. program exit. #891

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions docs/api_core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2737,6 +2737,12 @@ running it in parallel from multiple Python threads.

Reacquire the GIL

If you use nanobind in a multi-threaded program, you **must** ensure that
all threads have terminated **before** the interpreter exits. Otherwise any
code that re-acquires the GIL (e.g. for running destructors) will throw a
cancellation exception. This will result in a hard crash because C++ does
not support exceptions in destructors, nor ignoring a cancellation.

Free-threading
--------------

Expand Down