]> granicus.if.org Git - python/commitdiff
Add note to Queue.get() docs about block=True (GH-2223)
authorStephen Rosen <sirosen@globus.org>
Mon, 25 Mar 2019 19:55:20 +0000 (15:55 -0400)
committerRaymond Hettinger <rhettinger@users.noreply.github.com>
Mon, 25 Mar 2019 19:55:20 +0000 (12:55 -0700)
Doc/library/queue.rst

index f99f6ffb05f69edf687f97d3d01eed22d9c00b1f..2eeab5e26266470646f7ab4b9cd02aa7134f3de1 100644 (file)
@@ -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()