Python asyncio取消任务后等待清理完成的实现方法

Python asyncio 里，task.cancel() 只是向任务发出取消请求，并不等于清理已经结束。可靠的做法是：worker 把释放连接、关闭文件或删除临时状态放进 finally，清理结束后继续抛出 CancelledError；管理协程再 await task，确认这个 Task 真正收尾。

先做一个可取消的异步 worker

下面的小项目模拟一个持续消费任务：它持有一个需要关闭的资源对象，每轮工作在 asyncio.sleep() 处让出控制权。真实项目里这个资源可以替换成连接、文件或临时目录。

import asyncio

class DemoResource:
    def close(self):
        # 这里模拟同步资源的关闭动作；真实代码应释放自己的资源。
        print("resource closed")

async def worker():
    resource = DemoResource()
    try:
        while True:
            print("working")
            # sleep 既模拟等待，也提供任务接收取消异常的挂起点。
            await asyncio.sleep(0.2)
    except asyncio.CancelledError:
        # 记录取消后继续抛出，让上层知道任务没有正常返回。
        print("worker cancellation received")
        raise
    finally:
        # 无论正常结束还是取消，资源都要在这里释放。
        resource.close()

关键点在于 CancelledError 不是普通业务返回值。取消发生时，协程会在合适的挂起点收到它；finally 仍然会执行。如果清理完成后直接返回，调用方就可能误以为任务正常结束。

管理协程要保留 Task 并发起取消

创建任务后，把返回值放在局部变量中。管理协程先让 worker 运行一小段时间，再调用 cancel()。这个调用不会同步等待，也不会把 worker 从事件循环里“硬删除”。

async def main():
    # 保存强引用，后面既要取消它，也要等待它结束。
    task = asyncio.create_task(worker(), name="demo-worker")
    await asyncio.sleep(0.55)

    # cancel() 发出请求，真正的清理要等 task 被再次调度。
    task.cancel()
    try:
        # await 是收尾确认：会等 finally 执行完。
        await task
    except asyncio.CancelledError:
        # 这里表示 worker 按取消路径结束，而不是业务成功返回。
        print("worker stopped cleanly")

if __name__ == "__main__":
    asyncio.run(main())

这段代码的输出顺序应体现“收到取消、关闭资源、上层确认”三个事实，但不要把它当作截图证据。调用方真正关心的是 await task 返回后，任务已经不再持有需要清理的资源。

取消后的三种结果要分开处理

尤其不要写成宽泛的 except Exception 来“兜底取消”。CancelledError 直接继承自 BaseException，很多普通异常捕获并不能替代明确的取消处理。若确实要抑制取消，也必须清楚承担取消状态被改变后的后果。

常见误区与检查清单

• 只调用 cancel() 就退出：清理可能还没有机会运行。
• 不保存 create_task() 返回值：后续无法可靠等待和读取结果。
• 在 finally 里做可能无限等待的操作：应给清理动作设置边界，并保留失败信息。
• 取消后重新创建同名任务：这会掩盖原任务的收尾问题，先等旧任务完成再决定是否重试。

相关问题

调用 task.cancel() 后能立刻关闭连接吗？

不能把两者视为同步动作。cancel() 只是请求，连接关闭应由 worker 的 finally 完成，调用方用 await task 等待确认。

为什么取消后还要捕获 CancelledError？

因为上层需要区分“任务完成”和“任务被取消”。捕获只用于记录或转换控制流；完成必要清理后通常应继续传播。

用 asyncio.gather 等待多个任务时怎么办？

先保存任务集合，再统一等待并按项目需要处理取消结果。若任务之间存在明确的父子关系，可考虑 Python 3.11 引入的 TaskGroup，让退出上下文时自动等待组内任务。

可以把这套模式概括成一句话：取消是请求，finally 是清理边界，await task 才是调用方拿到的收尾确认。