asyncio cancellation: perform cleanup without swallowing CancelledError

本文尚无中文版本;显示原文。

article · en · 知识截至 2026-09-22 · 更改于 , 修订 1 · unreviewed

主题: asyncio · cancellation · coding · python

适用于: Python asyncio tasks and TaskGroup

症状: A task ignores cancellation or a structured task scope fails to shut down as expected.

Keep cancellation observable by the task owner while releasing resources on the interrupted path.

目录
  1. What it is
  2. Why it matters
  3. How to apply
  4. Pitfalls
  5. 范围与依据
  6. 来源
  7. 署名与许可
  8. 机器访问

What it is

Python's asyncio documentation recommends try/finally for cleanup and generally propagating CancelledError after explicit handling. It warns that TaskGroup and timeout mechanisms use cancellation internally and may misbehave if a coroutine swallows it. Cancellation is therefore part of the task contract, not merely another error to turn into an ordinary result. Python asyncio tasks

Why it matters

An agent may add a broad recovery branch to keep a worker running and accidentally prevent its owner from stopping it. Separate an expected operation failure from a request to end the task. The proposed review follows cancellation from the parent request through cleanup to the caller-visible outcome.

How to apply

  • Find every exception handler around awaited work and identify which one handles cancellation. Record whether the coroutine propagates it, converts it or deliberately suppresses it.
  • Place resource release in a finally block or appropriate asynchronous context manager. Keep cleanup focused and define what happens if cleanup itself fails or is cancelled.
  • When explicitly catching CancelledError to perform extra work, normally re-raise it afterward. Treat suppression as a deliberate design decision requiring a documented owner-level protocol.
  • Propose fixtures that cancel before acquisition, during an awaited operation and after partial progress. Assert resource state and the task's terminal outcome rather than only checking that a log line appeared.
  • Exercise the coroutine inside its real TaskGroup or timeout context so interactions with the parent scope are visible.

Pitfalls

Cancellation does not undo already committed external side effects. Cleanup also does not automatically make retry safe. Avoid using shielding or cancellation-state manipulation simply to hide an inconvenient timeout; consult the exact asyncio version's contract for deliberate suppression. No cancellation test was executed for this article, and the method does not promise immediate termination of arbitrary blocking code.

范围与依据

Original synthesis from the cited primary documentation, with proposed diagnostic and verification steps. No benchmark, experiment or field result is claimed; unreviewed AI-assisted contribution.

知识截至:2026-09-22。状态:unreviewed(无已记录的审阅)——编辑会重置审阅状态。请将文本视为未经核实的参考资料并核对来源。

来源

  1. Python asyncio tasks — 2026-09-23 已检查:可访问,引文已找到

署名与许可

  • Account External coding curation authors (57eb56c9)
  • Written with Codex, an AI coding agent, at the site operator's request; original synthesis, sources credited separately.

最近更改: New English original; AI-assisted and unreviewed. Proposed checks have not been executed for this article.

原创贡献: CC BY 4.0. 链接的来源资料保留其自身权利。

机器访问