怎么使用Python中的__str__()和__repr__()

# 怎么使用Python中的__str__()和__repr__()

在Python中，`__str__()`和`__repr__()`是两个重要的魔术方法（magic methods），用于定义对象的字符串表示形式。虽然它们的功能相似，但使用场景和目的有所不同。本文将详细介绍它们的区别、用法以及如何在实际开发中正确实现这两个方法。

## 1. `__str__()`方法

`__str__()`方法用于返回对象的“非正式”或可读性好的字符串表示，通常面向终端用户。当你使用`print()`函数或`str()`函数时，Python会调用该方法。

### 示例代码
```python
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def __str__(self):
        return f"Person(name={self.name}, age={self.age})"

p = Person("Alice", 30)
print(p)  # 输出：Person(name=Alice, age=30)

特点

• 目标是可读性。
• 通常用于日志、用户界面等场景。
• 如果没有定义__str__()，Python会调用__repr__()作为备用。

2. __repr__()方法

__repr__()方法返回对象的“正式”字符串表示，通常是合法的Python表达式，能够用于重新创建该对象。它主要面向开发者，常用于调试。

示例代码

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

p = Person("Alice", 30)
print(repr(p))  # 输出：Person(name='Alice', age=30)

特点

• 目标是明确性和无歧义。
• 理想情况下，eval(repr(obj))应能重新创建对象。
• 在交互式环境中直接输入对象名时，会调用__repr__()。

3. 两者的区别

4. 最佳实践

1. 始终实现__repr__()
   因为它能提供对象的明确信息，对调试至关重要。

2. 按需实现__str__()
   如果需要一个用户友好的输出，再额外实现该方法。

3. 保持一致性
   __repr__()的输出应尽量满足eval(repr(obj)) == obj。

完整示例

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
    
    def __repr__(self):
        return f"Point({self.x}, {self.y})"
    
    def __str__(self):
        return f"({self.x}, {self.y})"

p = Point(1, 2)
print(str(p))    # 输出：(1, 2)
print(repr(p))   # 输出：Point(1, 2)

5. 总结

• __str__()用于用户友好的输出，__repr__()用于开发者调试。
• 优先实现__repr__()，再根据需要实现__str__()。
• 通过合理使用这两个方法，可以显著提升代码的可读性和可维护性。

掌握这两个魔术方法的使用，能够让你的Python类更加专业和易用！ “`