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

小晨姑娘_6383

小晨姑娘_6383

2026-10-01

692人浏览

原创

add_note是python 3.11新增的异常实例方法,用于向异常对象追加人类可读的上下文说明,它修改__notes属性(只读list),并在traceback末尾显示;__notes不可直接赋值,必须通过add_note添加内容。

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

add_note 是什么,它和 __notes 有什么关系

add_note 是 Python 3.11 新增的异常方法,用于向异常对象追加人类可读的上下文说明。它不改变异常类型或 traceback,只影响 __notes 属性(一个 list),并在打印异常时显示在 traceback 底部,紧挨着 Exception 行之后。

注意:__notes 是只读属性,不能直接赋值;必须用 add_note 添加内容,否则会静默失败或抛出 AttributeError(取决于解释器实现细节)。

怎么安全地调用 add_note:时机与对象限制

只能对尚未被 raise 出去的异常实例调用 add_note。一旦异常被 raise,CPython 会冻结其状态,后续调用 add_note 将无效(无报错,但内容不会出现在 traceback 中)。

  • ✅ 正确:在 raise 前调用,例如 e.add_note("用户输入为空") 后再 raise e
  • ❌ 错误:在 except 块中对捕获到的异常二次调用 add_note 并 raise —— 这时异常已处于“活跃”状态,add_note 不生效
  • ⚠️ 特殊情况:若用 raise ... from ... 链式抛出,只有最外层新构造的异常能可靠使用 add_note

示例:

try:
    int("")
except ValueError as e:
    e.add_note("请检查配置文件第12行的 port 字段")
    raise  # ❌ 这里 e 已激活,note 不会显示

应改为:

try:
    int("")
except ValueError as e:
    new_e = ValueError(str(e))
    new_e.add_note("请检查配置文件第12行的 port 字段")
    raise new_e  # ✅ 新异常,note 可见

add_note 和 __cause__ / __context__ 的区别在哪

add_note 提供的是补充说明,不是因果链。它不参与异常传播逻辑,也不影响 raise ... from 的行为。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载
  • __cause__(显式链式异常):由 raise E1 from E2 设置,决定 traceback 中的 The above exception was the direct cause of the following exception:
  • __context__(隐式上下文):由未处理异常自动设置,如在 except 块中又抛出新异常
  • add_note:纯文本备注,只影响输出格式,不改变控制流或异常关系

三者可共存,但 add_note 内容总显示在最后,且不缩进:

Traceback (most recent call last):
  File "x.py", line 5, in <module>
    int("abc")
ValueError: invalid literal for int() with base 10: 'abc'
<p>The above exception was the direct cause of the following exception:</p>
<p>Traceback (most recent call last):
File "x.py", line 7, in <module>
raise RuntimeError("解析失败") from e
RuntimeError: 解析失败</module></p>
<p>Note: 请检查配置文件第12行的 port 字段
</p></module>

实际调试中容易忽略的兼容性问题

add_note 是 Python 3.11+ 独有特性,在 3.10 或更早版本中调用会触发 AttributeError:

AttributeError: 'ValueError' object has no attribute 'add_note'

如果代码需兼容旧版本,不能简单用 hasattr(e, "add_note") 判断——因为某些第三方异常类可能伪造该方法。更稳妥的做法是:

  • 仅在明确知道运行环境为 3.11+ 时使用
  • 或封装一层 fallback:捕获 AttributeError 后降级为拼接消息字符串(如 str(e) + "\nNote: ...")
  • 注意日志库(如 logging)默认不打印 __notes,需自定义 formatter 或升级到支持 3.11 notes 的版本(如 logging >= 3.11.4)

真正麻烦的不是加 note,而是确保它出现在你期望看到的地方——比如 CI 环境用的是 3.10,本地开发用 3.11,note 就会神秘消失。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1631

4

python能做什么
python能做什么

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

2023.07.25

3944

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

22737

23

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

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

2023.08.04

2787

5

python eval
python eval

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

2023.08.04

2827

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2203

5

热门下载

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

精品课程

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