python / python/cpython

unavoidable spurious "exception in shielded future" logged if exception raised after shield cancelled

未关闭
#156,321 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

stdlib topic-asyncio type-bug
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Bug report

Bug description:

test case:

import asyncio

async def fail(t):
    await asyncio.sleep(1)
    raise ValueError("should be caught, not logged")

async def main():
    fut = asyncio.create_task(fail(1))
    try:
        await asyncio.wait_for(asyncio.shield(fut), timeout=0.5)
    except asyncio.TimeoutError:
        print("timeout, as expected")
    
    try:
        await fut
    except Exception as e:
        print("error caught and handled:", e)
    

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

#134331 appears to have introduced a regression where _log_on_exception is added unconditionally and permanently on a future that has been shielded at some point, when the shield future is cancelled, rather than removing the handler when the shield future is done.

In the above code, a long-running future is created. shield It is awaited with a timeout using wait_for(shield(fut)). Since the future is not done, this completes and should leave us in a state just like we had an asyncio.sleep(0.5). However, instead when the future resolves, the error is logged, even though the exception is caught and handled:

> python3 test.py
timeout, as expected
ValueError exception in shielded future
future: <Task finished name='Task-2' coro=<fail() done, defined at /tmp/test.py:3> exception=ValueError('should be caught, not logged')>
Traceback (most recent call last):
  File "/tmp/test.py", line 5, in fail
    raise ValueError("should be caught, not logged")
ValueError: should be caught, not logged
error caught and handled: should be caught, not logged

as far as I can tell, the behavior is more correct if _log_on_exception is removed entirely, but I don't fully track #134331, so it may be solving a problem I don't see.

Maybe I'm missing something? Is there some assumption that the inner future should always be finished before the outer one unless something is wrong? That's what the logging behavior suggests to me.

This is a regression in 3.14. 3.13 and prior appear to have correct logging behavior for failure after shielding.

CPython versions tested on:

3.14

Operating systems tested on:

macOS

Linked PRs
  • gh-156521

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Lib/asyncio/tasks.py 中 issue 所引用的 _log_on_exception 处理附近开始,然后在 Python 3.14 上运行提供的、包含 shield、wait_for 和失败任务的示例。将其行为与 Python 3.13 及更早版本进行比较。完成标准是:在 shield 被取消后引发的异常,在随后等待并处理原始 future 时不会被记录。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
backend
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。