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 或掩盖原始异常,造成“异常中的异常”,极难排查。

蕉点AI
蕉点AI

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__ 可能被意外求值,任何隐式副作用都会放大问题。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

773

2023.06.15

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

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

684

2023.07.20

python能做什么
python能做什么

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

765

2023.07.25

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

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

699

2023.07.31

python教程
python教程

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

1405

2023.08.03

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

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

570

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

22

2026.01.23

热门下载

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

精品课程

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

共4课时 | 17.5万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

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

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