`reprlib` — 替代 `repr()` 实现¶

reprlib 模块提供了一种生成对象表示的方法，该表示对生成的字符串的大小有限制。这在 Python 调试器中使用，并且在其他上下文中也可能有用。

此模块提供一个类，一个实例和一个函数

class reprlib.Repr(*, maxlevel=6, maxtuple=6, maxlist=6, maxarray=5, maxdict=4, maxset=6, maxfrozenset=6, maxdeque=6, maxstring=30, maxlong=40, maxother=30, fillvalue='...', indent=None)¶

类，提供有用的格式化服务，用于实现类似于内置 repr() 的函数；添加了不同对象类型的大小限制，以避免生成过长的表示形式。

构造函数的关键字参数可以用作设置 Repr 实例属性的快捷方式。这意味着以下初始化

aRepr = reprlib.Repr(maxlevel=3)

等价于

aRepr = reprlib.Repr()
aRepr.maxlevel = 3

有关 Repr 属性的更多信息，请参见 Repr 对象部分。

在 3.12 版本中更改: 允许通过关键字参数设置属性。

reprlib.aRepr¶: 这是 Repr 的一个实例，用于提供下面描述的 repr() 函数。更改此对象的属性将影响 repr() 和 Python 调试器使用的大小限制。

reprlib.repr(obj)¶: 这是 aRepr 的 repr() 方法。它返回一个类似于同名内置函数返回的字符串，但对大多数大小有限制。

除了大小限制工具外，该模块还提供了一个装饰器，用于检测对 __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 实例提供了多个属性，可用于为不同对象类型的表示形式提供大小限制，以及格式化特定对象类型的方法。

Repr.fillvalue¶: 此字符串显示用于递归引用。默认为 ...。

3.11 版本中新增。

Repr.maxlevel¶: 创建递归表示形式的深度限制。默认为 6。

Repr.maxdict¶
Repr.maxlist¶
Repr.maxtuple¶
Repr.maxset¶
Repr.maxfrozenset¶
Repr.maxdeque¶
Repr.maxarray¶: 表示命名对象类型的条目数的限制。 maxdict 的默认为 4，maxarray 的默认为 5，其他默认为 6。

Repr.maxlong¶: 整数表示形式中的最大字符数。数字从中间删除。默认为 40。

Repr.maxstring¶: 字符串表示形式中的字符数限制。请注意，字符串的“正常”表示形式用作字符源：如果在表示形式中需要转义序列，则在缩短表示形式时可能会对其进行破坏。默认为 30。

Repr.maxother¶: 此限制用于控制 Repr 对象上没有特定格式化方法的对象类型的大小。其应用方式与 maxstring 类似。默认为 20。

Repr.indent¶

如果此属性设置为 None（默认），则输出的格式化方式与标准 repr() 一样，没有换行符或缩进。例如

>>> example = [
...     1, 'spam', {'a': 2, 'b': 'spam eggs', 'c': {3: 4.5, 6: []}}, 'ham']
>>> import reprlib
>>> aRepr = reprlib.Repr()
>>> print(aRepr.repr(example))
[1, 'spam', {'a': 2, 'b': 'spam eggs', 'c': {3: 4.5, 6: []}}, 'ham']

如果 indent 设置为字符串，则每个递归级别都放置在单独的行上，并用该字符串缩进

>>> aRepr.indent = '-->'
>>> print(aRepr.repr(example))
[
-->1,
-->'spam',
-->{
-->-->'a': 2,
-->-->'b': 'spam eggs',
-->-->'c': {
-->-->-->3: 4.5,
-->-->-->6: [],
-->-->},
-->},
-->'ham',
]

将 indent 设置为正整数值，其行为如同将其设置为包含该数字空格数的字符串。

>>> aRepr.indent = 4
>>> print(aRepr.repr(example))
[
    1,
    'spam',
    {
        'a': 2,
        'b': 'spam eggs',
        'c': {
            3: 4.5,
            6: [],
        },
    },
    'ham',
]

在版本 3.12 中新增。

Repr.repr(obj)¶: 等效于内置的 repr()，它使用实例强制的格式化。

Repr.repr1(obj, level)¶: 由 repr() 使用的递归实现。这会使用 obj 的类型来确定要调用的格式化方法，并传递 obj 和 level。特定于类型的方法应该调用 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>'

<stdin>

`reprlib` — 替代 `repr()` 实现¶

Repr 对象¶

子类化 Repr 对象¶

目录

上一主题

下一主题

本页

reprlib — 替代 repr() 实现¶

Repr 对象¶

子类化 Repr 对象¶

`reprlib` — 替代 `repr()` 实现¶