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
<pre class="brush:php;toolbar:false;">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__ 就是这么做的。

皮卡智能
皮卡智能

AI驱动高效视觉设计平台

下载

实操建议:

  • 不要手动 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
<pre class="brush:php;toolbar:false;">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 自带的生成器函数天然满足这点。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

192

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

18

2026.02.03

线程和进程的区别
线程和进程的区别

线程和进程的区别:线程是进程的一部分,用于实现并发和并行操作,而线程共享进程的资源,通信更方便快捷,切换开销较小。本专题为大家提供线程和进程区别相关的各种文章、以及下载和课程。

765

2023.08.10

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

22

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

48

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

93

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

216

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

412

2026.03.04

AI安装教程大全
AI安装教程大全

2026最全AI工具安装教程专题:包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好,附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新,收藏这一篇就够了,让AI安装不再报错!

143

2026.03.04

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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