Python __repr__ 和 __str__ 特殊方法的区别

__repr__ 和 __str__ 是 Python 中的两个特殊方法，它们都用于返回对象的字符串表示，但它们的功能和目的有所不同。尽管这两个方法的返回值都可以是字符串，但它们的使用场景和目标对象（用户 vs. 开发者）有所区分。

__repr__ 和 __str__ 的主要区别

__str__ 的详细说明

__str__ 是 Python 中用于生成用户友好字符串表示的方法，通常用于输出到屏幕或以人类易读的方式展示对象的状态。它是 print() 函数和 str() 函数的核心。

• 目标：向用户展示对象，通常以简洁、易懂的方式展示对象的主要内容。

示例：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def __str__(self):
        return f"Person: {self.name}, {self.age} years old"

person = Person("Alice", 30)
print(str(person))  # 输出: Person: Alice, 30 years old

如果没有定义 __str__，则 print() 或 str() 会调用默认的 __str__ 方法，该方法返回对象的内存地址信息（例如 <__main__.Person object at 0x...>）。

__repr__ 的详细说明

__repr__ 是用于生成开发者友好字符串表示的方法。它通常用于调试和日志记录，其目标是生成一种能够准确描述对象的格式，甚至可以通过该字符串重新创建该对象（如果实现得当）。__repr__ 的输出更侧重于提供足够的信息以便开发者能够理解和调试对象。

• 目标：为开发者提供精确的表示，通常包含更多的详细信息。

示例：

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

person = Person("Alice", 30)
print(repr(person))  # 输出: Person('Alice', 30)

如果没有定义 __repr__，则 repr() 会返回类似 <__main__.Person object at 0x...> 的信息，表示对象的内存地址。

__str__ 和 __repr__ 的配合使用

有时你希望在输出时既能满足开发者调试需求，又能为用户提供友好的输出。你可以同时实现这两个方法。如果同时定义了这两个方法，Python 会优先调用 __str__，当使用 str() 或 print() 时。

示例：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def __str__(self):
        return f"Person: {self.name}, {self.age} years old"
    
    def __repr__(self):
        return f"Person('{self.name}', {self.age})"

person = Person("Alice", 30)

# 用户友好的输出
print(person)  # 输出: Person: Alice, 30 years old

# 开发者友好的输出
print(repr(person))  # 输出: Person('Alice', 30)

__repr__ 和 __str__ 的默认实现

如果没有显式地定义 __str__ 和 __repr__，Python 会提供默认实现：

• __str__ 默认返回 <object> 格式。
• __repr__ 默认返回 <__main__.ClassName object at 0x...> 格式。

示例：没有定义 __str__ 和 __repr__

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

person = Person("Alice", 30)
print(str(person))   # 输出: <__main__.Person object at 0x...>
print(repr(person))  # 输出: <__main__.Person object at 0x...>

何时使用 __str__ 和 __repr__

• __str__ 主要用于：
  • 向用户显示对象时，提供简洁、友好的输出格式。
  • 与 print() 和 str() 配合使用，以便展示对象。
• __repr__ 主要用于：
  • 向开发者提供对象的详细信息，便于调试和日志记录。
  • 理想情况下，__repr__ 的返回值应该是一个合法的 Python 表达式，可以通过 eval() 重建该对象。

总结

• __str__ 旨在提供面向用户的友好输出，通常简单、易读。
• __repr__ 旨在提供开发者友好的详细输出，通常更加准确，能帮助开发者调试。

相关知识

• __str__ 的详细介绍
• __repr__ 的详细介绍

更新时间：2024-12-03 07:12:12 标签：python 特殊方法 str repr