__repr__ 更适合调试,因其目标是清晰标识对象身份与状态,如 ;而 __str__ 面向用户展示,对调试无用。

为什么 __repr__ 比 __str__ 更适合调试
调试时你真正需要的不是“好看”,而是“能一眼看出对象是谁、在哪、状态如何”。__repr__ 的设计目标就是这个——它默认返回带类型名和内存地址的字符串,比如 <user Object at></user>;而 __str__ 是给用户看的,空实现或返回空字符串都合法,对 debug 几乎没用。
实操建议:
- 所有自定义类,只要可能被
print()、Logging.debug()或 pdb 中直接查看,就该实现__repr__ -
__repr__返回值最好满足“可被eval()还原”(非必须,但强烈推荐),例如User(name='alice', age=30)比User(alice, 30)更安全 - 避免在
__repr__中调用耗时操作(如数据库查询、文件读取)或引发副作用——它可能被日志框架、jupyter 自动触发多次
用 dataclass 自动生成调试友好的 __repr__
手写 __repr__ 容易漏字段、拼错引号、忘记转义。python 3.7+ 的 @dataclass 默认开启 repr=True,会自动拼出带字段名和值的字符串,且自动处理嵌套对象、None、字符串引号等细节。
常见错误现象:用了 @dataclass 却发现打印出来还是地址——大概率是忘了加 __slots__ = () 或用了 __init__ 覆盖了生成逻辑;或者字段值本身没有好 __repr__(比如自定义类没实现它)。
立即学习“Python免费学习笔记(深入)”;
实操建议:
- 优先用
@dataclass(repr=True)(默认就是),而不是手动写__repr__ - 敏感字段(如密码)用
field(repr=False)排除,别靠删字段或改逻辑隐藏 - 如果类继承自某个已有类,且父类没用
@dataclass,子类加@dataclass不会自动包含父类字段——得显式声明或用fields手动合并
ipython / Jupyter 中 _ 和 pprint 的实际效果差异
交互环境中,敲完一个对象回车,显示的是它的 __repr__;但用 pprint.pprint(obj) 或 IPython 的 %pprint 魔法命令,会做缩进、换行、截断长列表——这对嵌套 dict/list 很友好,但对单个简单对象反而多此一举,甚至掩盖关键信息(比如 __repr__ 里特意写的 ID 字段被折行藏掉了)。
性能影响:大对象用 pprint 可能明显卡顿,因为要递归遍历;而 __repr__ 是即时计算的,可控性强。
实操建议:
- 日常调试优先依赖
__repr__输出,而不是养成每行都敲pprint()的习惯 - 真遇到嵌套太深看不清,先试
print(repr(obj))看原始 repr 是否已含足够信息;再考虑pprint(obj, width=60, depth=3)控制深度和宽度 - IPython 中
_(上一个表达式结果)的__repr__会被自动调用,但如果你重载了__getattr__或用了__getattribute__,可能意外干扰_的行为
调试时 vars()、dir() 和 inspect.getmembers() 怎么选
vars(obj) 只返回 obj.__dict__,快、干净,但不包含 Property、描述符、继承来的属性;dir(obj) 返回所有可访问名(含方法、特殊方法、继承链上的),但混杂噪音;inspect.getmembers(obj) 最灵活,能按条件过滤(比如只取数据属性),但默认会触发 property 的 getter,有副作用风险。
容易踩的坑:在调试中直接用 dir(obj) 查字段,结果看到一堆 __weakref__、_private,误以为是业务字段;或者用 inspect.getmembers(obj, Lambda x: not callable(x)) 想过滤方法,却把 lazy property 给算进去了。
实操建议:
- 查实例字段优先用
vars(obj),确认对象有__dict__(即没用__slots__) - 查类接口或方法列表用
dir(obj),但记得配合help(obj.method)看文档,别只看名字 - 需要精确控制时,用
inspect.getmembers(obj, lambda v: not callable(v) and not isinstance(v, (property, functools.cached_property))),避开 descriptor 副作用
调试友好性不是加一堆日志,而是让每个对象自己说清楚“我是谁、我有啥”。最常被忽略的一点:很多人实现了 __repr__,却忘了检查它是否在子类继承后依然正确——尤其是用了 super().__repr__() 拼接时,父类 repr 格式一变,整个输出就乱了。