Python异步上下文管理器

Question

Python异步上下文管理器

4

在Python语言参考3.4.4中，指出__aenter__()和__aexit__()必须返回可等待对象。然而，在异步上下文管理器示例中，这两个方法返回None：

class AsyncContextManager:
    async def __aenter__(self):
        await log('entering context')

    async def __aexit__(self, exc_type, exc, tb):
        await log('exiting context')

这段代码是否正确？

- Z. Qui

2个回答

3

你的__aenter__方法必须返回一个上下文。

class MyAsyncContextManager:
    async def __aenter__(self):
        await log('entering context')
        # maybe some setup (e.g. await self.setup())
        return self

    async def __aexit__(self, exc_type, exc, tb):
        # maybe closing context (e.g. await self.close())
        await log('exiting context')

    async def do_something(self):
        await log('doing something')

使用方法：

async with MyAsyncContextManager() as context:
    await context.do_something()

- Tim tj timer Jedro

2

并不完全正确。__aenter__是允许返回某些内容的，但它并不一定要这样做。并非所有上下文管理器（异步或非异步）都需要该功能。（此外，如果它确实返回了某些内容，那么这个东西不一定是“上下文”）。 - user2357112

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- user2357112 · Accepted Answer

__aenter__和__aexit__必须返回可等待对象，但是当您调用示例中的这些函数时会发生什么呢：

>>> class AsyncContextManager:
...     async def __aenter__(self):
...         await log('entering context')
...     async def __aexit__(self, exc_type, exc, tb):
...         await log('exiting context')
... 
>>> AsyncContextManager().__aenter__()
<coroutine object AsyncContextManager.__aenter__ at 0x7f5b092d5ac0>

它没有返回None！我们得到了一个协程对象，这是可等待的。

这些方法是async函数，自动返回（可等待）的异步协程。在async函数体中的return语句决定了当您await协程时返回什么，而不是调用函数时返回什么。

这类似于生成器函数返回生成器迭代器，即使它们通常没有return语句，以及如果您将__iter__编写为生成器函数，则不应尝试在生成器函数内部return迭代器。

如果您在定义为async函数的__aenter__或__aexit__中放置return语句会发生什么？您可以这样做，如果这样做，return语句不必返回可等待对象。以下是Python的处理方式。

如果您从定义为async函数的__aenter__中return了某些内容，则决定将其绑定到as目标的内容（如果async with使用as）。

如果您从定义为async函数的__aexit__中return了某些内容，则确定是否抑制在块内引发的异常。"真值"表示告诉async with抑制异常，而"假值"表示告诉async with让异常传播。默认值None为假值，因此默认情况下不会抑制异常。

以下是一个示例：

import asyncio

class Example:
    async def __aenter__(self):
        return 3
    async def __aexit__(self, exc_type, exc, tb):
        return True

async def example():
    async with Example() as three:
        print(three == 3)
        raise Exception
    print("Exception got suppressed")

asyncio.run(example())

输出:

True
Exception got suppressed