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

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)直接调用 —— 要先实例化。
立即学习“Python免费学习笔记(深入)”;
错误写法:
Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能
ValueError.add_note("this fails") # AttributeError: type object 'ValueError' has no attribute 'add_note'正确写法:
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,这些备注就等于没写。

















