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

docs: extend PYBIND11_MODULE documentation, mention mod_gil_not_used (#5250)

Browse Source 
This follows up on PR 5148, which introduced support for free-threaded CPython.
This commit is contained in:
Ralf Gommers 2024-07-18 08:26:45 +02:00 committed by Henry Schreiner
parent f3a6d41453
commit b43074533c
No known key found for this signature in database
GPG Key ID: B9D0E45146A241E8
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/pybind11/detail/common.h
View File

@ -462,6 +462,22 @@ PYBIND11_WARNING_POP
return "Hello, World!"; return "Hello, World!";
}); });
} }
The third macro argument is optional (available since 2.13.0), and can be used to
mark the extension module as safe to run without the GIL under a free-threaded CPython
interpreter. Passing this argument has no effect on other interpreters.
.. code-block:: cpp
PYBIND11_MODULE(example, m, py::mod_gil_not_used()) {
m.doc() = "pybind11 example module safe to run without the GIL";
// Add bindings here
m.def("foo", []() {
return "Hello, Free-threaded World!";
});
}
\endrst */ \endrst */
#define PYBIND11_MODULE(name, variable, ...) \ #define PYBIND11_MODULE(name, variable, ...) \
static ::pybind11::module_::module_def PYBIND11_CONCAT(pybind11_module_def_, name) \ static ::pybind11::module_::module_def PYBIND11_CONCAT(pybind11_module_def_, name) \