Python repr与str方法在调试信息中的区别

在 Python 调试过程中，直接打印自定义对象往往只能看到内存地址（如 <__main__.Point object at 0x7f...>），这对排查问题毫无帮助。为了获得可读的信息，必须重写 __str__ 和 __repr__ 方法。这两者虽然都是将对象转换为字符串，但在使用场景和设计目的上有着本质的区别。

1. 理解 核心区别

• __str__ (string)：面向最终用户，强调可读性。它的目标是让打印出来的信息对非开发人员友好。使用 print() 函数或 str() 调用时触发。
• __repr__ (representation)：面向开发者，强调准确性和无歧义。它的目标是提供足够的信息，让开发者能够通过这个字符串识别并重建该对象。在交互式控制台直接输入对象名、调试器、日志记录或使用 repr() 时触发。理想情况下，eval(repr(obj)) 应该能够重建该对象。

2. 编写 示例代码

创建一个名为 Student 的类，分别定义这两个方法来观察输出差异。

class Student:
    def __init__(self, name, score):
        self.name = name
        self.score = score

    # 定义面向用户的字符串表示（可读性好，类似名片）
    def __str__(self):
        return f"学生: {self.name}, 成绩: {self.score}"

    # 定义面向开发者的字符串表示（包含重建对象所需的精确参数）
    def __repr__(self):
        return f"Student(name='{self.name}', score={self.score})"

3. 观察 调用场景差异

实例化对象并测试不同触发方式，查看控制台输出。

# 初始化对象
s = Student("李雷", 95)

# 场景 A：使用 print() 函数 -> 优先触发 __str__
print(s)
# 输出: 学生: 李雷, 成绩: 95

# 场景 B：在交互式环境（REPL）直接输入对象 -> 触发 __repr__
s
# 输出: Student(name='李雷', score=95)

# 场景 C：使用 repr() 函数 -> 强制触发 __repr__
print(repr(s))
# 输出: Student(name='李雷', score=95)

4. 掌握 内部回退机制

Python 在查找对象的字符串表示时遵循一套严格的逻辑：当 __str__ 未定义时，Python 会自动回退使用 __repr__；但如果两者都未定义，则使用默认的内存地址显示。

5. 对比 方法特性

以下表格总结了二者的关键差异，请在开发时作为参考。

6. 实施 最佳实践建议

在实际开发中，遵循以下步骤以优化调试效率：

1. 优先 实现 __repr__。
   即使只写一个方法，也要先写 __repr__。因为当没有 __str__ 时，所有场景（包括 print）都会回退使用 __repr__，确保你在调试和日志中至少能看到关键数据。

2. 按需 实现 __str__。
   仅当对象需要向终端用户展示（例如生成网页文本、报表）且 __repr__ 的格式不够美观时，才额外实现 __str__。

3. 利用 代码复用。
   如果两者输出内容类似，可以让 __str__ 直接调用 self.__repr__()，或者在一个私有的辅助方法中统一处理逻辑。如果 __repr__ 的格式已经足够友好，可以直接赋值复用。

    class Point:
        def __init__(self, x, y):
            self.x = x
            self.y = y
   
        def __repr__(self):
            return f"Point(x={self.x}, y={self.y})"
   
        # 如果希望 print 的输出和 debug 完全一致，直接复用
        __str__ = __repr__