reprlib — 备用 repr() 实现¶
源代码: Lib/reprlib.py
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 版更改: 允许通过关键字参数设置属性。
除了大小限制工具之外，该模块还提供了一个装饰器，用于检测对 __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¶
对指定对象类型表示的条目数量限制。 默认为
4用于maxdict，5用于maxarray，以及6用于其他类型。
- Repr.maxlong¶
整数表示形式中的最大字符数。 数字从中间删除。 默认为
40。
- Repr.maxstring¶
字符串表示形式中的字符数量限制。 请注意，字符串的“正常”表示形式用作字符源：如果在表示形式中需要转义序列，则在缩短表示形式时，这些序列可能会被破坏。 默认为
30。
- 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.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>