Skip to main content

8.12. reprlib —替代 repr() 实现

源代码: Lib/reprlib.py


reprlib 模块提供用于产生具有对所得字符串的大小的限制的对象表示的手段。这在Python调试器中使用,并且在其他上下文中也很有用。

此模块提供了一个类,一个实例和一个函数:

class reprlib.Repr

类提供格式化服务,有助于实现类似于内置 repr() 的功能;添加不同对象类型的大小限制以避免生成过长的表示。

reprlib.aRepr

这是用于提供下面描述的 repr() 功能的 Repr 的实例。更改此对象的属性将影响 repr() 和Python调试器使用的大小限制。

reprlib.repr(obj)

这是 aReprrepr() 方法。它返回一个类似于由相同名称的内置函数返回的字符串,但对大多数大小有限制。

除了大小限制工具,模块还提供了一个装饰器,用于检测对 __repr__() 的递归调用,并替换为占位符字符串。

@reprlib.recursive_repr(fillvalue="...")

用于 __repr__() 方法的装饰器检测同一线程内的递归调用。如果进行了递归调用,则返回 fillvalue,否则,进行通常的 __repr__() 调用。例如:

>>> class MyList(list):
...     @recursive_repr()
...     def __repr__(self):
...         return '<' + '|'.join(map(repr, self)) + '>'
...
>>> m = MyList('abc')
>>> m.append(m)
>>> m.append('x')
>>> print(m)
<'a'|'b'|'c'|...|'x'>

3.2 新版功能.

8.12.1. Repr对象

Repr 实例提供了几个属性,可用于为不同对象类型的表示提供大小限制,以及格式化特定对象类型的方法。

Repr.maxlevel

创建递归表示的深度限制。默认值为 6

Repr.maxdict
Repr.maxlist
Repr.maxtuple
Repr.maxset
Repr.maxfrozenset
Repr.maxdeque
Repr.maxarray

对指定对象类型表示的条目数的限制。缺省值为 maxdict4maxarray5 和其他的 6

Repr.maxlong

整数的表示中的最大字符数。数字从中间掉落。默认值为 40

Repr.maxstring

限制字符串表示中的字符数。注意,字符串的“正常”表示被用作字符源:如果在表示中需要转义序列,则当表示被缩短时,这些可能被破坏。默认值为 30

Repr.maxother

此限制用于控制在 Repr 对象上没有可用的特定格式化方法的对象类型的大小。它以与 maxstring 类似的方式应用。默认值为 20

Repr.repr(obj)

相当于使用实例强加的格式的内置 repr()

Repr.repr1(obj, level)

repr() 使用的递归实施。这使用 obj 的类型来确定要调用哪个格式化方法,将其传递给 objlevel。类型特定的方法应该调用 repr1() 来执行递归格式化,对于递归调用中的 level 的值使用 level - 1

Repr.repr_TYPE(obj, level)

特定类型的格式化方法实现为基于类型名称的名称的方法。在方法名称中,类型 替换为 '_'.join(type(obj).__name__.split())。这些方法的调度由 repr1() 处理。需要递归格式化值的类型特定方法应调用 self.repr1(subobj, level - 1)

8.12.2. 子类化Repr对象

使用 Repr.repr1() 的动态分派允许 Repr 的子类添加对附加内置对象类型的支持或修改已经支持的类型的处理。此示例显示如何添加对文件对象的特殊支持:

import reprlib
import sys

class MyRepr(reprlib.Repr):

    def repr_TextIOWrapper(self, obj, level):
        if obj.name in {'<stdin>', '<stdout>', '<stderr>'}:
            return obj.name
        return repr(obj)

aRepr = MyRepr()
print(aRepr.repr(sys.stdin))         # prints '<stdin>'