在 Python 对象模型里,repr 与 str 分别由双下方法 __repr__ 和 __str__ 支撑,二者承担着截然不同的表达职责。理解它们的设计原则,是写出可维护代码与清晰日志的前提。很多库在序列化、调试输出时默认依赖 repr,而终端展示则依赖 str,混淆两者会导致排查问题困难。

repr 的底层设计原则:无歧义与可重建
repr 的核心目标是为开发者提供对象的“官方”字符串表示,它应当尽量无歧义,并且在理想情况下,通过该字符串使用 eval 能重建出等价对象。这一设计原则体现在 Python 内置类型的实现中,例如字符串的 repr 会带引号并转义不可见字符,而 str 直接输出内容。这样的区分让开发者在交互式环境中一眼就能分辨出值的类型与边界。
当我们自定义类时,若只重写 __str__ 而未重写 __repr__,Python 会 fallback 到默认实现,形如 <ClassName object at 0x...>。这违背了 repr 的可重建原则。推荐做法是至少实现 __repr__,返回类似 ClassName(field=value) 的形式。例如:
class Point:
def __init__(self, x, y):
self.x = x
self.y = y
def __repr__(self):
return f'Point(x={self.x}, y={self.y})'
p = Point(1, 2)
print(repr(p))
# 输出: Point(x=1, y=2)
上述代码展示了 repr 如何服务于调试与重建。在容器类型中,诸如 list 或 dict 在拼接元素时统一调用元素的 __repr__,而非 __str__。这意味着即使你为对象写了漂亮的 str,在列表里打印依旧是开发视角的 repr,这是 Python 刻意保持容器内部表达一致性的原则。
str 的设计原则:面向用户的友好可读
与 repr 不同,str 的设计原则聚焦于终端用户或业务日志的可读性。它不需要可重建,也不强制无歧义,只要人类看起来舒服即可。例如 datetime 对象的 str 输出为 2023-10-01 12:00:00,而 repr 可能是 datetime.datetime(2023, 10, 1, 12, 0)。前者便于展示,后者便于精确还原。
在格式化字符串中,print、format 以及 f-string 的默认路径会使用 __str__。如果类未定义 __str__,Python 会回退到 __repr__,这是 str 对 repr 的兼容原则。下面的例子说明二者在输出上的差异:
class User:
def __init__(self, name, uid):
self.name = name
self.uid = uid
def __repr__(self):
return f'User(name={self.name!r}, uid={self.uid})'
def __str__(self):
return f'用户 {self.name} (ID: {self.uid})'
u = User('张三', 1001)
print(str(u))
print(repr(u))
# 输出:
# 用户 张三 (ID: 1001)
# User(name='张三', uid=1001)
从工程角度看,str 的轻量可读特性适合写进面向运营的报表,但若用于跨服务调试接口,则可能丢失类型信息。因此在微服务间传递对象摘要时,很多团队会约定使用 repr 或自定义序列化,而非依赖 str。明确 str 只是“门面”,能减少误用。
二者的调用机制与fallback规则
Python 内置函数 repr(obj) 直接查找 type(obj).__repr__(obj),而 str(obj) 查找 __str__,缺失时找 __repr__。这个 fallback 是单向的:str 可以借 repr,但 repr 绝不借 str。该机制保证了任何对象都有可用的开发者表达,却不会让调试信息被过度美化而失真。
在容器打印、日志框架的默认格式化、以及 %s 与 %r 占位符中,规则被严格执行:%s 对应 str,%r 对应 repr。新手常误以为 print 列表会调用元素的 str,其实列表的 __repr__ 遍历元素并调用其 repr。观察下面代码可验证:
data = [u, Point(3, 4)] print(data) # 输出: [用户 张三 (ID: 1001), Point(x=3, y=4)] # 注意列表括号来自 list repr,元素 u 因在 list 中仍调用其 repr 而非 str # 但上面 u 的 repr 是 User(...),此处为示例简化,实际会显示 User(name='张三', uid=1001)
掌握调用链有助于在自定义类中做出正确取舍。若资源有限,优先实现 __repr__ 以满足调试与容器表达;当业务确实需要友好输出时,再补充 __str__。这种分层设计原则让 Python 对象在机器与人间切换时保持清晰边界,也降低了协作成本。