`test_contextlib_async` produces several `RuntimeWarning`s #110378

sobolevn · 2023-10-05T07:59:56Z

Bug report

» ./python.exe -m test test_contextlib_async
Using random seed 908291980
0:00:00 load avg: 4.08 Run 1 test sequentially
0:00:00 load avg: 4.08 [1/1] test_contextlib_async
/Users/sobolev/Desktop/cpython/Lib/contextlib.py:701: RuntimeWarning: coroutine method 'aclose' of 'AsyncContextManagerTestCase.test_contextmanager_trap_second_yield.<locals>.whoo' was never awaited
  async def __aenter__(self):
RuntimeWarning: Enable tracemalloc to get the object allocation traceback
/Users/sobolev/Desktop/cpython/Lib/contextlib.py:701: RuntimeWarning: coroutine method 'aclose' of 'AsyncContextManagerTestCase.test_contextmanager_trap_yield_after_throw.<locals>.whoo' was never awaited
  async def __aenter__(self):
RuntimeWarning: Enable tracemalloc to get the object allocation traceback
/Users/sobolev/Desktop/cpython/Lib/contextlib.py:701: RuntimeWarning: coroutine method 'aclose' of 'TestAbstractAsyncContextManager.test_async_gen_propagates_generator_exit.<locals>.gen' was never awaited
  async def __aenter__(self):
RuntimeWarning: Enable tracemalloc to get the object allocation traceback

== Tests result: SUCCESS ==

1 test OK.

Total duration: 121 ms
Total tests: run=58
Total test files: run=1/1
Result: SUCCESS

This can be fixed by moving away from legacy @_async_test and by using stabel IsolatedAsyncioTestCase.

cpython/Lib/test/test_contextlib_async.py

Lines 14 to 20 in 6592976

    
           def _async_test(func): 
        
               """Decorator to turn an async function into a test case.""" 
        
               @functools.wraps(func) 
        
               def wrapper(*args, **kwargs): 
        
                   coro = func(*args, **kwargs) 
        
                   asyncio.run(coro) 
        
               return wrapper

Linked PRs

The text was updated successfully, but these errors were encountered:

