一个认为一切根源都是“自己不够强”的INTJ

个人主页：用哲学编程-CSDN博客
专栏：每日一题——举一反三
Python编程学习
Python内置函数

Python-3.12.0文档解读

目录

详细说明

概述

详细描述

自定义类的行为

使用示例

异常处理

注意事项

总结

记忆策略

常用场景

场景一：调试复杂数据结构

场景二：实现自定义类的调试信息

场景三：在交互式解释器中快速查看对象状态

场景四：记录日志中的对象状态

场景五：单元测试中的断言信息

巧妙用法

技巧一：序列化辅助工具

技巧二：复杂表达式的调试

技巧三：生成可读性的调试信息

技巧四：动态生成类实例

技巧五：调试复杂对象的状态变化

综合技巧

技巧一：结合 eval 实现配置文件的加载和保存

技巧二：结合 ast.literal_eval 实现更安全的动态数据加载

技巧三：结合 logging 模块记录详细调试信息

技巧四：结合 dataclass 和 repr 实现自动化的对象表示

技巧五：结合 functools 的 lru_cache 实现缓存调试信息

技巧六：结合 contextlib 模块实现上下文管理器的调试

---

详细说明

概述

repr(object) 函数返回一个对象的可打印表示形式的字符串。此字符串主要用于开发和调试阶段，因为它旨在让开发者能够明确地看到对象的表示形式。该字符串通常具有一定的可解释性，且在许多情况下可以通过 eval() 函数恢复原对象。

详细描述

• 返回值:

• 对于许多内置类型，repr() 返回的字符串通常具有合法的 Python 语法，从而可以传递给 eval() 函数以生成与原对象等效的对象。
• 对于自定义类型，如果没有定义专门的 __repr__() 方法，repr() 返回的字符串将包含对象的类型名称以及对象的某些标识信息（如内存地址），并且这些信息通常会包含在尖括号 <> 中。

自定义类的行为

一个类可以通过定义 __repr__() 方法来控制 repr() 函数为其实例返回的内容。例如：

class MyClass:def __repr__(self):return '<MyClass instance>'

在这种情况下，调用 repr() 时，将返回 '<MyClass instance>'。

使用示例

# 内置类型示例
num = 123
print(repr(num))  # 输出: '123'text = "Hello, World!"
print(repr(text))  # 输出: "'Hello, World!'"# 自定义类示例
class MyClass:def __repr__(self):return '<MyClass instance>'obj = MyClass()
print(repr(obj))  # 输出: '<MyClass instance>'

异常处理

如果 sys.displayhook() 不可访问，调用 repr() 会引发 RuntimeError 异常。然而，在大多数标准的 Python 环境中，这种情况非常少见。

注意事项

• 虽然 repr() 返回的字符串在许多情况下可以传递给 eval() 使用，但这并不总是适用。在实际开发中，应该谨慎使用 eval()，以避免安全风险。
• repr() 主要用于调试和日志记录，以提供对对象内部状态的清晰表示。

总结

repr(object) 是一个非常有用的函数，特别是在调试和开发过程中。通过返回对象的描述性字符串，它帮助开发者更好地了解和检查对象的状态。自定义类通过定义 __repr__() 方法，可以进一步控制对象的表示形式，从而提高调试和日志记录的效率。

---

记忆策略

repr 是 representation 的缩写。representation 意为“表示”或“展现”。

---

常用场景

场景一：调试复杂数据结构

在调试复杂数据结构（如嵌套的列表或字典）时，repr 可以帮助清晰地展示数据结构的内容。

# 定义一个复杂的嵌套数据结构
data = {'name': 'Alice','age': 30,'children': [{'name': 'Bob', 'age': 8},{'name': 'Charlie', 'age': 5}]
}# 使用 repr 打印数据的详细表示形式
print(repr(data))  # 输出: {'name': 'Alice', 'age': 30, 'children': [{'name': 'Bob', 'age': 8}, {'name': 'Charlie', 'age': 5}]}

场景二：实现自定义类的调试信息

通过定义 __repr__() 方法，可以为自定义类提供更有用的调试信息。

class Person:def __init__(self, name, age):self.name = nameself.age = age# 定义 __repr__ 方法，返回对象的详细表示形式def __repr__(self):return f'Person(name={self.name!r}, age={self.age})'# 创建 Person 对象
p = Person('Alice', 30)# 使用 repr 打印 Person 对象的调试信息
print(repr(p))  # 输出: Person(name='Alice', age=30)

场景三：在交互式解释器中快速查看对象状态

在交互式 Python 解释器中，repr 可以用来快速查看对象的详细状态，有助于即时调试。

# 定义一个列表对象
my_list = [1, 2, 3, 'hello']# 在交互式解释器中，直接使用 repr 查看对象的详细状态
repr(my_list)  # 输出: [1, 2, 3, 'hello']

