mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-28 01:00:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Add note to Queue.get() docs about block=True (GH-2223)

Browse source
This commit is contained in:
Stephen Rosen 2019-03-25 15:55:20 -04:00 • committed by Raymond Hettinger
parent a6fbc4e25e
commit 713a8ae792
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Doc/library/queue.rst
View 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()