From 594c3699492bfb007650538726d953cbed55de04 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Thu, 30 Jun 2022 10:10:46 -0700 Subject: GH-94398: TaskGroup: Fail create_task() during shutdown (GH-94400) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Once the task group is shutting down, it should not be possible to create a new task. Here "shutting down" means `self._aborting` is set, indicating that at least one task has failed and we have cancelled all others. Co-authored-by: Łukasz Langa --- Doc/library/asyncio-task.rst | 1 + Lib/asyncio/taskgroups.py | 2 ++ Lib/test/test_asyncio/test_taskgroups.py | 27 ++++++++++++++++++---- .../2022-06-29-04-42-56.gh-issue-94398.YOq_bJ.rst | 1 + 4 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2022-06-29-04-42-56.gh-issue-94398.YOq_bJ.rst diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 9b76548..7696976 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -320,6 +320,7 @@ no new tasks may be added to the group. The first time any of the tasks belonging to the group fails with an exception other than :exc:`asyncio.CancelledError`, the remaining tasks in the group are cancelled. +No further tasks can then be added to the group. At this point, if the body of the ``async with`` statement is still active (i.e., :meth:`~object.__aexit__` hasn't been called yet), the task directly containing the ``async with`` statement is also cancelled. diff --git a/Lib/asyncio/taskgroups.py b/Lib/asyncio/taskgroups.py index 9e0610d..3ca6506 100644 --- a/Lib/asyncio/taskgroups.py +++ b/Lib/asyncio/taskgroups.py @@ -138,6 +138,8 @@ class TaskGroup: raise RuntimeError(f"TaskGroup {self!r} has not been entered") if self._exiting and not self._tasks: raise RuntimeError(f"TaskGroup {self!r} is finished") + if self._aborting: + raise RuntimeError(f"TaskGroup {self!r} is shutting down") if context is None: task = self._loop.create_task(coro) else: diff --git a/Lib/test/test_asyncio/test_taskgroups.py b/Lib/test/test_asyncio/test_taskgroups.py index 69369a6..26fb5e4 100644 --- a/Lib/test/test_asyncio/test_taskgroups.py +++ b/Lib/test/test_asyncio/test_taskgroups.py @@ -122,10 +122,8 @@ class TestTaskGroup(unittest.IsolatedAsyncioTestCase): self.assertTrue(t2.cancelled()) async def test_cancel_children_on_child_error(self): - """ - When a child task raises an error, the rest of the children - are cancelled and the errors are gathered into an EG. - """ + # When a child task raises an error, the rest of the children + # are cancelled and the errors are gathered into an EG. NUM = 0 t2_cancel = False @@ -722,6 +720,27 @@ class TestTaskGroup(unittest.IsolatedAsyncioTestCase): await t2 self.assertEqual(2, ctx.get(cvar)) + async def test_taskgroup_no_create_task_after_failure(self): + async def coro1(): + await asyncio.sleep(0.001) + 1 / 0 + async def coro2(g): + try: + await asyncio.sleep(1) + except asyncio.CancelledError: + with self.assertRaises(RuntimeError): + g.create_task(c1 := coro1()) + # We still have to await c1 to avoid a warning + with self.assertRaises(ZeroDivisionError): + await c1 + + with self.assertRaises(ExceptionGroup) as cm: + async with taskgroups.TaskGroup() as g: + g.create_task(coro1()) + g.create_task(coro2(g)) + + self.assertEqual(get_error_types(cm.exception), {ZeroDivisionError}) + if __name__ == "__main__": unittest.main() diff --git a/Misc/NEWS.d/next/Library/2022-06-29-04-42-56.gh-issue-94398.YOq_bJ.rst b/Misc/NEWS.d/next/Library/2022-06-29-04-42-56.gh-issue-94398.YOq_bJ.rst new file mode 100644 index 0000000..c6e7e96 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2022-06-29-04-42-56.gh-issue-94398.YOq_bJ.rst @@ -0,0 +1 @@ +Once a :class:`asyncio.TaskGroup` has started shutting down (i.e., at least one task has failed and the task group has started cancelling the remaining tasks), it should not be possible to add new tasks to the task group. -- cgit v0.12