场景四：记录日志中的对象状态

在记录日志时，使用 repr 可以帮助捕捉对象的详细状态，以便日后分析问题。

import logging# 配置日志记录
logging.basicConfig(level=logging.DEBUG)class MyClass:def __init__(self, value):self.value = value# 定义 __repr__ 方法，提供对象的详细表示形式def __repr__(self):return f'MyClass(value={self.value!r})'# 创建 MyClass 对象
obj = MyClass('example')# 记录日志，包含对象的详细表示形式
logging.debug(f'Created object: {repr(obj)}')  # 日志输出: DEBUG:root:Created object: MyClass(value='example')

场景五：单元测试中的断言信息

在单元测试中，repr 可以帮助生成更有用的断言信息，便于调试测试失败的原因。

import unittestclass TestMyClass(unittest.TestCase):def test_repr(self):obj = MyClass('test')# 使用 repr 验证对象的表示形式self.assertEqual(repr(obj), "MyClass(value='test')")# 运行测试
if __name__ == '__main__':unittest.main()

通过这些详细的使用场景，可以看到 repr(object) 函数在调试、日志记录和单元测试等方面的重要性。每个场景的代码都配有详细的注释，帮助理解 repr 函数的实际应用。

---

巧妙用法

repr(object) 函数有一些不太常见但非常巧妙的使用技巧。以下是几个可能一般人想不到的使用场景和技巧：

技巧一：序列化辅助工具

repr 可以用作生成有效的 Python 表示，从而在没有使用专门的序列化工具（如 pickle 或 json）的情况下，实现简单的数据持久化。

# 定义一个简单的数据结构
data = {'key1': 'value1', 'key2': 42, 'key3': [1, 2, 3]}# 将数据结构转为字符串表示形式
data_str = repr(data)# 将字符串保存到文件中
with open('data.txt', 'w') as file:file.write(data_str)# 从文件中读取数据
with open('data.txt', 'r') as file:read_data_str = file.read()# 使用 eval 恢复原始数据结构
restored_data = eval(read_data_str)print(restored_data)  # 输出：{'key1': 'value1', 'key2': 42, 'key3': [1, 2, 3]}

注意：此技巧使用 eval，存在安全风险，仅应在受信任环境下使用。

技巧二：复杂表达式的调试

当调试涉及复杂表达式的代码时，可以使用 repr 获取中间变量的详细表示，有助于理解计算过程。

# 定义一个复杂的计算函数
def complex_calculation(a, b):step1 = a + bstep2 = step1 * 2step3 = step2 ** 0.5return step3# 调用函数，并在调试时输出每步的计算结果
a, b = 4, 5
print(f'step1: {repr(a + b)}')       # 输出：step1: 9
print(f'step2: {repr((a + b) * 2)}') # 输出：step2: 18
print(f'step3: {repr(18 ** 0.5)}')   # 输出：step3: 4.242640687119285

技巧三：生成可读性的调试信息

在定义类时，通过 __repr__() 方法生成更加可读且信息丰富的调试信息，尤其是在处理包含复杂内部状态的对象时。

class Matrix:def __init__(self, rows):self.rows = rowsdef __repr__(self):# 将矩阵表示为多行字符串，便于阅读row_strs = [repr(row) for row in self.rows]return f'Matrix(\n  ' + ',\n  '.join(row_strs) + '\n)'# 定义一个矩阵对象
matrix = Matrix([[1, 2, 3], [4, 5, 6], [7, 8, 9]])# 使用 repr 打印矩阵对象，便于调试
print(repr(matrix))
# 输出：
# Matrix(
#   [1, 2, 3],
#   [4, 5, 6],
#   [7, 8, 9]
# )

技巧四：动态生成类实例

通过 repr 和 eval 的结合，可以实现动态生成类实例的功能，适用于某些需要动态创建对象的应用场景。

class DynamicClass:def __init__(self, name, value):self.name = nameself.value = valuedef __repr__(self):# 返回可以重新创建对象的字符串return f'DynamicClass({repr(self.name)}, {repr(self.value)})'# 创建一个对象
original = DynamicClass('example', 42)# 获取对象的表示形式
representation = repr(original)# 动态生成新的对象
new_instance = eval(representation)print(new_instance)  # 输出：DynamicClass('example', 42)
print(original == new_instance)  # 输出：False（两者是不同的实例）

技巧五：调试复杂对象的状态变化

在调试复杂对象时，通过多次调用 repr 可以追踪对象在不同阶段的状态变化，有助于发现问题。

