gh-129169: Update docs on asyncio.ensure_future() to make it more clear that a reference of the returned value should be stored and provide an alternative to avoid this. #129986
Conversation
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
…o the top of the important tag, mention the TaskGroup.create_task method as a way to avoid needing to save this reference.
CaseZumbrum
requested review from
1st1,
asvetlov,
kumaraditya303 and
willingc
as code owners
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
kumaraditya303
approved these changes
Apr 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Linked Issue
Resolves #129169
Problem Summary
Documentation for the asyncio.ensure_future() function was not clear that the output of the function needs to be saved to avoid the task being deleted.
Solution
Made this more explicit by moving this warning to the top of the "important" tag of the function, provided an alternative (TaskGroup) that would not require the saving of the task to a variable.
📚 Documentation preview 📚: https://cpython-previews--129986.org.readthedocs.build/