diff options
| author | Kristján Valur Jónsson <sweskman@gmail.com> | 2013-03-23 10:36:16 (GMT) |
|---|---|---|
| committer | Kristján Valur Jónsson <sweskman@gmail.com> | 2013-03-23 10:36:16 (GMT) |
| commit | 684cd0e64311faafba989457e28fbf2e84faa62e (patch) | |
| tree | c5d7122fb92223ede065f704ac6cffea0ceebd71 /Doc/c-api/init.rst | |
| parent | d4296fc19c20525215a26ad639be33e7fb53a898 (diff) | |
| download | cpython-684cd0e64311faafba989457e28fbf2e84faa62e.zip cpython-684cd0e64311faafba989457e28fbf2e84faa62e.tar.gz cpython-684cd0e64311faafba989457e28fbf2e84faa62e.tar.bz2 | |
Issue #17522: Add the PyGILState_Check() API.
Diffstat (limited to 'Doc/c-api/init.rst')
| -rw-r--r-- | Doc/c-api/init.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index 95ff4ee..377724c 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -654,6 +654,18 @@ with sub-interpreters: made on the main thread. This is mainly a helper/diagnostic function. +.. c:function:: int PyGILState_Check() + + Return 1 if the current thread is holding the GIL and 0 otherwise. + This function can be called from any thread at any time. + Only if it has had its Python thread state initialized and currently is + holding the GIL will it return 1. + This is mainly a helper/diagnostic function. It can be useful + for example in callback contexts or memory allocation functions when + knowing that the GIL is locked can allow the caller to perform sensitive + actions or otherwise behave differently. + + The following macros are normally used without a trailing semicolon; look for example usage in the Python source distribution. |