-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
gh-128552: fix refcycles in eager task creation #128553
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 11 commits
c82f30b
8a4eb56
35a38e4
afd3053
9700ebf
fe83add
a1f76df
7c966d0
89362f5
cf5cfe3
18b6ea9
ca71935
cc39717
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
# Adapted with permission from the EdgeDB project; | ||
# license: PSFL. | ||
|
||
import weakref | ||
import sys | ||
import gc | ||
import asyncio | ||
|
@@ -12,11 +13,6 @@ | |
|
||
from test.test_asyncio.utils import await_without_task | ||
|
||
# To prevent a warning "test altered the execution environment" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I know this isn't needed as you have changed it to use asyncio.EventLoop but let's keep it for now, it is easy to make a mistake on altering policy and is a pain to fix in CI if it happens without this. |
||
def tearDownModule(): | ||
asyncio._set_event_loop_policy(None) | ||
|
||
|
||
class MyExc(Exception): | ||
graingert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
pass | ||
|
||
|
@@ -38,7 +34,25 @@ def no_other_refs(): | |
return [coro] | ||
|
||
|
||
class TestTaskGroup(unittest.IsolatedAsyncioTestCase): | ||
def set_gc_state(enabled: bool) -> bool: | ||
was_enabled = gc.isenabled() | ||
if enabled: | ||
gc.enable() | ||
else: | ||
gc.disable() | ||
return was_enabled | ||
|
||
|
||
@contextlib.contextmanager | ||
def disable_gc() -> Generator[None]: | ||
was_enabled = set_gc_state(enabled=False) | ||
try: | ||
yield | ||
finally: | ||
set_gc_state(enabled=was_enabled) | ||
graingert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
class BaseTestTaskGroup: | ||
|
||
async def test_taskgroup_01(self): | ||
|
||
|
@@ -832,15 +846,15 @@ async def test_taskgroup_without_parent_task(self): | |
with self.assertRaisesRegex(RuntimeError, "has not been entered"): | ||
tg.create_task(coro) | ||
|
||
def test_coro_closed_when_tg_closed(self): | ||
async def test_coro_closed_when_tg_closed(self): | ||
async def run_coro_after_tg_closes(): | ||
async with taskgroups.TaskGroup() as tg: | ||
pass | ||
coro = asyncio.sleep(0) | ||
with self.assertRaisesRegex(RuntimeError, "is finished"): | ||
tg.create_task(coro) | ||
loop = asyncio.get_event_loop() | ||
loop.run_until_complete(run_coro_after_tg_closes()) | ||
|
||
await run_coro_after_tg_closes() | ||
|
||
async def test_cancelling_level_preserved(self): | ||
async def raise_after(t, e): | ||
|
@@ -965,6 +979,30 @@ async def coro_fn(): | |
self.assertIsInstance(exc, _Done) | ||
self.assertListEqual(gc.get_referrers(exc), no_other_refs()) | ||
|
||
|
||
async def test_exception_refcycles_parent_task_wr(self): | ||
"""Test that TaskGroup deletes self._parent_task and create_task() deletes task""" | ||
tg = asyncio.TaskGroup() | ||
exc = None | ||
|
||
class _Done(Exception): | ||
pass | ||
|
||
async def coro_fn(): | ||
async with tg: | ||
raise _Done | ||
|
||
with disable_gc(): | ||
try: | ||
async with asyncio.TaskGroup() as tg2: | ||
task_wr = weakref.ref(tg2.create_task(coro_fn())) | ||
except* _Done as excs: | ||
exc = excs.exceptions[0].exceptions[0] | ||
|
||
self.assertIsNone(task_wr()) | ||
self.assertIsInstance(exc, _Done) | ||
self.assertListEqual(gc.get_referrers(exc), no_other_refs()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it was later changed that coro doesn't hold ref to locals, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah its not merged yet #125640 |
||
|
||
async def test_exception_refcycles_propagate_cancellation_error(self): | ||
"""Test that TaskGroup deletes propagate_cancellation_error""" | ||
tg = asyncio.TaskGroup() | ||
|
@@ -998,5 +1036,16 @@ class MyKeyboardInterrupt(KeyboardInterrupt): | |
self.assertListEqual(gc.get_referrers(exc), no_other_refs()) | ||
|
||
|
||
class TestTaskGroup(BaseTestTaskGroup, unittest.IsolatedAsyncioTestCase): | ||
loop_factory = asyncio.EventLoop | ||
|
||
class TestEagerTaskTaskGroup(BaseTestTaskGroup, unittest.IsolatedAsyncioTestCase): | ||
@staticmethod | ||
def loop_factory(): | ||
loop = asyncio.EventLoop() | ||
loop.set_task_factory(asyncio.eager_task_factory) | ||
return loop | ||
|
||
|
||
if __name__ == "__main__": | ||
unittest.main() |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Fix cyclic garbage introduced by :meth:`asyncio.loop.create_task` and :meth:`asyncio.TaskGroup.create_task` holding a reference to the created task if it is eager. |
Uh oh!
There was an error while loading. Please reload this page.