__await__ 的精确说明

Question

Python 语言参考指定object.__await__ 如下：

object.__await__(self)

必须返回一个迭代器。应该用于实现等待对象。例如，asyncio.Future 实现此方法以兼容 await 表达式。

就是这样。我发现这个规范非常模糊而且不是很具体（具有讽刺意味的是）。好的，它应该返回一个迭代器，但它可以是一个任意的迭代器吗？显然不是：

import asyncio


class Spam:
    def __await__(self):
        yield from range(10)


async def main():
    await Spam()


asyncio.run(main())

RuntimeError: Task got bad yield: 0

我假设asyncio 事件循环期望迭代器产生一种特定类型的对象。那么它应该究竟产生什么？ （为什么没有记录？）

---

编辑：据我所知，这在任何地方都没有记录。但我一直在自己调查，我认为了解asyncio 期望其协程产生哪些对象的关键在于_asynciomodule.c 中的task_step_impl。

---

更新：我已经对 cpython 存储库进行了 PR，目的是澄清这一点："Clarify the vague specification of object.__await__"。目前正在审核中。

Answer 1

任务只能等待其他任务/未来。来自CPython source code：

    /* Check if `result` is FutureObj or TaskObj (and not a subclass) */
    /* ... */

    /* Check if `result` is None */
    /* ... error */

    /* Check if `result` is a Future-compatible object */
    /* ... */

    /* Check if `result` is a generator */
    /* ... */

    /* The `result` is none of the above */
    o = task_set_error_soon(
        task, PyExc_RuntimeError, "Task got bad yield: %R", result);
    Py_DECREF(result);
    return o;

---

编辑：如果我理解正确，此限制仅适用于任务，并且正常的期货可以等待从__await__ 返回的任何可迭代对象，尽管重点可能是可迭代对象返回的结果是事件循环，然后最终结束返回结果。

Answer 2

语言不关心你返回哪个迭代器。错误来自 library asyncio，它对迭代器必须生成的值的种类有特定的想法。 Asyncio 需要 __await__ 来生成 asyncio 期货（包括它们的子类型，例如任务）或 None。其他库，如 curio 和 trio，将期望不同类型的值。总的来说，异步库不会记录他们对 __await__ 的期望，因为他们认为这是一个实现细节。

就 asyncio 而言，除了协程之外，您还应该使用更高级别的构造，例如期货和任务，并等待这些构造。很少需要手动实现__await__，即使then 你也应该使用它来委托另一个等待的信号。编写一个 __await__ 来创建并产生自己的新挂起值要求它与事件循环耦合并了解其内部结构。

您可以将__await__ 视为编写类似于asyncio 的库的工具。如果你是这样一个库的作者，那么当前的规范就足够了，因为你可以从迭代器中产生任何你喜欢的东西，只有你的事件循环中的代码会观察到产生的值。如果你不在那个位置，你可能不需要实现__await__。