0

0

如何让异步生成器支持 async for 但保持兼容同步调用

冰川箭仙

冰川箭仙

发布时间:2026-01-23 20:48:10

|

260人浏览过

|

来源于php中文网

原创

async for 要求对象实现 __aiter__ 而非 __iter__;同步生成器无 __aiter__,故不可用;需自定义类分别实现 __iter__(yield)和 __aiter__(返回 async def 函数调用结果),且不可混用 yield 与 await。

如何让异步生成器支持 async for 但保持兼容同步调用

async for 要求对象实现 __aiter__,不是 __iter__

同步生成器函数(用 yield)返回的是 generator 对象,它有 __iter__ 但没有 __aiter__,所以不能用于 async for。强行用会报错:TypeError: 'generator' object is not async iterable。关键不是“加个 async 就行”,而是得返回一个真正支持异步迭代协议的对象——即实现了 __aiter__ 且其返回值有 __anext__ 方法的实例。

用类封装:同时实现 __iter____aiter__

最稳妥的方式是写一个自定义类,在初始化时接收原始数据或参数,然后在 __iter__ 中用普通 yield,在 __aiter__ 中返回一个异步生成器(async def + yield)。注意:不能让 __aiter__ 直接 return self,除非你同时给它加上 __anext__;更推荐让它返回 async_generator 实例。

示例结构:

class DualIterable:
    def __init__(self, items):
        self.items = items
def __iter__(self):
    for x in self.items:
        yield x * 2

def __aiter__(self):
    return self._aiter_impl()

async def _aiter_impl(self):
    for x in self.items:
        await asyncio.sleep(0.01)  # 模拟异步开销
        yield x * 2

⚠️ 注意:_aiter_implasync def,但它本身不能直接被 async for 使用;必须由 __aiter__ 返回一个异步生成器对象,所以上面写法是错的。正确写法是:

    def __aiter__(self):
        return self._aiter_impl().__aiter__()  # 错误!

实际应改为:

    def __aiter__(self):
        return self._aiter_impl()  # ✅ 正确:async def 函数调用后返回 async_generator

避免常见陷阱:不要混用 yieldawait 在同一个函数里

这是 Python 明确禁止的语法错误:SyntaxError: 'await' outside async functionSyntaxError: 'yield' inside async function with 'await'(取决于版本)。也就是说,你不能写这样的函数:

ghiblitattoo
ghiblitattoo

用AI创造独特的吉卜力纹身

下载
async def bad_mix():
    yield 1      # ❌ 不合法
    await asyncio.sleep(1)

所以必须拆开:同步路径走普通生成器,异步路径走独立的 async def 生成器。两者共享逻辑时,把核心处理抽成普通函数,再分别包装。

  • 同步迭代:用 def + yield,内部调用纯函数
  • 异步迭代:用 async def + yield,内部也调用同一纯函数,但允许穿插 await
  • 别试图在类里只靠一个方法兼顾两种协议——协议语义不同,硬塞只会出错

兼容性细节:Python 版本与 asyncio 运行时要求

async for 自 Python 3.5 起可用,但异步生成器(async def + yield)要到 3.6 才正式支持。如果你需要支持 3.5,就得用 asyncio.coroutine + types.AsyncGeneratorType 手动构造,非常麻烦,不建议。

另外,即使对象实现了 __aiter__,如果在非 asyncio 事件循环中运行(比如主线程没调用 asyncio.run()),async for 仍会失败,报 RuntimeError: no running event loop。这不是你的类的问题,而是调用环境缺失。

真正容易被忽略的是:同步调用者可能期望返回的是原生 generator,而你的类实例不是;如果下游用了 isinstance(..., types.GeneratorType) 做判断,就会失效。这时候要么文档注明“非原生生成器”,要么额外提供一个 .to_sync_generator() 工厂方法。

相关专题

更多
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++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

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

共4课时 | 13.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号