如何在Python异步生成器中正确捕获CancelledError

千敏小哥_8665

千敏小哥_8665

2026-10-13

167人浏览

原创

异步生成器中yield后遇cancel不会立即抛CancelledError,而是在下次__anext__()调用时才触发;需在yield后主动检查cancelled()并break,否则资源可能泄漏、finally不执行。

如何在python异步生成器中正确捕获cancellederror

async def 里 yield 后遇到 cancel 会怎样

Python 异步生成器(async def + yield)在被取消时,不会像普通协程那样立即抛出 CancelledError。它会先尝试完成当前 yield 表达式,然后在下一次调用 __anext__() 时才真正抛出异常——但前提是生成器还没退出。这意味着你不能只靠 try/except 包住 yield 就完事。

常见错误现象:CancelledError 被吞掉、协程卡死、资源未清理、finally 块没执行。

  • 异步生成器的生命周期由调用方控制(比如 async for),不是靠自身返回或异常中断
  • yield 点本身不触发取消检查;真正的取消点是 __anext__ 的入口和出口
  • 如果 yield 后紧跟耗时 await,而此时任务被取消,该 await 会抛出 CancelledError,但若没捕获,会直接冒泡中断生成器,跳过后续清理逻辑

必须在 yield 后手动检查 asyncio.current_task().cancelled()

仅靠 try/except CancelledError 不够稳健,因为取消可能发生在 yield 和下一行之间,且 Python 3.11+ 对异步生成器取消语义做了收紧:未响应取消的任务会被静默终止。主动轮询是最可控的方式。

实操建议:

  • 在每次 yield 后插入 if asyncio.current_task().cancelled(): break
  • 不要依赖 asyncio.shield() 来“保护”整个生成器——它会阻碍取消传播,导致调用方永远等不到结束
  • 若生成器内部有长期 await(如 await asyncio.sleep(30)),应在 await 前后都检查取消状态

示例片段:

import asyncio
<p>async def ticker():
i = 0
while True:
yield i
i += 1</p><h1>主动检查,避免 yield 后挂起太久</h1><pre class="brush:php;toolbar:false;">    if asyncio.current_task().cancelled():
        break
    await asyncio.sleep(1)

使用 asyncgen_hooks 或 __aiter__ 层做统一取消拦截

Python 3.12+ 提供了 sys.set_asyncgen_hooks(),可注册 firstiter 和 finalizer 回调,其中 finalizer 在异步生成器被垃圾回收或显式关闭时调用——但它**不保证在取消时触发**,所以不能替代主动检查。

Forge — Python Developer
Forge — Python Developer

Python开发助手 — 自动化脚本、API封装、命令行工具、数据管道、网页爬虫。经过测试的代码,包含错误处理和文档。当你需要...

下载

更可靠的做法是在自定义迭代器封装层拦截:

  • 不直接 async for x in my_async_gen(),而是包装成一个类,实现 __aiter__ 并在 __anext__ 中捕获 CancelledError
  • 在 __anext__ 的 try/except 中清理资源、关闭连接、发信号
  • 注意:必须重新抛出 CancelledError(或调用 raise),否则取消信号会丢失

关键点:异步生成器本身没有 aclose() 的自动调用保障,取消 ≠ 关闭,必须自己补上。

测试 cancelled 场景不能只用 asyncio.create_task().cancel()

单纯调用 task.cancel() 并不等于触发异步生成器的取消路径——它只是标记任务为已取消,实际抛错时机取决于事件循环何时调度该任务并进入下一个 await 点。

真实测试要模拟调用方行为:

  • 用 async for 循环几轮后,从外部 task.cancel(),再 await task 等待完成
  • 用 asyncio.wait_for(gen.__anext__(), timeout=0.1) 触发超时取消
  • 在 yield 后加 await asyncio.sleep(0) 让出控制权,确保取消能及时生效

容易忽略的是:单元测试中若没 await 到生成器结束,CancelledError 可能被压制,表现为“测试通过但线上崩溃”。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1731

4

python能做什么
python能做什么

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

2023.07.25

4444

7

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

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

2023.07.31

1709

3

python教程
python教程

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

2023.08.03

26057

23

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

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

2023.08.04

3167

5

python eval
python eval

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

2023.08.04

3187

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2463

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习