[Python-checkins] bpo-30241: implement contextlib.AbstractAsyncContextManager (#1412)
Yury Selivanov
webhook-mailer at python.org
Wed Dec 13 20:19:20 EST 2017
https://github.com/python/cpython/commit/176baa326be4ec2dc70ca0c054b7e2ab7ca6a9cf
commit: 176baa326be4ec2dc70ca0c054b7e2ab7ca6a9cf
branch: master
author: Jelle Zijlstra <jelle.zijlstra at gmail.com>
committer: Yury Selivanov <yury at magic.io>
date: 2017-12-13T20:19:17-05:00
summary:
bpo-30241: implement contextlib.AbstractAsyncContextManager (#1412)
files:
A Misc/NEWS.d/next/Library/2017-10-10-18-56-46.bpo-30241.F_go20.rst
M Doc/library/contextlib.rst
M Doc/whatsnew/3.7.rst
M Lib/contextlib.py
M Lib/test/test_contextlib_async.py
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index 48ca0da6b95..faa6c8ac23b 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -29,6 +29,17 @@ Functions and classes provided:
.. versionadded:: 3.6
+.. class:: AbstractAsyncContextManager
+
+ An :term:`abstract base class` for classes that implement
+ :meth:`object.__aenter__` and :meth:`object.__aexit__`. A default
+ implementation for :meth:`object.__aenter__` is provided which returns
+ ``self`` while :meth:`object.__aexit__` is an abstract method which by default
+ returns ``None``. See also the definition of
+ :ref:`async-context-managers`.
+
+ .. versionadded:: 3.7
+
.. decorator:: contextmanager
diff --git a/Doc/whatsnew/3.7.rst b/Doc/whatsnew/3.7.rst
index 81a88a0c82e..80f2a7f3a1e 100644
--- a/Doc/whatsnew/3.7.rst
+++ b/Doc/whatsnew/3.7.rst
@@ -306,8 +306,9 @@ is a list of strings, not bytes.
contextlib
----------
-:func:`contextlib.asynccontextmanager` has been added. (Contributed by
-Jelle Zijlstra in :issue:`29679`.)
+:func:`~contextlib.asynccontextmanager` and
+:class:`~contextlib.AbstractAsyncContextManager` have been added. (Contributed
+by Jelle Zijlstra in :issue:`29679` and :issue:`30241`.)
cProfile
--------
diff --git a/Lib/contextlib.py b/Lib/contextlib.py
index c1f8a84617f..96c8c22084a 100644
--- a/Lib/contextlib.py
+++ b/Lib/contextlib.py
@@ -6,7 +6,8 @@
from functools import wraps
__all__ = ["asynccontextmanager", "contextmanager", "closing", "nullcontext",
- "AbstractContextManager", "ContextDecorator", "ExitStack",
+ "AbstractContextManager", "AbstractAsyncContextManager",
+ "ContextDecorator", "ExitStack",
"redirect_stdout", "redirect_stderr", "suppress"]
@@ -30,6 +31,27 @@ def __subclasshook__(cls, C):
return NotImplemented
+class AbstractAsyncContextManager(abc.ABC):
+
+ """An abstract base class for asynchronous context managers."""
+
+ async def __aenter__(self):
+ """Return `self` upon entering the runtime context."""
+ return self
+
+ @abc.abstractmethod
+ async def __aexit__(self, exc_type, exc_value, traceback):
+ """Raise any exception triggered within the runtime context."""
+ return None
+
+ @classmethod
+ def __subclasshook__(cls, C):
+ if cls is AbstractAsyncContextManager:
+ return _collections_abc._check_methods(C, "__aenter__",
+ "__aexit__")
+ return NotImplemented
+
+
class ContextDecorator(object):
"A base class or mixin that enables context managers to work as decorators."
@@ -136,7 +158,8 @@ def __exit__(self, type, value, traceback):
raise RuntimeError("generator didn't stop after throw()")
-class _AsyncGeneratorContextManager(_GeneratorContextManagerBase):
+class _AsyncGeneratorContextManager(_GeneratorContextManagerBase,
+ AbstractAsyncContextManager):
"""Helper for @asynccontextmanager."""
async def __aenter__(self):
diff --git a/Lib/test/test_contextlib_async.py b/Lib/test/test_contextlib_async.py
index 42cc331c0af..447ca965122 100644
--- a/Lib/test/test_contextlib_async.py
+++ b/Lib/test/test_contextlib_async.py
@@ -1,5 +1,5 @@
import asyncio
-from contextlib import asynccontextmanager
+from contextlib import asynccontextmanager, AbstractAsyncContextManager
import functools
from test import support
import unittest
@@ -20,6 +20,53 @@ def wrapper(*args, **kwargs):
return wrapper
+class TestAbstractAsyncContextManager(unittest.TestCase):
+
+ @_async_test
+ async def test_enter(self):
+ class DefaultEnter(AbstractAsyncContextManager):
+ async def __aexit__(self, *args):
+ await super().__aexit__(*args)
+
+ manager = DefaultEnter()
+ self.assertIs(await manager.__aenter__(), manager)
+
+ async with manager as context:
+ self.assertIs(manager, context)
+
+ def test_exit_is_abstract(self):
+ class MissingAexit(AbstractAsyncContextManager):
+ pass
+
+ with self.assertRaises(TypeError):
+ MissingAexit()
+
+ def test_structural_subclassing(self):
+ class ManagerFromScratch:
+ async def __aenter__(self):
+ return self
+ async def __aexit__(self, exc_type, exc_value, traceback):
+ return None
+
+ self.assertTrue(issubclass(ManagerFromScratch, AbstractAsyncContextManager))
+
+ class DefaultEnter(AbstractAsyncContextManager):
+ async def __aexit__(self, *args):
+ await super().__aexit__(*args)
+
+ self.assertTrue(issubclass(DefaultEnter, AbstractAsyncContextManager))
+
+ class NoneAenter(ManagerFromScratch):
+ __aenter__ = None
+
+ self.assertFalse(issubclass(NoneAenter, AbstractAsyncContextManager))
+
+ class NoneAexit(ManagerFromScratch):
+ __aexit__ = None
+
+ self.assertFalse(issubclass(NoneAexit, AbstractAsyncContextManager))
+
+
class AsyncContextManagerTestCase(unittest.TestCase):
@_async_test
diff --git a/Misc/NEWS.d/next/Library/2017-10-10-18-56-46.bpo-30241.F_go20.rst b/Misc/NEWS.d/next/Library/2017-10-10-18-56-46.bpo-30241.F_go20.rst
new file mode 100644
index 00000000000..9b6c6f6e422
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2017-10-10-18-56-46.bpo-30241.F_go20.rst
@@ -0,0 +1 @@
+Add contextlib.AbstractAsyncContextManager. Patch by Jelle Zijlstra.
More information about the Python-checkins
mailing list