-
-
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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,22 @@ 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 | ||
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. | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
Misc/NEWS.d/next/Library/2018-05-29-15-32-18.bpo-32751.oBTqr7.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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