Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-30241: implement contextlib.AbstractAsyncContextManager #1412

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

Merged
merged 6 commits into from
Dec 14, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Doc/library/contextlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions Doc/whatsnew/3.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
27 changes: 25 additions & 2 deletions Lib/contextlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]


Expand All @@ -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."

Expand Down Expand Up @@ -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):
Expand Down
49 changes: 48 additions & 1 deletion Lib/test/test_contextlib_async.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import asyncio
from contextlib import asynccontextmanager
from contextlib import asynccontextmanager, AbstractAsyncContextManager
import functools
from test import support
import unittest
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add contextlib.AbstractAsyncContextManager. Patch by Jelle Zijlstra.