bpo-41543: contextlib.nullcontext can fill in for an async context manager (GH-21870)
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
This commit is contained in:
parent
97e8b1eaea
commit
a117167d8d
|
@ -243,8 +243,26 @@ Functions and classes provided:
|
||||||
with cm as file:
|
with cm as file:
|
||||||
# Perform processing on the file
|
# Perform processing on the file
|
||||||
|
|
||||||
|
It can also be used as a stand-in for
|
||||||
|
:ref:`asynchronous context managers <async-context-managers>`::
|
||||||
|
|
||||||
|
async def send_http(session=None):
|
||||||
|
if not session:
|
||||||
|
# If no http session, create it with aiohttp
|
||||||
|
cm = aiohttp.ClientSession()
|
||||||
|
else:
|
||||||
|
# Caller is responsible for closing the session
|
||||||
|
cm = nullcontext(session)
|
||||||
|
|
||||||
|
async with cm as session:
|
||||||
|
# Send http requests with session
|
||||||
|
|
||||||
.. versionadded:: 3.7
|
.. versionadded:: 3.7
|
||||||
|
|
||||||
|
.. versionchanged:: 3.10
|
||||||
|
:term:`asynchronous context manager` support was added.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. function:: suppress(*exceptions)
|
.. function:: suppress(*exceptions)
|
||||||
|
|
||||||
|
|
|
@ -704,7 +704,7 @@ class AsyncExitStack(_BaseExitStack, AbstractAsyncContextManager):
|
||||||
return received_exc and suppressed_exc
|
return received_exc and suppressed_exc
|
||||||
|
|
||||||
|
|
||||||
class nullcontext(AbstractContextManager):
|
class nullcontext(AbstractContextManager, AbstractAsyncContextManager):
|
||||||
"""Context manager that does no additional processing.
|
"""Context manager that does no additional processing.
|
||||||
|
|
||||||
Used as a stand-in for a normal context manager, when a particular
|
Used as a stand-in for a normal context manager, when a particular
|
||||||
|
@ -723,3 +723,9 @@ class nullcontext(AbstractContextManager):
|
||||||
|
|
||||||
def __exit__(self, *excinfo):
|
def __exit__(self, *excinfo):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
async def __aenter__(self):
|
||||||
|
return self.enter_result
|
||||||
|
|
||||||
|
async def __aexit__(self, *excinfo):
|
||||||
|
pass
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
import asyncio
|
import asyncio
|
||||||
from contextlib import aclosing, asynccontextmanager, AbstractAsyncContextManager, AsyncExitStack
|
from contextlib import (
|
||||||
|
asynccontextmanager, AbstractAsyncContextManager,
|
||||||
|
AsyncExitStack, nullcontext, aclosing)
|
||||||
import functools
|
import functools
|
||||||
from test import support
|
from test import support
|
||||||
import unittest
|
import unittest
|
||||||
|
@ -537,5 +539,15 @@ class TestAsyncExitStack(TestBaseExitStack, unittest.TestCase):
|
||||||
self.assertIsInstance(inner_exc.__context__, ZeroDivisionError)
|
self.assertIsInstance(inner_exc.__context__, ZeroDivisionError)
|
||||||
|
|
||||||
|
|
||||||
|
class TestAsyncNullcontext(unittest.TestCase):
|
||||||
|
@_async_test
|
||||||
|
async def test_async_nullcontext(self):
|
||||||
|
class C:
|
||||||
|
pass
|
||||||
|
c = C()
|
||||||
|
async with nullcontext(c) as c_in:
|
||||||
|
self.assertIs(c_in, c)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
Add async context manager support for contextlib.nullcontext.
|
Loading…
Reference in New Issue