怎样在Python 3.11中为异常对象添加上下文信息add_note

酷磊酱_2167

酷磊酱_2167

2026-09-08

950人浏览

原创

add_note 是 python 3.11 新增的异常方法,用于向异常追加人类可读的上下文说明,仅影响 str(exc) 和打印输出末尾,不改变异常类型或 traceback;旧版本调用会报 attributeerror。

怎样在python 3.11中为异常对象添加上下文信息add_note

add_note 是什么,为什么 Python 3.11 才能用

add_note 是 Python 3.11 新增的异常方法,用于向异常对象追加人类可读的上下文说明,它不改变异常类型或 traceback,只影响 str(exc) 和打印时的末尾显示。Python 3.10 及更早版本调用会报 AttributeError: 'XXXError' object has no attribute 'add_note'

怎么安全地调用 add_note(避免 AttributeError)

不能假设所有环境都是 3.11+,尤其当代码需兼容旧版本时。推荐用 hasattr 检查,而不是 try/except 包裹 add_note 调用——后者可能掩盖真实错误。

  • ✅ 推荐写法:
    if hasattr(exc, 'add_note'):
        exc.add_note("用户输入为空,但字段为必填")
  • ❌ 避免写法:
    try:
        exc.add_note("...")
    except AttributeError:
        pass  # 静默吞掉错误,后续调试难定位
  • 注意:add_note 只接受 str,传入 Noneint 会触发 TypeError

add_note 和 __notes__ 的关系与使用边界

add_note 内部操作的是异常对象的 __notes__ 列表(Python 3.11+ 新增的私有属性),每次调用都 append 一条字符串。它和 raise ... from 的异常链机制完全正交——add_note 不影响 __cause____context__,也不会出现在 traceback 的 “During handling of the above exception…” 段落里。

python-docx
python-docx

python-docx Skill功能概述python-docx Skill是一项面向实际任务的技能,主要用于本Skill提供使用python-docx生成专业Word文档的标准方法和最佳实践;生成安全服务方案文档;核心要点生成技术架构设计文档;生成任何需要专业排版的Word文档;核心库 : python-docx;使用与执行辅助库 : docx.shared , docx.enum , docx.oxml.ns;标准代码模板;1. 文档初始化;2. 字体设置(必须!它将相关步骤、工具调用和结果整理方式集

下载
  • 打印效果示例:
    ValueError: invalid literal for int()
    Addendum: 用户提交了非数字字符
    Addendum: 已在 API 层校验过格式,此处应为 bug
  • __notes__ 是公开可读的:exc.__notes__ 返回 list[str],但不应直接修改它
  • 同一异常上多次调用 add_note 会累积,顺序即添加顺序

实际场景中 add_note 的典型用法

它最适合补充「运行时上下文」,而非替代日志或异常包装。比如解析配置、处理用户请求、桥接外部服务时,在不改变原始异常的前提下,附带关键现场信息。

  • Web 请求中:exc.add_note(f"Request ID: {request_id}, User: {user.email}")
  • 配置加载失败时:exc.add_note(f"Config file path: {config_path.resolve()}")
  • 数据库操作后:exc.add_note(f"Failed on row ID {row_id}, values={dict(row)}")
  • ⚠️ 注意:不要用它传敏感数据(如密码、token),因为 __notes__ 会随异常传播并可能被日志或监控系统捕获

真正容易被忽略的是:add_note 的内容不会自动进入 logging.exception() 的默认输出——除非你自定义 Formatter 或显式打印 exc.<strong>notes</strong>。它只对直接 print(exc) 或 str(exc) 可见。

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3644

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

20857

23

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

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

2023.08.04

2587

5

python eval
python eval

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

2023.08.04

2647

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2043

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程