如何在Python 3.11中使用add_note添加异常上下文信息

阿杰同学_5127

阿杰同学_5127

2026-11-16

772人浏览

原创

add_note 是 Python 3.11 新增的异常实例方法,用于向异常对象的 __notes 列表追加人类可读提示,仅影响异常打印时 traceback 底部的显示,不改变类型、traceback 或异常链。

如何在python 3.11中使用add_note添加异常上下文信息

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

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

注意:add_note 不是装饰器、不捕获异常、也不替代 raise ... from;它只作用于已创建但尚未抛出的异常实例。

什么时候该用 add_note,而不是 raise ... from

当你需要补充「解释性文字」而非「因果链」时,add_note 更合适。比如解析配置失败后想提示用户检查某字段格式,但这个提示不是上游异常的直接原因,只是辅助诊断信息。

  • raise ValueError("Invalid port") from e:表示当前异常由 e 引发,会出现在 traceback 的 Caused by 块中
  • exc.add_note("Hint: port must be between 1024 and 65535"):纯文本提示,不参与异常链,仅增强可读性
  • 若在 except 块中重新抛出异常,且希望保留原 traceback(不使用 from),又想加说明,add_note 是唯一选择

add_note 的实际调用方式和常见错误

必须在异常实例被 raise 之前调用,且不能对内置异常类(如 ValueError)直接调用 —— 要先实例化。

错误写法:

ValueError.add_note("this fails")  # AttributeError: type object 'ValueError' has no attribute 'add_note'

正确写法:

Python 环境工具专业版
Python 环境工具专业版

Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能

下载
exc = ValueError("Port out of range")
exc.add_note("Hint: port must be between 1024 and 65535")
raise exc

其他易错点:

  • 传入 None 或非字符串值会触发 TypeError
  • 多次调用 add_note 会按顺序追加到 __notes,打印时每条占一行
  • 如果异常已被抛出(比如在 except 中忘记重新 raise),再调用 add_note 无效

和 logging 或 print 比较:为什么不用更简单的方式

单纯 print 或 logging.warning 无法绑定到异常对象上,一旦进入调试器(如 pdb)或被上层捕获,这些输出就丢失了上下文关联;而 add_note 的内容随异常一起传播,能被任何标准异常处理流程(包括 IDE、pytest、日志框架的异常 formatter)识别并展示。

但它也不是万能的:

  • 旧版本 Python(AttributeError
  • 某些序列化库(如 pickle)默认不保存 __notes,跨进程/网络传递异常时可能丢失
  • 如果异常被吞掉(没被 raise 或捕获后静默),add_note 的内容永远不会浮现

真正容易被忽略的是:它只在异常最终未被捕获、或被 traceback.print_exc() 等标准方式打印时才可见;如果你用自定义异常处理器且没显式访问 exc.__notes,这些备注就等于没写。

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

相关文章

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

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

下载

相关标签:

python python 3.11

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

相关专题

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

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

2023.07.20

1931

4

python能做什么
python能做什么

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

2023.07.25

5464

7

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

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

2023.07.31

1889

3

python教程
python教程

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

2023.08.03

33277

23

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

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

2023.08.04

3907

5

python eval
python eval

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

2023.08.04

3927

5

scratch和python区别
scratch和python区别

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

2023.08.11

1283

5

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

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

2023.08.10

616

4

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

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

2023.08.11

3043

5

热门下载

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

精品课程

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