0

0

如何实现一个支持 await 的自定义 awaitable 对象

冷炫風刃

冷炫風刃

发布时间:2026-01-23 20:23:02

|

996人浏览过

|

来源于php中文网

原创

__await__ 方法必须返回迭代器,因为 await 表达式底层依赖可等待对象协议,该协议要求 __await__ 返回支持 __next__() 和 throw() 的迭代器实例,而非任意可迭代对象或协程。

如何实现一个支持 await 的自定义 awaitable 对象

为什么 __await__ 方法必须返回迭代器

Python 的 await 表达式底层依赖的是「可等待对象」(awaitable)协议,而该协议的唯一硬性要求是对象实现 __await__ 方法,且该方法**必须返回一个迭代器(iterator)**——不是任意可迭代对象(如 list、generator expression),也不是协程对象,而是真正支持 .__next__().throw() 的迭代器实例。

常见错误是直接在 __await__return [awaitable]yield from some_coro,这会导致 TypeError: object X can't be used in 'await' expression

实操建议:

  • __await__ 内部应调用 iter() 包装一个生成器函数,或直接返回一个自定义迭代器类实例
  • 若逻辑简单(如立即完成),可用 return iter([result]);但注意:单元素 list 不是迭代器,必须显式调用 iter()
  • 若需异步等待某个 IO 操作,应在生成器中 yield 一次(表示让出控制权),并在恢复后返回结果

如何用生成器函数实现最小可行的 awaitable

最轻量的方式是把 __await__ 实现为一个生成器函数,并用 return 提前结束(Python 3.3+ 支持生成器中 return value,其值会作为 StopIteration.valueawait 捕获)。

示例:

class Delay:
    def __init__(self, seconds):
        self.seconds = seconds
def __await__(self):
    # 这是一个生成器函数,返回的是 generator iterator
    yield  # 模拟一次挂起(实际中可对接 loop.call_later 等)
    return f"done after {self.seconds}s"

使用

import asyncio async def main(): res = await Delay(1) print(res) # "done after 1s"

asyncio.run(main())

关键点:

  • yield 是必需的——没有它,函数就不是生成器,返回的是普通函数对象,不满足 awaitable 协议
  • return 值会被 await 提取为表达式结果;若没 return,则默认为 None
  • 这个生成器本身不处理事件循环调度,只是“假装”挂起;真实场景中需在 yield 前注册回调或调用 loop.create_future()

如何对接事件循环:用 Future 驱动自定义 awaitable

如果希望你的 awaitable 真正参与事件循环调度(比如延迟执行、等待文件描述符就绪),不能只靠 yield,而应返回一个迭代器,其 __next__ 方法返回一个 Future 对象(或其它 awaitable),再由解释器自动 await 它。

更稳妥的做法是:在 __await__ 中返回一个包装了 Future 的迭代器。标准库asyncio.Future.__await__ 就是这么做的。

illostrationAI
illostrationAI

AI插画生成,lowpoly、3D、矢量、logo、像素风、皮克斯等风格

下载

实操建议:

  • 不要手动 await 其它协程,而是把控制权交还给事件循环:让 __await__ 返回的迭代器在每次 .__next__() 时返回一个 Future
  • 使用 asyncio.get_event_loop().create_future() 创建 future,并在适当时机 .set_result().set_exception()
  • 确保该 future 最终被事件循环驱动完成;否则 await 会永远挂起

简化版示意(不推荐直接用于生产,仅说明原理):

class SleepLike:
    def __init__(self, delay):
        self.delay = delay
def __await__(self):
    loop = asyncio.get_event_loop()
    fut = loop.create_future()
    loop.call_later(self.delay, fut.set_result, None)
    # 返回一个迭代器,第一次 next() 就 yield 这个 future
    return (lambda: fut).__await__()

注意:fut.__await__() 返回的是一个迭代器,所以最后一行等价于 return fut.__await__() —— 这正是复用标准 awaitable 协议的正确方式。

容易被忽略的细节:__await__ 不该抛异常,也不该被多次调用

__await__ 方法本身不应抛出异常(如 RuntimeErrorValueError),因为一旦抛出,await 表达式会直接失败,而不是进入等待流程。更隐蔽的问题是:同一个 awaitable 实例的 __await__ 可能被多次调用(例如在 await x 失败重试时,或某些调试器中),但它返回的迭代器**不可重用**——迭代器耗尽后再次 .__next__() 会抛 StopIteration

这意味着:

  • 每次 await 都应触发一次新的 __await__() 调用,返回新迭代器;不能缓存并复用旧迭代器
  • 不要在 __await__ 中做带副作用的初始化(如启动线程、打开 socket),除非你明确允许重复执行
  • 若需状态管理(如“已开始”“已完成”),状态应放在 awaitable 实例上,而非迭代器内部

最安全的模式,就是让 __await__ 总是返回一个新生成器或新迭代器实例——Python 自带的生成器函数天然满足这点。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

772

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

661

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

765

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

679

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1385

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

570

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

730

2023.08.11

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

10

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 15.3万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号