Skip to content

Commit 3759cbc

Browse files
committed
commit 2
1 parent ee94e84 commit 3759cbc

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

Doc/library/asyncio-queue.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ asyncio queues are designed to be similar to classes of the
1515
they are designed to be used specifically in async/await code.
1616

1717
Note that methods of asyncio queues don't have a *timeout* parameter;
18-
use :func:`asyncio.wait_for` function to do queue operations with a
19-
timeout.
18+
use :func:`asyncio.wait_for` function to perform queue operations with a
19+
timeouts.
2020

2121
See also the `Examples`_ section below.
2222

@@ -55,7 +55,8 @@ Queue
5555
Return ``True`` if there are :attr:`maxsize` items in the queue.
5656

5757
If the queue was initialized with ``maxsize=0`` (the default),
58-
then :meth:`full` never returns ``True``.
58+
or a negative :attr:`maxsize:, then :meth:`full` never returns
59+
``True``.
5960

6061
.. method:: get()
6162
:async:
@@ -113,7 +114,7 @@ Queue
113114
Currently blocked callers of :meth:`~Queue.put` will be unblocked
114115
and will raise :exc:`QueueShutDown` in the formerly awaiting task.
115116

116-
If *immediate* is false (the default), the queue can be wound
117+
If *immediate* is ``False`` (the default), the queue can be wound
117118
down normally with :meth:`~Queue.get` calls to extract tasks
118119
that have already been loaded.
119120

@@ -123,17 +124,17 @@ Queue
123124
Once the queue is empty, future calls to :meth:`~Queue.get` will
124125
raise :exc:`QueueShutDown`.
125126

126-
If *immediate* is true, the queue is terminated immediately.
127+
If *immediate* is ``True``, the queue is terminated immediately.
127128
The queue is drained to be completely empty and the count
128129
of unfinished tasks is reduced by the number of tasks drained.
129-
If unfinished tasks is zero, callers of :meth:`~Queue.join`
130-
are unblocked. Also, blocked callers of :meth:`~Queue.get`
131-
are unblocked and will raise :exc:`QueueShutDown` because the
130+
If the count reaches zero, callers of :meth:`~Queue.join` are
131+
unblocked. Also, blocked callers of :meth:`~Queue.get` are
132+
unblocked and will raise :exc:`QueueShutDown` because the
132133
queue is empty.
133134

134-
Use caution when using :meth:`~Queue.join` with *immediate* set
135-
to true. This unblocks the join even when no work has been done
136-
on the tasks, violating the usual invariant for joining a queue.
135+
Exercise caution when using :meth:`~Queue.join` in the above case.
136+
The join may be unblocked even when no work has been done on the
137+
tasks, violating the usual invariant for joining a queue.
137138

138139
.. versionadded:: 3.13
139140

0 commit comments

Comments
 (0)