该用 __str__ 时用于面向用户的易读字符串表示(如 print(obj)),必须写 __repr__ 时用于开发者调试,需包含关键字段且格式稳定;优先实现 __repr__,它缺失时无 fallback,而 __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" 输出成两行或乱码。
华为云 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 的核心概念和高级技巧!










