理解 Python 中 `str` 和 `repr`：清晰表达对象的字符串表示

python

2024-03-05 12:41:50

__str__ 和 __repr__：理解 Python 中对象的字符串表示

简介

作为一名资深的程序员和技术作家，我经常遇到 __str__ 和 __repr__ 方法，它们对于定义 Python 对象的字符串表示至关重要。今天，我将深入探讨这两个方法，帮助你理解它们的差异、用途和最佳实践。

`str`：用户友好的表示

想象一下，你在调试代码时需要查看某个对象的详细信息。__str__ 方法就像一位向导，提供了一个简洁而易于理解的字符串表示，帮助你快速了解对象的属性和状态。它通常用于日志记录、调试和向用户显示对象信息。

`repr`：可执行的表示

另一方面，__repr__ 方法就像一位代码魔法师。它生成一个字符串，当传递给 eval() 函数时，可以重新创建该对象。这意味着，__repr__ 主要用于持久化和对象比较。

关键区别

**| 特征 | __str__ | __repr__ |
|---|---|---|
| 目的 | 用户友好的表示 | 可执行的表示 |
| 输出 | 易于人类阅读的字符串 | 可传递给 eval() 函数以重建对象的字符串 |
| 用途 | 日志记录、调试、向用户显示信息 | 持久化、对象比较 |

最佳实践

__str__

简洁、清晰且信息丰富。
使用双引号表示字符串。
避免换行符和其他复杂格式。

__repr__

可执行且不含歧义。
包含对象的状态信息。
使用双引号表示字符串。
避免换行符和其他复杂格式。

示例

考虑一个 Person 对象：

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

    def __str__(self):
        return f"{self.name} is {self.age} years old."

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

__str__ 输出： "Alice is 30 years old."
__repr__ 输出： "Person('Alice', 30)"

常见问题解答

为什么 __repr__ 输出包含类的名称？
- 这有助于识别对象的类型，尤其是在调试和比较对象时。
我什么时候应该使用 __str__ 和 __repr__？
- __str__ 用于人类可读的表示，而 __repr__ 用于可执行的表示。
我可以覆盖 __str__ 和 __repr__ 方法吗？
- 是的，你可以根据你的需要定制这些方法。
是否存在其他方法来定义对象的字符串表示？
- 是的，还有 __bytes__ 方法（返回字节字符串）和 __format__ 方法（用于自定义格式化）。
为什么在实现 __repr__ 方法时避免换行符很重要？
- 这是因为 eval() 函数不支持多行字符串。