Python类中的__str__和__repr__如何选择_实现易读的对象调试信息输出

千瑶小哥_9000

千瑶小哥_9000

2026-05-26

306人浏览

原创

该用 __str__ 时用于面向用户的易读字符串表示(如 print(obj)),必须写 __repr__ 时用于开发者调试,需包含关键字段且格式稳定;优先实现 __repr__,它缺失时无 fallback,而 __str__ 缺失会自动调用 __repr__。

python类中的__str__和__repr__如何选择_实现易读的对象调试信息输出

什么时候该用 __str__,什么时候必须写 __repr__

__str__ 是给人看的,__repr__ 是给开发者/解释器看的。打印对象时(比如 print(obj))调用 __str__;在交互式环境里敲变量名回车、用 repr(obj)、日志记录、调试器显示对象时,走的是 __repr__。

如果只实现一个,优先写 __repr__——它不实现的话,Python 默认返回类似 <myclass object at></myclass> 的信息,完全看不出内容;而 __str__ 缺失时会自动 fallback 到 __repr__,所以至少保证 __repr__ 可读,就解决了大部分调试场景。

__repr__ 的输出必须满足“可复现”原则吗

理想情况下,__repr__ 返回的字符串应能直接作为 Python 表达式运行并重建对象(比如 datetime(2024, 5, 20, 14, 30)),但这不是硬性要求,尤其对复杂对象(含文件句柄、网络连接、不可序列化状态)根本做不到。

真正关键的是:它得包含足够区分实例的关键字段,且格式稳定、无歧义。常见做法是用类名 + 关键属性名值对:

def __repr__(self):
    return f"{self.__class__.__name__}(name={self.name!r}, id={self.id})"

!r 很重要——它等价于 repr(),能自动给字符串加引号、转义特殊字符,避免 name="foo\nbar" 输出成两行或乱码。

huaweicloud-python-sdk-helper
huaweicloud-python-sdk-helper

华为云 Python SDK 查询工具。自动发现已安装 SDK 的服务包、Client类、API 方法、入参详情、类信息(__init__ 参数、属性、类型、描述),支持关键字搜索,快速定位目标 API 使用方法。

下载
  • 不要拼接原始字符串(如 "name=" + self.name),容易漏转义
  • 避免调用可能抛异常的方法(如 self.get_display_name()),__repr__ 应该是纯数据快照
  • 别在 __repr__ 里做 I/O 或耗时计算,调试时频繁触发会导致卡顿

__str__ 怎么写才真“易读”,而不是画蛇添足

__str__ 的目标是让非程序员也能快速理解这个对象“是什么”。比如一个订单对象,__str__ 返回 "Order #12345 (2 items, $99.99)" 比返回字段列表直观得多;而 __repr__ 则应保留 Order(order_id=12345, items=[...], total=99.99, created_at=datetime(...)) 这种细节。

注意边界情况:

  • 如果对象内容为空(如空列表、None 值字段),__str__ 不要返回空字符串,至少写个占位符,比如 "Empty Config"
  • 涉及编码/本地化时,__str__ 可以用 str(self.name),但 __repr__ 必须用 !r 保证 ASCII 安全
  • 不要在 __str__ 里隐藏关键状态(比如把 is_active=False 完全不体现),否则调试时会误判

调试时发现 __repr__ 没生效?检查这三处

最常见原因是父类已定义 __repr__,子类没显式覆盖,结果继承了父类的低信息量实现。另一个隐蔽问题是用了装饰器(如 @dataclass)但没传 repr=True(默认是 True,但显式写出来更安心)。

  • 用 hasattr(obj, '__repr__') 和 obj.__repr__.__func__ is not object.__repr__ 确认是否真的被重写
  • 在 __repr__ 开头加个 print("DEBUG: in __repr__"),看是否被调用(注意:仅临时调试,上线前删掉)
  • 检查是否意外覆盖了 __str__ 却忘了 __repr__,导致 print 看着正常,但 pdb 里 inspect 时还是默认地址

真正难的不是写这两个方法,而是每次新增字段时记得同步更新它们——尤其 __repr__,漏掉一个关键 ID 或时间戳,就可能让线上问题排查多花半小时。

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4624

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

27297

23

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

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

2023.08.04

3287

5

python eval
python eval

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

2023.08.04

3307

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

2563

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习