class Counter:def __init__(self):self.count = 0def increment(self):self.count += 1def decrement(self):self.count -= 1def __repr__(self):return f'Counter(count={self.count})'# 初始化计数器对象
counter = Counter()
print(repr(counter))  # 输出：Counter(count=0)# 执行一些操作并使用 repr 追踪状态
counter.increment()
print(repr(counter))  # 输出：Counter(count=1)counter.increment()
print(repr(counter))  # 输出：Counter(count=2)counter.decrement()
print(repr(counter))  # 输出：Counter(count=1)

以上这些技巧展示了 repr(object) 的一些巧妙用法，通过灵活运用 repr 函数，可以在调试、日志记录、数据持久化等方面获得更多便利。

---

综合技巧

好的，以下是一些结合 repr 函数与其他函数或方法的巧妙用法，这些用法利用了Python的灵活性和 repr 的强大功能，展示了其在不同场景下的应用。

技巧一：结合 eval 实现配置文件的加载和保存

通过 repr 和 eval 的结合，可以轻松地保存和恢复配置数据。

# 定义配置数据
config = {'setting1': 'value1','setting2': 42,'setting3': [1, 2, 3]
}# 将配置数据保存到文件
with open('config.py', 'w') as file:file.write('config = ' + repr(config) + '\n')# 从文件加载配置数据
from config import config as loaded_configprint(loaded_config)  # 输出：{'setting1': 'value1', 'setting2': 42, 'setting3': [1, 2, 3]}

技巧二：结合 ast.literal_eval 实现更安全的动态数据加载

使用 ast.literal_eval 代替 eval 可以提高安全性，避免执行任意代码的风险。

import ast# 定义一个复杂的数据结构
data = {"key1": "value1", "key2": 42, "key3": [1, 2, 3]}# 将数据结构转为字符串表示形式并保存到文件
with open('data.txt', 'w') as file:file.write(repr(data))# 从文件中读取数据
with open('data.txt', 'r') as file:read_data_str = file.read()# 使用 ast.literal_eval 恢复原始数据结构
restored_data = ast.literal_eval(read_data_str)print(restored_data)  # 输出：{'key1': 'value1', 'key2': 42, 'key3': [1, 2, 3]}

技巧三：结合 logging 模块记录详细调试信息

利用 repr 为日志记录提供详细的调试信息，不仅限于简单字符串。

import logging# 配置日志记录
logging.basicConfig(level=logging.DEBUG)class ComplexObject:def __init__(self, name, attributes):self.name = nameself.attributes = attributesdef __repr__(self):return f'ComplexObject(name={repr(self.name)}, attributes={repr(self.attributes)})'# 创建 ComplexObject 对象
obj = ComplexObject('Sample', {'attr1': 10, 'attr2': [1, 2, 3]})# 记录详细调试信息
logging.debug(f'Created object: {repr(obj)}')  # 日志输出：DEBUG:root:Created object: ComplexObject(name='Sample', attributes={'attr1': 10, 'attr2': [1, 2, 3]})

技巧四：结合 dataclass 和 repr 实现自动化的对象表示

使用 dataclasses 模块简化类定义，同时结合 repr 提供详细的对象表示。

from dataclasses import dataclass@dataclass
class Product:name: strprice: floatstock: int# dataclass 自动生成 __repr__ 方法# 但可以自定义 __repr__ 方法以提供更详细的表示形式def __repr__(self):return f'Product(name={repr(self.name)}, price={repr(self.price)}, stock={repr(self.stock)})'# 创建 Product 对象
product = Product('Laptop', 999.99, 50)# 使用 repr 打印 Product 对象的调试信息
print(repr(product))  # 输出：Product(name='Laptop', price=999.99, stock=50)

技巧五：结合 functools 的 lru_cache 实现缓存调试信息

通过 repr 和 functools.lru_cache，可以缓存函数调用的结果，并便于调试缓存中的数据。

from functools import lru_cache@lru_cache(maxsize=32)
def compute_square(n):result = n * nprint(f'Computing square of {n}: {result}')return result# 调用函数，缓存结果
compute_square(4)
compute_square(2)
compute_square(8)# 打印缓存内容
print(f'Cache info: {repr(compute_square.cache_info())}')  # 输出：Cache info: CacheInfo(hits=0, misses=3, maxsize=32, currsize=3)

技巧六：结合 contextlib 模块实现上下文管理器的调试

通过 repr 和 contextlib 模块，可以方便地调试上下文管理器的行为。

from contextlib import contextmanager@contextmanager
def debug_context(name):print(f'Entering context: {repr(name)}')yieldprint(f'Exiting context: {repr(name)}')# 使用上下文管理器
with debug_context('my_context'):print('Inside context')# 输出：
# Entering context: 'my_context'
# Inside context
# Exiting context: 'my_context'

这些技巧展示了 repr 函数在不同场景下与其他函数或方法结合使用的强大功能，帮助开发者更高效地调试、记录和管理代码中的各类信息。

---

感谢。