summaryrefslogtreecommitdiffstats
path: root/Doc/library/queue.rst
diff options
context:
space:
mode:
authorStephen Rosen <sirosen@globus.org>2019-03-25 19:55:20 (GMT)
committerRaymond Hettinger <rhettinger@users.noreply.github.com>2019-03-25 19:55:20 (GMT)
commit713a8ae7926472b02ee1a394633eb54aaa7912d1 (patch)
treed55a2c50e2454a97ab1d93e962267304bc91b028 /Doc/library/queue.rst
parenta6fbc4e25e1dc7d1c9a26888b9115bc6c2afc101 (diff)
downloadcpython-713a8ae7926472b02ee1a394633eb54aaa7912d1.zip
cpython-713a8ae7926472b02ee1a394633eb54aaa7912d1.tar.gz
cpython-713a8ae7926472b02ee1a394633eb54aaa7912d1.tar.bz2
Add note to Queue.get() docs about block=True (GH-2223)
Diffstat (limited to 'Doc/library/queue.rst')
-rw-r--r--Doc/library/queue.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst
index f99f6ff..2eeab5e 100644
--- a/Doc/library/queue.rst
+++ b/Doc/library/queue.rst
@@ -150,6 +150,11 @@ provide the public methods described below.
Otherwise (*block* is false), return an item if one is immediately available,
else raise the :exc:`Empty` exception (*timeout* is ignored in that case).
+ Prior to 3.0 on POSIX systems, and for all versions on Windows, if
+ *block* is true and *timeout* is ``None``, this operation goes into
+ an uninterruptible wait on an underlying lock. This means that no exceptions
+ can occur, and in particular a SIGINT will not trigger a :exc:`KeyboardInterrupt`.
+
.. method:: Queue.get_nowait()