Skip to content

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

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

Merged
merged 3 commits into from
Apr 13, 2025
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9108b6c
DOC: Move warning to save a reference of the ensure_future function t…
CaseZumbrum Feb 11, 2025
e07df0f
Update Doc/library/asyncio-future.rst
kumaraditya303 Apr 13, 2025
e22c3d6
Merge branch 'main' into fix-issue-129169
kumaraditya303 Apr 13, 2025
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
7 changes: 4 additions & 3 deletions Doc/library/asyncio-future.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,13 @@ Future Functions

.. important::

See also the :func:`create_task` function which is the
preferred way for creating new Tasks.

Save a reference to the result of this function, to avoid
a task disappearing mid-execution.

See also the :func:`create_task` function which is the
preferred way for creating new tasks or use :class:`asyncio.TaskGroup`
which keeps reference to the task internally.

.. versionchanged:: 3.5.1
The function accepts any :term:`awaitable` object.

Expand Down
Loading