reprlib — 替代 repr() 实现 — Python 文档

来自菜鸟教程
Python/docs/3.8/library/reprlib
跳转至:导航、​搜索

reprlib — 替代 repr() 实现

源代码: :source:`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__() 调用。 例如:

>>> from reprlib import recursive_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 版中的新功能。

再现对象

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

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

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

为命名对象类型表示的条目数限制。 maxdict 的默认值为 4maxarray 的默认值为 5,其他的默认值为 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 - 1 作为 level 的值。
Repr.repr_TYPE(obj, level)
特定类型的格式化方法被实现为具有基于类型名称的名称的方法。 在方法名称中,TYPE 替换为 '_'.join(type(obj).__name__.split())。 对这些方法的调度由 repr1() 处理。 需要递归格式化值的特定于类型的方法应该调用 self.repr1(subobj, level - 1)


子类化 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>'