From dfbd9d8a095c9b3af6daad09057aee940f082c20 Mon Sep 17 00:00:00 2001 From: jbower <1978924+jbower-fb@users.noreply.github.com> Date: Thu, 4 May 2023 22:51:48 -0700 Subject: [PATCH 1/6] gh-97696 Add documentation for get_coro() behavior with eager tasks --- Doc/library/asyncio-task.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index b2d7362a9de213..46a3fcfa0dc901 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -1174,6 +1174,11 @@ Task Object Return the coroutine object wrapped by the :class:`Task`. + .. note:: + + This will return ``None`` for Tasks which have already + completed eagerly. + .. versionadded:: 3.8 .. method:: get_context() From 3a489d06cce1d84babcf4fa92fe8ea3b304e452c Mon Sep 17 00:00:00 2001 From: Jacob Bower <1978924+jbower-fb@users.noreply.github.com> Date: Fri, 5 May 2023 10:25:02 -0700 Subject: [PATCH 2/6] Update asyncio-task.rst --- Doc/library/asyncio-task.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 46a3fcfa0dc901..ffcf95feed91f5 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -1175,7 +1175,7 @@ Task Object Return the coroutine object wrapped by the :class:`Task`. .. note:: - + This will return ``None`` for Tasks which have already completed eagerly. From 191993500180b73483bb60c4b3f0bdcb67c5280f Mon Sep 17 00:00:00 2001 From: jbower <1978924+jbower-fb@users.noreply.github.com> Date: Mon, 8 May 2023 12:04:18 -0700 Subject: [PATCH 3/6] get_coro versionchanged info and cross-reference --- Doc/library/asyncio-task.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index ffcf95feed91f5..0f9b9e5668cf4a 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -527,6 +527,8 @@ Running Tasks Concurrently and there is no running event loop. +.. _eager-task-factory: + Eager Task Factory ================== @@ -1177,10 +1179,13 @@ Task Object .. note:: This will return ``None`` for Tasks which have already - completed eagerly. + completed eagerly. See the :ref:`Eager Task Factory `. .. versionadded:: 3.8 + .. versionchanged:: 3.12 + Added note on specific eager task execution behavior. + .. method:: get_context() Return the :class:`contextvars.Context` object From 6fd905c39d61371663e182994fcf667a3de516cb Mon Sep 17 00:00:00 2001 From: jbower <1978924+jbower-fb@users.noreply.github.com> Date: Mon, 8 May 2023 12:40:54 -0700 Subject: [PATCH 4/6] whitespace fixes --- Doc/library/asyncio-task.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 0f9b9e5668cf4a..0b33359cb88979 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -1178,12 +1178,13 @@ Task Object .. note:: - This will return ``None`` for Tasks which have already - completed eagerly. See the :ref:`Eager Task Factory `. + This will return ``None`` for Tasks which have already + completed eagerly. See the :ref:`Eager Task Factory `. .. versionadded:: 3.8 .. versionchanged:: 3.12 + Added note on specific eager task execution behavior. .. method:: get_context() From b29bc17f21d7597765ba8ca70815eceb05c22a58 Mon Sep 17 00:00:00 2001 From: Jacob Bower <1978924+jbower-fb@users.noreply.github.com> Date: Mon, 8 May 2023 22:49:24 -0700 Subject: [PATCH 5/6] versionchange info refers to implementation rather than doc changes --- Doc/library/asyncio-task.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 0b33359cb88979..24a130dd115f5d 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -1185,7 +1185,7 @@ Task Object .. versionchanged:: 3.12 - Added note on specific eager task execution behavior. + Newly added eager task execution means result may be ``None``. .. method:: get_context() From f5d04bfc430f88d3678c5c5ab2f063a34327a5c6 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Tue, 9 May 2023 10:07:38 -0700 Subject: [PATCH 6/6] Fix indent --- Doc/library/asyncio-task.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 24a130dd115f5d..fe8d028150403d 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -1185,7 +1185,7 @@ Task Object .. versionchanged:: 3.12 - Newly added eager task execution means result may be ``None``. + Newly added eager task execution means result may be ``None``. .. method:: get_context()