summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>2021-11-15 22:30:28 (GMT)
committerGitHub <noreply@github.com>2021-11-15 22:30:28 (GMT)
commitc750adbe6990ee8239b27d5f4591283a06bfe862 (patch)
tree34e1a1820a876230ce4d1f939defc79171cfd259
parent6c5a312fb6d92e879bf4c570b94e18bb9ffe5970 (diff)
downloadcpython-c750adbe6990ee8239b27d5f4591283a06bfe862.zip
cpython-c750adbe6990ee8239b27d5f4591283a06bfe862.tar.gz
cpython-c750adbe6990ee8239b27d5f4591283a06bfe862.tar.bz2
Save a reference for ensure_future and create_task (GH-29163)
Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>
-rw-r--r--Doc/library/asyncio-future.rst3
-rw-r--r--Doc/library/asyncio-task.rst5
2 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst
index ef496a2..3496387 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 07354e0..36e13f9 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -271,6 +271,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