From f3c5535f63e7cd49166ab33b7b0ebb3285ef4ed0 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Mon, 25 Mar 2019 13:03:16 -0700 Subject: [PATCH] Add note to Queue.get() docs about block=True (GH-2223) (GH-12538) (cherry picked from commit 713a8ae7926472b02ee1a394633eb54aaa7912d1) Co-authored-by: Stephen Rosen --- Doc/library/queue.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst index 7335a64bef84..0a42da1d74a4 100644 --- a/Doc/library/queue.rst +++ b/Doc/library/queue.rst @@ -152,6 +152,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() -- 2.47.3