…async.py`

serhiy-storchaka · 2023-10-07T10:18:59Z

There are two issues here.

test_async_gen_propagates_generator_exit (added in bpo-33786/@asynccontextmanager doesn't work well with async generators #77967, PR bpo-33786: Fix asynchronous generators to handle GeneratorExit in athrow() #7467) creates an asynchronous generator, but do not iterate it to the end (it would close it implicitly) and do not close it explicitly. Actually, this test does not work at all. It is passed with unpatched code, it only prints a traceback from implicitly called destructor. It also contains code not related to the issue. This test should be rewritten.
test_contextmanager_trap_yield_after_throw and test_contextmanager_trap_second_yield test asynccontextmanager with an asynchronous generator with second yield. asynccontextmanager raises RuntimeError, but leaves the underlying asynchronous generator object not closed. Such generator is a programming error, and we don't have to clean up after this, but the "gen" attribute of asynccontextmanager object is an implementation detail, so it is better to not leave it to user and do clean up. The __exit__ method should close the underlying asynchronous generator object.

Moving to IsolatedAsyncioTestCase looks like a good thing, but only after fixing the deeper issues.

…contextmanager contextmanager and asynccontextmanager context managers now close an invalid underlying generator object that yields more then one value.

…_contextlib_async It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code.

…py` (#110379)

…tmanager (GH-110499) contextmanager and asynccontextmanager context managers now close an invalid underlying generator object that yields more then one value.

…contextmanager (pythonGH-110499) contextmanager and asynccontextmanager context managers now close an invalid underlying generator object that yields more then one value. (cherry picked from commit 96fed66) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

…ccontextmanager (GH-110499) (#110588) contextmanager and asynccontextmanager context managers now close an invalid underlying generator object that yields more then one value. (cherry picked from commit 96fed66) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

…ccontextmanager (GH-110499) (#110589) contextmanager and asynccontextmanager context managers now close an invalid underlying generator object that yields more then one value. (cherry picked from commit 96fed66) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>

…xtlib_async (#110500) It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code.

…_contextlib_async (pythonGH-110500) It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code. (cherry picked from commit 5aa62a8) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

…t_contextlib_async (GH-110500) (#110610) It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code. (cherry picked from commit 5aa62a8) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

…t_contextlib_async (GH-110500) (#110611) It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code. (cherry picked from commit 5aa62a8) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

ambv · 2023-10-10T11:13:01Z

This is solved, thanks! ✨ 🍰 ✨

serhiy-storchaka · 2023-10-10T13:05:12Z

Thank you for your reviews @ambv.

…async.py` (python#110379)

…contextmanager (pythonGH-110499) contextmanager and asynccontextmanager context managers now close an invalid underlying generator object that yields more then one value.

…_contextlib_async (python#110500) It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code.

sobolevn added type-bug An unexpected behavior, bug, or error tests Tests in the Lib/test dir topic-asyncio labels Oct 5, 2023

sobolevn self-assigned this Oct 5, 2023

github-project-automation bot added this to asyncio Oct 5, 2023

github-project-automation bot moved this to Todo in asyncio Oct 5, 2023

sobolevn added a commit to sobolevn/cpython that referenced this issue Oct 5, 2023

pythongh-110378: Move to IsolatedAsyncTestCase in `test_contextlib_…

35ae2ee

…async.py`

sobolevn added a commit to sobolevn/cpython that referenced this issue Oct 5, 2023

pythongh-110378: Move to IsolatedAsyncTestCase in `test_contextlib_…

cccdac2

…async.py`

bedevere-app bot mentioned this issue Oct 5, 2023

gh-110378: Move to IsolatedAsyncTestCase in test_contextlib_async.py #110379

Merged

serhiy-storchaka self-assigned this Oct 7, 2023

bedevere-app bot mentioned this issue Oct 7, 2023

gh-110378: Close invalid generators in contextmanager and asynccontextmanager #110499

Merged

bedevere-app bot mentioned this issue Oct 7, 2023

gh-110378: Fix test_async_gen_propagates_generator_exit in test_contextlib_async #110500

Merged

kumaraditya303 pushed a commit that referenced this issue Oct 8, 2023

gh-110378: Move to IsolatedAsyncTestCase in `test_contextlib_async.…

6780d63

…py` (#110379)

bedevere-app bot mentioned this issue Oct 10, 2023

[3.12] gh-110378: Close invalid generators in contextmanager and asynccontextmanager (GH-110499) #110588

Merged

bedevere-app bot mentioned this issue Oct 10, 2023

[3.11] gh-110378: Close invalid generators in contextmanager and asynccontextmanager (GH-110499) #110589

Merged

ambv pushed a commit that referenced this issue Oct 10, 2023

gh-110378: Fix test_async_gen_propagates_generator_exit in test_conte…

5aa62a8

…xtlib_async (#110500) It now fails if the original bug is not fixed, and no longer produce ResourceWarning with fixed code.

This was referenced Oct 10, 2023

[3.12] gh-110378: Fix test_async_gen_propagates_generator_exit in test_contextlib_async (GH-110500) #110610

Merged

[3.11] gh-110378: Fix test_async_gen_propagates_generator_exit in test_contextlib_async (GH-110500) #110611

Merged

ambv closed this as completed Oct 10, 2023

github-project-automation bot moved this from Todo to Done in asyncio Oct 10, 2023

serhiy-storchaka mentioned this issue Oct 17, 2023

Synchronize test_contextlib with test_contextlib_async #111000

Merged

Sachaa-Thanasius mentioned this issue Jun 2, 2024

Fix the signatures of @(async)contextmanager python/typeshed#12087

Open

Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024

pythongh-110378: Move to IsolatedAsyncTestCase in `test_contextlib_…

b3ca398

…async.py` (python#110379)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`test_contextlib_async` produces several `RuntimeWarning`s #110378

`test_contextlib_async` produces several `RuntimeWarning`s #110378

sobolevn commented Oct 5, 2023 •

edited by bedevere-app bot

Loading

serhiy-storchaka commented Oct 7, 2023

ambv commented Oct 10, 2023

serhiy-storchaka commented Oct 10, 2023

test_contextlib_async produces several RuntimeWarnings #110378

test_contextlib_async produces several RuntimeWarnings #110378

Comments

sobolevn commented Oct 5, 2023 • edited by bedevere-app bot Loading

Bug report

Linked PRs

serhiy-storchaka commented Oct 7, 2023

ambv commented Oct 10, 2023

serhiy-storchaka commented Oct 10, 2023

`test_contextlib_async` produces several `RuntimeWarning`s #110378

`test_contextlib_async` produces several `RuntimeWarning`s #110378

sobolevn commented Oct 5, 2023 •

edited by bedevere-app bot

Loading