summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorSam Gross <colesbury@gmail.com>2024-05-03 15:09:57 (GMT)
committerGitHub <noreply@github.com>2024-05-03 15:09:57 (GMT)
commit2dae505e87e3815f087d4b07a71bb2c5cce22304 (patch)
tree232577513b53b378623dc28c7dae53c846b2bf77 /Doc/library/sys.rst
parent24e643d4ef024a3561c927dc07c59c435bb27bcc (diff)
downloadcpython-2dae505e87e3815f087d4b07a71bb2c5cce22304.zip
cpython-2dae505e87e3815f087d4b07a71bb2c5cce22304.tar.gz
cpython-2dae505e87e3815f087d4b07a71bb2c5cce22304.tar.bz2
gh-117514: Add `sys._is_gil_enabled()` function (#118514)
The function returns `True` or `False` depending on whether the GIL is currently enabled. In the default build, it always returns `True` because the GIL is always enabled.
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 19d6856..91afa9d 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -1199,6 +1199,14 @@ always available.
return value of :func:`intern` around to benefit from it.
+.. function:: _is_gil_enabled()
+
+ Return :const:`True` if the :term:`GIL` is enabled and :const:`False` if
+ it is disabled.
+
+ .. versionadded:: 3.13
+
+
.. function:: is_finalizing()
Return :const:`True` if the main Python interpreter is