Skip to content

Commit d3b46c5

Browse files
[3.15] gh-158239: Fix asyncio.gather() performance regression (GH-158240) (#158655)
gh-158239: Fix `asyncio.gather()` performance regression (GH-158240) (cherry picked from commit b06dd22) Co-authored-by: Timofei Ivankov <128279579+deadlovelll@users.noreply.github.com>
1 parent faf16ef commit d3b46c5

3 files changed

Lines changed: 36 additions & 5 deletions

File tree

‎Lib/asyncio/tasks.py‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -784,7 +784,7 @@ def cancel(self, msg=None):
784784
return ret
785785

786786

787-
def _discard_awaited_by(children, waiter, outer):
787+
def _discard_awaited_by(children, waiter):
788788
for fut in children:
789789
futures.future_discard_from_awaited_by(fut, waiter)
790790

@@ -850,11 +850,14 @@ def _done_callback(fut, cur_task=cur_task):
850850
# 'fut.exception()' will *raise* a CancelledError
851851
# instead of returning it.
852852
exc = fut._make_cancelled_error()
853+
# gh-157213: children outliving gather() must lose the edge
854+
_discard_awaited_by(children, cur_task)
853855
outer.set_exception(exc)
854856
return
855857
else:
856858
exc = fut.exception()
857859
if exc is not None:
860+
_discard_awaited_by(children, cur_task)
858861
outer.set_exception(exc)
859862
return
860863

@@ -922,10 +925,6 @@ def _done_callback(fut, cur_task=cur_task):
922925
children.append(fut)
923926

924927
outer = _GatheringFuture(children, loop=loop)
925-
if cur_task is not None:
926-
# gh-157213: a child outliving gather() must lose the awaited-by edge
927-
outer.add_done_callback(
928-
functools.partial(_discard_awaited_by, children, cur_task))
929928
# Run done callbacks after GatheringFuture created so any post-processing
930929
# can be performed at this point
931930
# optimization: in the special case that *all* futures finished eagerly,

‎Lib/test/test_asyncio/test_tasks.py‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1252,6 +1252,37 @@ async def coro():
12521252

12531253
self.loop.run_until_complete(self.new_task(self.loop, coro()))
12541254

1255+
def test_gather_discards_awaited_by_for_cancelled_sibling(self):
1256+
# gh-157213: same, when gather() is ended by a cancelled child
1257+
async def survivor():
1258+
await asyncio.Future()
1259+
1260+
async def coro():
1261+
t = self.new_task(self.loop, survivor())
1262+
victim = self.new_task(self.loop, asyncio.sleep(10))
1263+
victim.cancel()
1264+
with self.assertRaises(asyncio.CancelledError):
1265+
await asyncio.gather(t, victim)
1266+
self.assertFalse(t._asyncio_awaited_by)
1267+
t.cancel()
1268+
with self.assertRaises(asyncio.CancelledError):
1269+
await t
1270+
1271+
self.loop.run_until_complete(self.new_task(self.loop, coro()))
1272+
1273+
def test_gather_does_not_add_callback_to_outer(self):
1274+
# gh-158239: gather() must not add an internal done callback to
1275+
# the outer future just to maintain the await graph.
1276+
async def child():
1277+
await asyncio.sleep(0)
1278+
1279+
async def coro():
1280+
outer = asyncio.gather(child(), child())
1281+
self.assertFalse(outer._callbacks)
1282+
await outer
1283+
1284+
self.loop.run_until_complete(self.new_task(self.loop, coro()))
1285+
12551286
def test_wait_really_done(self):
12561287
# there is possibility that some tasks in the pending list
12571288
# became done but their callbacks haven't all been called yet

‎Misc/ACKS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -883,6 +883,7 @@ Dean Inwood
883883
Bob Ippolito
884884
Roger Irwin
885885
Atsuo Ishimoto
886+
Timofei Ivankov
886887
Alexey Izbyshev
887888
Kasia Jachim
888889
Adam Jackson

0 commit comments

Comments
 (0)