Skip to content

bpo-37334: Add a cancel method to asyncio Queues #14227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tecki wants to merge 7 commits into from
Closed

bpo-37334: Add a cancel method to asyncio Queues #14227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ce81fc4
Add a cancel method to asyncio Queues.
tecki Jun 19, 2019
ad2c8a6
test asyncio.Queue.cancel
tecki Jun 19, 2019
da02bb4
document asyncio.Queue.cancel
tecki Jun 19, 2019
909ce14
rename asyncio.queue.cancel to .close
tecki Jun 24, 2019
9e895b3
improve testing of asyncio.queue.close
tecki Jun 24, 2019
6522e52
add a news entry
tecki Nov 21, 2019
ca06730
remove loop parameter in asyncio tests
tecki May 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Doc/library/asyncio-queue.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ Queue

Return the number of items in the queue.

.. method:: close()

Cancel all currently waiting :meth:`get` or :meth:`put`
coroutines.

.. method:: task_done()

Indicate that a formerly enqueued task is complete.
Expand Down
7 changes: 7 additions & 0 deletions Lib/asyncio/queues.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,13 @@ async def join(self):
if self._unfinished_tasks > 0:
await self._finished.wait()

def close(self):
"""Cancel all getters and putters currently waiting"""
for fut in self._putters:
fut.cancel()
for fut in self._getters:
fut.cancel()


class PriorityQueue(Queue):
"""A subclass of Queue; retrieves entries in priority order (lowest first).
Expand Down
25 changes: 25 additions & 0 deletions Lib/test/test_asyncio/test_queues.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,19 @@ async def consumer(queue):
self.loop.run_until_complete(self.loop.create_task(consumer(queue)))
self.assertEqual(len(queue._getters), 0)

def test_close_get(self):
queue = asyncio.Queue()

get1 = self.loop.create_task(queue.get())
get2 = self.loop.create_task(queue.get())
test_utils.run_briefly(self.loop)
queue.put_nowait(3)
queue.close()
self.assertEqual(self.loop.run_until_complete(get1), 3)
test_utils.run_briefly(self.loop)
with self.assertRaises(asyncio.CancelledError):
self.loop.run_until_complete(get2)


class QueuePutTests(_QueueTestBase):

Expand Down Expand Up @@ -575,6 +588,18 @@ def gen():
with self.assertRaises(asyncio.CancelledError):
loop.run_until_complete(put_task)

def test_close_put(self):
queue = asyncio.Queue(1)
queue.put_nowait(1)

putter = self.loop.create_task(queue.put(1))
test_utils.run_briefly(self.loop)
queue.close()
test_utils.run_briefly(self.loop)
with self.assertRaises(asyncio.CancelledError):
self.loop.run_until_complete(putter)



class LifoQueueTests(_QueueTestBase):

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2019-11-21-11-32-00.bpo-37334.3i2oAq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add a close() method to asyncio queues