Python字符串表示终极指南：__str__与__repr__的区别详解

Python字符串表示终极指南：__str__与__repr__的区别详解

【免费下载链接】learn-python 📚 Playground and cheatsheet for learning Python. Collection of Python scripts that are split by topics and contain code examples with explanations. 项目地址: https://gitcode.com/gh_mirrors/le/learn-python

在Python中，对象的字符串表示是日常开发中经常接触的基础功能，而__str__与__repr__这两个特殊方法正是控制对象字符串表现形式的核心。本文将深入浅出地解析两者的本质区别、应用场景及最佳实践，帮助开发者写出更易读、更易于调试的Python代码。

一、核心区别：用户友好 vs 开发者友好

__str__和__repr__虽然都用于返回对象的字符串表示，但设计目标截然不同：

• __str__：面向用户的可读性优先
  当使用print()函数或str()转换对象时调用，返回值应简洁明了、易于人类理解，例如"User(name='Alice', age=30)"。

• __repr__：面向开发者的调试需求
  当直接在解释器中输入对象或使用repr()函数时调用，返回值应包含创建该对象的完整信息，理想情况下可直接用于重建对象，例如"User('Alice', 30)"。

二、默认行为与实现必要性

如果未显式定义这两个方法，Python会使用默认实现：

<__main__.ClassName object at 0x7f8a1b2c3d4e>

这种表示既不友好也不实用，因此建议为自定义类同时实现__str__和__repr__。

三、实现规范与示例

1. __repr__的实现原则

• 包含完整的对象状态信息
• 尽量保证eval(repr(obj)) == obj成立
• 使用明确的语法格式

class User:
    def __init__(self, name, age):
        self.name = name
        self.age = age
        
    def __repr__(self):
        return f"User(name='{self.name}', age={self.age})"

2. __str__的实现原则

• 简洁易懂的自然语言描述
• 突出对象的核心特征
• 可选择性继承__repr__的实现

class User:
    # ... 省略__init__和__repr__ ...
    
    def __str__(self):
        return f"{self.name} ({self.age}岁)"

四、实际应用场景对比

场景1：打印输出（print(obj)）

user = User("Bob", 25)
print(user)  # 调用__str__ → "Bob (25岁)"

场景2：调试信息（repr(obj)）

user = User("Bob", 25)
print(repr(user))  # 调用__repr__ → "User(name='Bob', age=25)"

场景3：容器对象的字符串表示

列表、字典等容器在打印时会使用元素的__repr__而非__str__：

users = [User("Alice", 30), User("Bob", 25)]
print(users)  # 显示所有元素的__repr__结果

五、最佳实践总结

1. 始终实现__repr__
   即使不实现__str__，Python也会 fallback 到__repr__，确保调试时有可用信息。

2. __str__可选但推荐
   为用户交互场景提供更友好的展示，如日志输出、UI显示等。

3. 遵循"eval友好"原则
   __repr__的返回值应尽可能满足eval(repr(obj)) == obj，便于快速重建对象。

4. 避免在__str__中包含敏感信息
   用户可见的字符串表示不应泄露密码、密钥等敏感数据。

通过合理使用__str__和__repr__，可以显著提升代码的可读性和可维护性，是写出专业Python代码的必备技能。更多Python面向对象编程的实践示例，可以参考项目中的src/classes/目录下的测试用例。

【免费下载链接】learn-python 📚 Playground and cheatsheet for learning Python. Collection of Python scripts that are split by topics and contain code examples with explanations. 项目地址: https://gitcode.com/gh_mirrors/le/learn-python