Python 如何让 repr 显示时自动折行(长对象)

repr() 不折行是因优先保证可逆性而非可读性;pprint 专为人类可读设计,支持自动折行、缩进和宽度控制,是替代 repr 的稳妥方案。

为什么 repr() 不折行?

Python 默认的 repr() 会把对象转成单行字符串,哪怕内容长达几千字符。这不是 bug,而是设计使然:它优先保证可逆性(即能被 eval() 安全解析),而非可读性。所以你看到 list(range(1000))repr() 是一整条密不透风的字符串,根本没法扫一眼看结构。

pprint 替代 repr 是最稳妥方案

pprint(pretty print)专为人类可读而生,支持自动缩进、按容器层级折行、控制宽度。它不改变原始对象,只影响显示逻辑:

import pprint
data = {'users': [{'id': i, 'name': f'user_{i}'} for i in range(5)], 'total': 5}
print(repr(data))  # 一行挤满
print(pprint.pformat(data, width=40, indent=2))  # 自动折行 + 缩进
  • width 控制每行最大字符数(默认 80),设小一点更容易触发折行
  • indent 设置嵌套缩进空格数(默认 1)
  • 对自定义类,需在 __repr__ 中显式调用 pprint.pformat(self.__dict__, ...),不能只靠继承
  • 注意:pprint.pprint() 直接打印,pprint.pformat() 返回字符串,后者更适合日志或调试器中拼接

重写 __repr__ 时别直接拼字符串

很多人想“手动加换行”,比如用 str(obj).replace(',', ',\n'),这极不可靠——嵌套括号、引号、转义符都会让替换出错。正确做法是复用 pprint 的底层逻辑:

import pprint
class Config:
    def __init__(self, **kw):
        self.__dict__.update(kw)
    def __repr__(self):
        return f"{self.__class__.__name__}(\n{pprint.pformat(self.__dict__, width=50, indent=4)}\n)"
  • 避免自己解析结构;pprint 能识别 dict/list/tuple/set/namedtuple 等原生容器的嵌套关系
  • 不要在 __repr__ 里调用 print() 或写文件,它必须返回字符串
  • 如果对象含不可序列化字段(如文件句柄、lambda),pprint 会显示 <...>,比崩溃强得多

reprlib.Repr 适合截断超长内容,但不解决折行

reprlib 是标准库里轻量级的 repr 工具,主打“安全截断”,

比如限制字符串长度、列表项数。但它本身不折行,只是让超长输出变短:

import reprlib
r = reprlib.Repr()
r.maxstring = 20
r.maxlevel = 3
print(r.repr("hello world this is very long"))  # 'hello world this...' 
  • 适合日志中防止单条消息爆炸,但无法改善嵌套结构的可读性
  • pprint 是互补关系:一个管“多长”,一个管“多深”
  • 如果你发现 pprint.pformat 输出仍太宽,先检查是否嵌套了未实现 __repr__ 的第三方类——它们可能返回超长单行字符串,拖垮整个格式化效果

实际调试时最容易忽略的是:某些 IDE(如 PyCharm)的变量面板或 debuggerrepr 视图并不走你重写的 repr,而是用内部机制快速生成,这时得靠 pprint.pformat(obj) 手动粘贴到 console 里看。