-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
bpo-32751: Wait for task cancellation in asyncio.wait_for() #7216
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.
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -412,14 +412,17 @@ async def wait_for(fut, timeout, *, loop=None): | |
return fut.result() | ||
else: | ||
fut.remove_done_callback(cb) | ||
fut.cancel() | ||
# We must ensure that the task is not running | ||
# after wait_for() returns. | ||
# See https://bugs.python.org/issue32751 | ||
await _cancel_and_wait(fut, loop=loop) | ||
raise futures.TimeoutError() | ||
finally: | ||
timeout_handle.cancel() | ||
|
||
|
||
async def _wait(fs, timeout, return_when, loop): | ||
"""Internal helper for wait() and wait_for(). | ||
"""Internal helper for wait(). | ||
|
||
The fs argument must be a collection of Futures. | ||
""" | ||
|
@@ -461,6 +464,27 @@ def _on_completion(f): | |
return done, pending | ||
|
||
|
||
async def _cancel_and_wait(fut, loop): | ||
"""Cancel the *fut* future or task and wait until it completes.""" | ||
|
||
waiter = loop.create_future() | ||
cb = functools.partial(_release_waiter, waiter) | ||
fut.add_done_callback(cb) | ||
fut.cancel() | ||
|
||
try: | ||
# We cannot wait on *fut* directly to make | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice trick! |
||
# sure _cancel_and_wait itself is reliably cancellable. | ||
await waiter | ||
except futures.CancelledError: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, it's an oversight from an earlier code iteration. |
||
if not fut.done(): | ||
# Task still alive, but cancellation itself is being | ||
# cancelled. | ||
raise | ||
< 10000 span class='blob-code-inner blob-code-marker ' data-code-marker="+"> finally: | ||
fut.remove_done_callback(cb) | ||
|
||
|
||
# This is *not* a @coroutine! It is just an iterator (yielding Futures). | ||
def as_completed(fs, *, loop=None, timeout=None): | ||
"""Return an iterator whose values are coroutines. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
When cancelling the task due to a timeout, :meth:`asyncio.wait_for` will now | ||
wait until the cancellation is complete. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd move 'fut.cancel()' into the 'try' block