Python 3.11中如何为异常添加上下文备注信息_使用add_note方法

夏敏同学_7720

夏敏同学_7720

2026-06-01

791人浏览

原创

add_note方法仅在python 3.11+中可用,且仅适用于exception子类;它为异常添加人类可读备注,不改变异常类型、消息或传播逻辑,需在抛出前调用,多次调用会按序追加并以换行分隔。

python 3.11中如何为异常添加上下文备注信息_使用add_note方法

add_note方法只在Python 3.11+可用,且仅对Exception子类有效

add_note 是 Python 3.11 引入的新方法,用于为异常对象附加人类可读的备注信息,它不会影响异常类型、消息或回溯链,只是额外挂载一段字符串。注意:它**不能**被调用在 BaseException 的非 Exception 子类上(比如 SystemExit、KeyboardInterrupt),否则会抛出 AttributeError。

常见错误现象:AttributeError: 'SystemExit' object has no attribute 'add_note' —— 这不是 bug,是设计限制。

  • 仅适用于继承自 Exception 的异常(如 ValueError、RuntimeError、自定义异常)
  • 必须在异常实例化后、抛出前调用,抛出后无法再修改(因为异常对象通常被冻结在 traceback 中)
  • 多次调用 add_note 会按顺序追加,内容用换行分隔

如何正确添加多条备注并观察输出效果

备注本身不自动显示在默认 traceback 中,只有在显式打印异常、或使用 traceback.print_exception 等工具时才会呈现(Python 3.11+ 默认格式已支持)。直接 raise 后终端看到的 traceback 末尾会多出 Notes: 区块。

try:
    raise ValueError("invalid input")
except ValueError as e:
    e.add_note("来源:用户上传的CSV第42行")
    e.add_note("建议:检查字段类型是否匹配schema")
    raise

运行后 traceback 末尾会出现:

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
Notes:
  来源:用户上传的CSV第42行
  建议:检查字段类型是否匹配schema
  • 备注内容不参与 str(e) 或 e.args,所以 print(e) 不会显示它
  • 若用 logging.exception() 记录,Python 3.11+ 的默认 handler 会包含 Notes:;旧版 logging 需手动提取 e.__notes__
  • e.__notes__ 是只读列表,不可直接赋值,只能通过 add_note 添加

与__cause__和__context__的本质区别

add_note 和异常链(__cause__ / __context__)解决的是不同问题:后者表达「这个异常是怎么来的」,前者表达「这个异常需要你注意什么」。它们互不干扰,可以共存。

  • raise new_exc from old_exc 设置 __cause__,影响 traceback 的 The above exception was the direct cause of the following exception 提示
  • add_note 只增加说明文字,不改变异常传播逻辑或嵌套结构
  • 调试时,__notes__ 更适合放临时诊断线索(如“此时 cache_size=128”),而 __cause__ 应严格用于真实因果链

生产环境使用时容易忽略的兼容性陷阱

如果你的代码需支持 Python add_note 会导致 AttributeError。不能靠 hasattr(e, 'add_note') 安全兜底——因为旧版本异常对象确实没有该方法,但检查后调用仍可能失败(比如在 except 块外捕获到异常再处理)。

  • 推荐做法:封装一个兼容函数,例如 safe_add_note(exc, note),内部用 sys.version_info >= (3, 11) 判断
  • 不要依赖 __notes__ 做逻辑分支(比如 if len(e.__notes__) > 0),它在旧版本不存在,访问会报错
  • 单元测试中若 mock 异常,需确保 mock 对象也实现了 add_note 方法,否则测试在 3.11 环境下会失败

真正要用好 add_note,得记住它不是“更漂亮的 message”,而是独立于异常语义的诊断附言——写的时候想清楚:这段话是给未来查问题的人看的,不是给程序逻辑读的。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1751

4

python能做什么
python能做什么

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

2023.07.25

4564

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26857

23

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

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

2023.08.04

3247

5

python eval
python eval

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

2023.08.04

3267

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2543

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习