Skip to content

Commit

Permalink
[3.13] pythongh-128588: pythongh-128550: remove eager tasks optimizat…
Browse files Browse the repository at this point in the history
…ion that missed and introduced incorrect cancellations (pythonGH-129063) (python#129089)

pythongh-128588: pythongh-128550: remove eager tasks optimization that missed and introduced incorrect cancellations (pythonGH-129063)
(cherry picked from commit ed6934e)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
  • Loading branch information
3 people authored Jan 20, 2025
1 parent 22e9faf commit a1c48a7
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 7 deletions.
12 changes: 5 additions & 7 deletions Lib/asyncio/taskgroups.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,14 +197,12 @@ def create_task(self, coro, *, name=None, context=None):
else:
task = self._loop.create_task(coro, name=name, context=context)

# optimization: Immediately call the done callback if the task is
# Always schedule the done callback even if the task is
# already done (e.g. if the coro was able to complete eagerly),
# and skip scheduling a done callback
if task.done():
self._on_task_done(task)
else:
self._tasks.add(task)
task.add_done_callback(self._on_task_done)
# otherwise if the task completes with an exception then it will cancel
# the current task too early. gh-128550, gh-128588
self._tasks.add(task)
task.add_done_callback(self._on_task_done)
try:
return task
finally:
Expand Down
50 changes: 50 additions & 0 deletions Lib/test/test_asyncio/test_taskgroups.py
Original file line number Diff line number Diff line change
Expand Up @@ -1032,6 +1032,56 @@ class MyKeyboardInterrupt(KeyboardInterrupt):
self.assertListEqual(gc.get_referrers(exc), [])


async def test_cancels_task_if_created_during_creation(self):
# regression test for gh-128550
ran = False
class MyError(Exception):
pass

exc = None
try:
async with asyncio.TaskGroup() as tg:
async def third_task():
raise MyError("third task failed")

async def second_task():
nonlocal ran
tg.create_task(third_task())
with self.assertRaises(asyncio.CancelledError):
await asyncio.sleep(0) # eager tasks cancel here
await asyncio.sleep(0) # lazy tasks cancel here
ran = True

tg.create_task(second_task())
except* MyError as excs:
exc = excs.exceptions[0]

self.assertTrue(ran)
self.assertIsInstance(exc, MyError)


async def test_cancellation_does_not_leak_out_of_tg(self):
class MyError(Exception):
pass

async def throw_error():
raise MyError

try:
async with asyncio.TaskGroup() as tg:
tg.create_task(throw_error())
except* MyError:
pass
else:
self.fail("should have raised one MyError in group")

# if this test fails this current task will be cancelled
# outside the task group and inside unittest internals
# we yield to the event loop with sleep(0) so that
# cancellation happens here and error is more understandable
await asyncio.sleep(0)


class TestTaskGroup(BaseTestTaskGroup, unittest.IsolatedAsyncioTestCase):
loop_factory = asyncio.EventLoop

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed an incorrect optimization relating to eager tasks in :class:`asyncio.TaskGroup` that resulted in cancellations being missed.

0 comments on commit a1c48a7

Please sign in to comment.