Python的reprlib生成对象的简化表示

reprlib 是 Python 的一个标准库，提供了 repr() 函数的一个变体，用于生成对象的字符串表示形式。这个库特别有用于处理大型或深度嵌套的容器对象，因为它可以生成简化或缩短的表示，避免产生过长的输出。这对于调试输出和日志记录尤为有价值，可以帮助开发者更容易地查看数据的概要而不是详细信息，从而提高了数据可视化的效率。

此模块提供了一个类、一个实例和一个函数。

1. 使用 reprlib.Repr 类

reprlib.Repr 的实例 aRepr 被定制化了，用以限制列表和字符串的表示长度。

import reprlib

# 创建自定义的Repr实例，并设置一些属性
aRepr = reprlib.Repr()
aRepr.maxlist = 3  # 最大列表项数限制为3
aRepr.maxstring = 10  # 字符串最大长度限制为10

# 使用自定义的Repr实例来生成一个列表的表示
my_list = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
print(aRepr.repr(my_list))  # 输出: [1, 2, 3, ...]

# 使用同一个实例来生成一个字符串的表示
long_string = "Hello, this is a very long string example."
print(aRepr.repr(long_string))  # 输出: 'Hello, thi...'

通过创建 Repr 的子类，我们可以定制化这个字符串表示的生成过程，尤其是针对那些标准 Repr 类未直接支持或处理方式不符合特定需求的类型。

如下定义了一个 MyRepr 类，它继承自 reprlib.Repr。通过定义一个 repr_TextIOWrapper 方法，我们可以特别处理 TextIOWrapper 类型的对象（这是 sys.stdin、sys.stdout 和 sys.stderr 的类型）。当对象的 name 属性是特定值（<stdin>、<stdout>、<stderr>）之一时，直接返回这个名称。如果不是这些特定的流对象，则使用 Python 的内建 repr() 函数返回标准的字符串表示。创建了 MyRepr 的实例 aRepr，然后使用这个实例来生成 sys.stdin（标准输入流）的字符串表示。由于 sys.stdin 的名称是 <stdin>，根据我们在 MyRepr 中定义的逻辑，输出将直接是 <stdin>。

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))  # 输出 '<stdin>'

2. 使用 reprlib.aRepr 实例

通过修改 reprlib 模块内置的 aRepr 实例的属性，我们可以全局地改变 reprlib.repr() 函数的行为。这会影响所有使用该函数的地方，包括Python调试器内部的对象表示。

import reprlib

# 设置全局的aRepr实例属性
reprlib.aRepr.maxdict = 1  # 字典最多显示1个项目
reprlib.aRepr.maxset = 3  # 集合最多显示3个项目

# 创建一个复杂的嵌套字典
nested_dict = {
    'key1': {
        'subkey1': {1, 2, 3, 4, 5}  # 这是一个集合，应该显示最多3个元素
    }
}

# 使用全局的repr()函数
print(reprlib.repr(nested_dict))  # 预期输出: {'key1': {'subkey1': {1, 2, 3, ...}}}

Repr 实例对象包含一些属性可以用于为不同对象类型的表示提供大小限制，还包含一些方法可以格式化特定的对象类型。

Repr.fillvalue

该字符串将针对递归引用显示。 它默认为 ...。

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.repr(obj)

内置 repr() 的等价形式，它使用实例专属的格式化。

Repr.repr1(obj, level)

供 repr() 使用的递归实现。 

Repr.repr_TYPE(obj, level)

特定类型的格式化方法会被实现为基于类型名称来命名的方法。

3. 使用 reprlib.repr() 函数

直接使用 reprlib.repr() 函数来生成简化的表示形式，非常适合于打印大量数据的概览，避免在调试输出中产生庞大的文本。

import reprlib

# 使用reprlib的repr()来简化表示大型对象
large_list = list(range(100))
print(reprlib.repr(large_list))  # 输出: [0, 1, 2, 3, 4, 5, ...]

large_dict = {n: n*n for n in range(100)}
print(reprlib.repr(large_dict))  # 输出: {0: 0, 1: 1, 2: 4, 3: 9, 4: 16, ...}

4. reprlib.Repr 类动态方法解析原理

在 Repr 类中，对象的字符串表示形式是通过一系列专门的方法生成的，这些方法遵循一定的命名规则，即以 repr_ 开头，后接对象的类型名。当 Repr 实例需要表示一个对象时，它会根据对象的类型查找并调用相应的 repr_ 方法。这种机制实际上利用了 Python 的反射特性，具体实现依赖于动态方法解析。

这里的关键技术是动态属性访问和方法调用。当 Repr 类的实例被要求生成一个对象的表示时，它会首先检查自身是否有一个匹配该对象类型的专用 repr_ 方法。这是通过动态地构建方法名并使用 getattr 来尝试获取这个方法实现的。如果找到了相应的方法，则调用它；如果没有找到，将使用更通用的处理方式。

假设我们有一个 Repr 子类，并且我们想要处理自定义对象类型 MyType。我们可以这样实现：

import reprlib

class MyType:
    def __init__(self, value):
        self.value = value

class MyRepr(reprlib.Repr):
    def repr_MyType(self, obj, level):
        return f'MyType({obj.value})'

# 使用 MyRepr 来生成 MyType 对象的字符串表示
my_repr = MyRepr()
my_obj = MyType(123)
print(my_repr.repr(my_obj))  # 输出: MyType(123)

在这个例子中，MyRepr.repr_MyType 方法是根据 MyType 类型专门定义的。当 MyRepr 的实例需要表示 MyType 类型的对象时，它会通过名称 repr_MyType 找到这个方法。在 reprlib.Repr 类的源代码中，核心的方法是 repr，它是这样工作的：

1. 根据传入对象的类型，构建期望的方法名（如 repr_TypeName）。
2. 使用 getattr 尝试获取这个方法。
3. 如果方法存在，则调用之；如果不存在，则使用默认的 repr 方法。

以下是一个简化的示范代码，模拟 reprlib.Repr 的这部分行为：

class Repr:
    def repr(self, obj):
        # 获取对象的类型
        obj_type = type(obj).__name__
        # 构建方法名
        method_name = f'repr_{obj_type}'
        # 尝试获取对应的 repr_ 方法
        repr_method = getattr(self, method_name, self.generic_repr)
        # 调用找到的方法
        return repr_method(obj)

    def generic_repr(self, obj):
        return repr(obj)

# 假设存在相应的 repr_ 方法
class MyRepr(Repr):
    def repr_MyType(self, obj):
        return f'MyType({obj.value})'