0

0

如何让异常支持自定义格式化输出(str vs repr)

舞夢輝影

舞夢輝影

发布时间:2026-01-24 15:45:10

|

155人浏览过

|

来源于php中文网

原创

自定义异常需同时重写 __str__ 和 __repr__:__str__ 返回用户友好的简明描述,__repr__ 返回可重建对象的合法表达式,避免副作用、异常和性能开销,并通过双重测试校验。

如何让异常支持自定义格式化输出(str vs repr)

自定义异常的 __str____repr__ 方法

Python 异常默认只继承 BaseException__str____repr__,输出就是参数元组(如 MyError('msg') 显示为 "('msg',)")。要控制格式,必须显式重写这两个方法。

常见错误是只改 __str__ 忘了 __repr__,导致日志里或交互式环境(如 IPython)中仍看到难读的原始形式;或者在 __repr__ 里返回非合法 Python 表达式(比如没加引号、含换行),破坏调试体验。

实操建议:

  • __str__ 返回用户友好的简明描述,不带类型名和括号,比如 "文件 '/tmp/x' 不存在"
  • __repr__ 应尽量返回可重建对象的表达式,至少包含异常类名和关键参数,用 repr() 包裹字符串字段,比如 "FileNotFoundError('/tmp/x')"
  • 避免在 __repr__ 中调用可能抛异常或耗时的操作(如读文件、网络请求)

继承内置异常时保留原行为再增强

直接继承 ValueErrorIOError 等,不代表自动获得其 __str__ 的语义。这些内置异常的 __str__ 是基于 args 动态生成的,但你一旦重写,就得自己处理所有参数逻辑。

使用场景:想复用内置异常语义(比如 KeyError 默认把 key 加单引号),又想追加上下文信息。

实操建议:

  • 调用父类 super().__str__() 获取基础描述,再拼接额外字段,例如:return super().__str__() + f" (context={self.context})"
  • 若需兼容原有 repr 格式(如 KeyError('foo')),__repr__ 中应显式构造类似字符串,不要依赖 super().__repr__() —— 因为父类实现可能不暴露你新增的属性
  • 注意 args 是只读元组,修改它不会影响父类方法输出;新增属性(如 self.timestamp)必须在 __init__ 中赋值,并在 __repr__ 中手动包含

避免在 __str__/__repr__ 中触发新异常

格式化方法被日志系统、调试器、print() 隐式调用,一旦内部出错(如访问未初始化属性、格式化失败),会抛出 RecursionError 或掩盖原始异常,造成“异常中的异常”,极难排查。

PathFinder
PathFinder

AI驱动的销售漏斗分析工具

下载

典型错误现象:抛出自定义异常后,控制台显示 RecursionError: maximum recursion depth exceeded while calling a Python object,而不是你的异常内容。

实操建议:

  • 所有字段访问前加 getattr(self, 'field', 'N/A') 或用 hasattr() 防御
  • 字符串格式化统一用 f"{value!r}"str(value),避免 .format()% 可能引发的 TypeError
  • 不在这些方法中做 I/O、锁操作、或调用外部库函数

日志与调试场景下的实际表现差异

logging.exception() 默认调用 exc_info 并打印 __str__,而 logging.debug('%r', exc) 打印的是 __repr__。Jupyter 或 pdb 中输入 exc 回车,也触发 __repr__;但 print(exc) 触发 __str__

性能影响:如果 __repr__ 构造复杂字符串(比如 dump 整个 traceback 或对象树),在高频日志场景下会拖慢性能,且多数时候并不需要完整信息。

实操建议:

  • 生产环境日志优先依赖 __str__,确保简洁;调试专用字段(如 self.trace_id)只出现在 __repr__
  • 若异常携带大量上下文(如 HTTP 请求体),__repr__ 中应截断或标记省略,例如 f"... {len(self.body)} bytes"
  • 测试时用 assert str(MyError('x')) == "x"assert repr(MyError('x')) == "MyError('x')" 双重校验,防止重构破坏格式

真正麻烦的不是写这两个方法,而是确保它们在所有调用路径下都稳定——尤其当异常被序列化(如传给 multiprocessing 或 sentry sdk)时,__repr__ 可能被意外求值,任何隐式副作用都会放大问题。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

193

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

19

2026.02.03

while的用法
while的用法

while的用法是“while 条件: 代码块”,条件是一个表达式,当条件为真时,执行代码块,然后再次判断条件是否为真,如果为真则继续执行代码块,直到条件为假为止。本专题为大家提供while相关的文章、下载、课程内容,供大家免费下载体验。

107

2023.09.25

while的用法
while的用法

while的用法是“while 条件: 代码块”,条件是一个表达式,当条件为真时,执行代码块,然后再次判断条件是否为真,如果为真则继续执行代码块,直到条件为假为止。本专题为大家提供while相关的文章、下载、课程内容,供大家免费下载体验。

107

2023.09.25

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

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

887

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

462

2024.06.27

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号