如何利用Python的__str__与__repr__提升调试时的日志可读性?

雨婷小哥_5441

雨婷小哥_5441

2026-07-04

796人浏览

原创

结论:用__str__返回用户友好的字符串,用__repr__返回可复现、带类型和关键状态的调试字符串——两者不互换,也不该返回相同内容;__repr__应在默认输出为时重写,必须含类名和关键字段,推荐为合法python表达式,避免副作用;__str__与__repr__雷同会导致日志冗余难读,logging中应显式用{obj!r}或{obj!s}控制调用路径。

如何利用python的__str__与__repr__提升调试时的日志可读性?

直接说结论:用 __str__ 返回用户友好的字符串,用 __repr__ 返回可复现、带类型和关键状态的调试字符串——两者不互换,也不该返回相同内容。

什么时候该重写 __repr__?

当你在日志里看到类似 <__main__.user object at></__main__.user> 这种信息时,就该写了。这种默认输出对调试毫无帮助,尤其在 logging.debug() 或 print() 查看变量时。

  • 必须包含类名,比如 User,而不是只写字段值
  • 推荐返回合法 Python 表达式(能直接 eval() 还原对象最好),至少也要含关键字段和类型标识
  • 避免在 __repr__ 中调用复杂方法或访问数据库——它可能被频繁调用(比如在 pdb、日志、容器 repr 中)
  • 示例:def __repr__(self): return f"User(id={self.id!r}, name={self.name!r})",注意用 !r 确保引号和转义正确

__str__ 和 __repr__ 返回一样会出什么问题?

常见错误是偷懒写成 return str(self.__dict__) 或直接返回 __repr__ 结果。这会让 print(obj) 和 logging.info(str(obj)) 输出冗长、带引号、含下划线字段(如 _cache)的字符串,反而干扰业务日志阅读。

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
  • __str__ 面向终端用户或日志阅读者,应简洁、无技术细节:比如 "Alice (active)"
  • __repr__ 面向开发者,要暴露结构:比如 User(id=123, name='Alice', is_active=True)
  • 如果两者一样,logging.info(f"Created: {user}") 就会混入调试级信息,日志变难扫描
  • 某些库(如 dataclasses 的 repr=True)默认只生成 __repr__,你仍需手动加 __str__

在 logging 中怎么安全使用它们?

别在日志格式字符串里裸写 {obj} 或 {obj!s}——这会触发 __str__,但如果你没定义它,就会 fallback 到 __repr__,而后者可能含敏感字段(如 password)或引发异常(如字段为 None 时拼接失败)。

  • 显式用 {obj!r} 触发 __repr__,确保行为可控;用 {obj!s} 显式走 __str__
  • 对敏感类,在 __repr__ 中过滤字段:f"User(id={self.id!r}, name={self.name!r}, is_active={self.is_active!r})",不出现 self._token
  • 如果对象可能为 None,日志里先判空再格式化,否则 None.__repr__() 虽安全,但 None.__str__() 也安全,不过自定义类里未定义 __str__ 时 fallback 可能意外触发 __repr__

真正容易被忽略的是:很多团队把 __repr__ 当成“多打点信息就好”,结果字段越堆越多,甚至包含嵌套对象的完整 repr,导致日志行宽爆炸、性能下降。一个 __repr__ 最好控制在 3–5 个核心字段内,且字段值本身不能触发副作用。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4584

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

26997

23

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

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

2023.08.04

3267

5

python eval
python eval

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

2023.08.04

3287

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2543

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习