Python:如何修改类或对象的 pprint 输出行为?
pprint 自定义输出的核心运行机制
pprint 展示对象的方法调用逻辑
很多开发者会误以为pprint会直接调用对象的__str__或__repr__方法来完成展示,实际调用逻辑分两类场景:
- 对于pprint内置适配的类型(dict、list、tuple、set等),它不会调用对象自身的实例方法,而是直接读取对象的内部数据结构,触发模块内部预先注册好的类型专属处理函数,按照缩进、行宽阈值规则生成美化输出
- 对于未被提前注册处理逻辑的自定义类型,pprint会退回通用流程:调用内置
repr(obj)(即触发对象的__repr__方法)获取字符串表示,如果该字符串满足“可安全重建等价对象”的条件,就会直接把这个字符串作为最终输出,不会主动做结构拆分、逐行换行的美化操作 - 示例中的namedtuple本身是tuple的子类,因此默认会命中tuple对应的内置处理逻辑:只要总输出长度未超过设定的行宽阈值,就会把所有元素放在同一行输出,不会像dict那样对每个键值对单独拆行展示。
自定义输出的实现方式
要让指定类型的对象按照自定义规则输出,有两种常见路径:
- 直接重写目标类的
__repr__方法,在方法内部实现完整的换行、缩进逻辑。这种方式的局限性是pprint不会帮你做动态的宽度适配,需要自己处理长文本的拆行规则,灵活性较低。 - 利用pprint的类型分发注册机制,给目标类绑定专属的处理函数,完全复用pprint内置的格式化能力实现自定义输出,这也是官方支持的可扩展方式。
示例场景的实现代码
针对示例中让namedtuple实例的输出和dict完全一致的需求,可以通过注册专属处理函数实现:
import pprint import collections # 定义复用dict输出逻辑的处理函数 def format_namedtuple(printer, obj, stream, indent, allowance, context, level): # 将namedtuple转换为等价的字典结构,直接调用pprint内置的dict格式化逻辑 dict_repr = obj._asdict() printer._format_dict(dict_repr, stream, indent, allowance, context, level) # 定义namedtuple类 D = collections.namedtuple('D', 'a b') # 给类注册专属的pprint分发逻辑 pprint.PrettyPrinter._dispatch[D.__repr__] = format_namedtuple a = {'a': 'a'*40, 'b': 'b'*40} d = D('a'*40, 'b'*40)
运行效果对比:
>>> pprint.pprint(a) {'a': 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'b': 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'} >>> pprint.pprint(d) {'a': 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'b': 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'}
注:这种注册方式的本质是替换了原来tuple类绑定的默认处理逻辑,让namedtuple实例在pprint处理时,走和dict完全相同的逐行拆分、缩进规则。
内容的提问来源于stack exchange,提问作者Mark Harrison
相关产品推荐
相关产品推荐

