From 4152378f9c723921c1e8acc609e0a1b75c31ee23 Mon Sep 17 00:00:00 2001 From: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> Date: Mon, 15 Nov 2021 18:30:28 -0400 Subject: [PATCH] Save a reference for ensure_future and create_task (GH-29163) Co-authored-by: Joannah Nanjekye (cherry picked from commit c750adbe6990ee8239b27d5f4591283a06bfe862) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> --- Doc/library/asyncio-future.rst | 3 +++ Doc/library/asyncio-task.rst | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst index 939d4c1a84523a..63c369263fd99b 100644 --- a/Doc/library/asyncio-future.rst +++ b/Doc/library/asyncio-future.rst @@ -54,6 +54,9 @@ Future Functions 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. + .. versionchanged:: 3.5.1 The function accepts any :term:`awaitable` object. diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index ca6e525e935977..e8bee20bc76bc7 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -274,6 +274,11 @@ Creating Tasks task = asyncio.ensure_future(coro()) ... + .. important:: + + Save a reference to the result of this function, to avoid + a task disappearing mid execution. + .. versionadded:: 3.7 .. versionchanged:: 3.8