Fix Queue.shutdown docs for condition to unblock a join (gh-137088)

This commit is contained in:
Raymond Hettinger 2025-07-25 07:56:28 -06:00 committed by GitHub
parent d7db0ee7ee
commit ea06ae5b5e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 18 additions and 12 deletions

View file

@ -253,9 +253,11 @@ def shutdown(self, immediate=False):
By default, gets will only raise once the queue is empty. Set
'immediate' to True to make gets raise immediately instead.
All blocked callers of put() and get() will be unblocked. If
'immediate', unblock callers of join() regardless of the
number of unfinished tasks.
All blocked callers of put() and get() will be unblocked.
If 'immediate', the queue is drained and unfinished tasks
is reduced by the number of drained tasks. If unfinished tasks
is reduced to zero, callers of Queue.join are unblocked.
"""
self._is_shutdown = True
if immediate: