联合异步迭代器会发生什么？

Question

假设我有以下功能

async def f1():
    async for item in asynciterator():
        return

之后异步迭代器会发生什么

await f1()

？我应该担心清理工作吗，或者生成器在看不见时会以某种方式被垃圾收集吗？

Answer 1

我应该担心清理工作还是发电机在看不见时会被垃圾收集？

TL;DR Python 的 gc 和 asyncio 将确保最终清理不完全迭代的异步生成器。

此处的“清理”指的是运行由finally 围绕yield 指定的代码，或由with 围绕yield 语句中使用的上下文管理器的__aexit__ 部分指定的代码。例如，这个简单生成器中的 print 被 aiohttp.ClientSession 用来关闭其资源的相同机制调用：

async def my_gen():
    try:
        yield 1
        yield 2
        yield 3
    finally:
        await asyncio.sleep(0.1)  # make it interesting by awaiting
        print('cleaned up')

如果你运行一个遍历整个生成器的协程，清理将立即执行：

>>> async def test():
...     gen = my_gen()
...     async for _ in gen:
...         pass
...     print('test done')
... 
>>> asyncio.get_event_loop().run_until_complete(test())
cleaned up
test done

请注意在循环之后如何立即执行清理，即使生成器仍在范围内而没有机会收集垃圾。这是因为async for 循环确保异步生成器在循环耗尽时进行清理。

问题是当循环没有用尽时会发生什么：

>>> async def test():
...     gen = my_gen()
...     async for _ in gen:
...         break  # exit at once
...     print('test done')
... 
>>> asyncio.get_event_loop().run_until_complete(test())
test done

这里gen 超出了范围，但根本没有进行清理。如果你用一个普通的生成器尝试这个，清理会被立即反击的引用调用（尽管仍然在退出test，因为那时正在运行的生成器不再被引用），这是可能的，因为gen 不参与循环：

>>> def my_gen():
...     try:
...         yield 1
...         yield 2
...         yield 3
...     finally:
...         print('cleaned up')
... 
>>> def test():
...     gen = my_gen()
...     for _ in gen:
...         break
...     print('test done')
... 
>>> test()
test done
cleaned up

my_gen 是一个异步生成器，它的清理也是异步的。这意味着它不能只由垃圾收集器执行，它需要由事件循环运行。为了实现这一点，asyncio registers asyncgen 终结器钩子，但它永远不会有机会执行，因为我们使用的是 run_until_complete，它在执行协程后立即停止循环。

如果我们尝试再次旋转相同的事件循环，我们会看到执行了清理：

>>> asyncio.get_event_loop().run_until_complete(asyncio.sleep(0))
cleaned up

在普通的 asyncio 应用程序中，这不会导致问题，因为事件循环通常与应用程序一样长时间运行。如果没有事件循环来清理异步生成器，则可能意味着进程无论如何都退出了。