Python中的__str__和__repr__有什么区别___str__与__repr__方法深度辨析-Python教程-PHP中文网

Python中的__str__和__repr__有什么区别___str__与__repr__方法深度辨析

裘德小鎮的故事

发布： 2025-09-16 21:33:01

原创

928人浏览过

__str__用于用户友好的字符串输出，如print(p)时调用；__repr__提供开发者级别的详细表示，用于调试，被repr()或交互式环境调用。若未定义__str__，则回退到__repr__。最佳实践是优先实现__repr__，并根据需要添加__str__以提升可读性。

python中的__str__和__repr__有什么区别___str__与__repr__方法深度辨析

简单来说，

__str__

登录后复制

旨在提供用户友好的字符串表示，而

__repr__

登录后复制

侧重于提供明确的、无歧义的字符串表示，通常用于调试和开发。选择哪个取决于你的目标受众和使用场景。

__str__

登录后复制

与
__repr__
登录后复制
方法深度辨析

__str__

登录后复制

和

__repr__

登录后复制

是 Python 中用于将对象转换为字符串的特殊方法（也称为魔术方法或双下划线方法）。虽然它们都服务于类似的目的，但它们之间存在关键的区别，理解这些区别对于编写清晰、可维护的 Python 代码至关重要。

什么时候应该使用

__str__

登录后复制

？

立即学习“Python免费学习笔记（深入）”；

__str__

登录后复制

方法的目标是返回一个易于理解的、面向最终用户的字符串表示。想象一下，你需要向用户展示一个日期对象，你可能希望它显示为 "2023-10-27"，而不是一些内部表示。这就是

__str__

登录后复制

发挥作用的地方。

例如：

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

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

p = Point(2, 3)
print(str(p)) # 输出: Point(2, 3)

登录后复制

在这里，

__str__

登录后复制

方法返回一个格式化的字符串，清晰地表示了

Point

登录后复制

对象的状态。如果没有定义

__str__

登录后复制

，调用

str(p)

登录后复制

将会调用默认的

__repr__

登录后复制

实现（如果定义了的话），或者返回一个不太友好的默认字符串。

什么时候应该使用

__repr__

登录后复制

？

__repr__

登录后复制

方法则应该返回一个明确的、无歧义的字符串表示，通常用于调试、日志记录和开发目的。理想情况下，这个字符串应该能够被

eval()

登录后复制

函数执行，从而重新创建该对象。如果不能完全做到这一点，它至少应该包含足够的信息，以便开发人员能够清楚地了解对象的状态。

例如：

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})"

p = Point(2, 3)
print(repr(p)) # 输出: Point(x=2, y=3)

登录后复制

在这个例子中，

__repr__

登录后复制

方法返回一个包含属性名称和值的字符串，这使得在调试时更容易理解

Point

登录后复制

对象的状态。

__str__

登录后复制

和

__repr__

登录后复制

的关系是什么？

如果一个类只定义了

__repr__

登录后复制

方法，而没有定义

__str__

登录后复制

方法，那么在需要字符串表示时，Python 会自动调用

__repr__

登录后复制

方法。这意味着

__repr__

登录后复制

可以作为一种后备方案，提供一个通用的字符串表示。

百度文心百中

百度大模型语义搜索体验中心

查看详情

但是，如果一个类同时定义了

__str__

登录后复制

和

__repr__

登录后复制

方法，那么 Python 会根据上下文选择调用哪个方法。当你使用

str()

登录后复制

函数或

print()

登录后复制

函数时，Python 会调用

__str__

登录后复制

方法。当你使用

repr()

登录后复制

函数或在交互式解释器中直接输入对象时，Python 会调用

__repr__

登录后复制

方法。

为什么需要两个不同的方法？

区分

__str__

登录后复制

和

__repr__

登录后复制

的主要原因是为了满足不同的需求。最终用户通常只需要一个简单的、易于理解的对象表示，而开发人员则需要一个更详细的、无歧义的对象表示，以便进行调试和分析。

举个例子，假设你正在开发一个电子商务应用程序。你可能希望在用户界面中显示产品的名称和价格，这可以使用

__str__

登录后复制

方法来实现。但是，在日志文件中，你可能希望记录产品的 ID、描述和其他详细信息，以便在出现问题时进行调试，这可以使用

__repr__

登录后复制

方法来实现。

如何选择使用哪个方法？

以下是一些指导原则，可以帮助你选择使用哪个方法：

如果你的目标是提供一个面向最终用户的字符串表示，那么应该使用
```
__str__
```
登录后复制
方法。
如果你的目标是提供一个用于调试和开发的字符串表示，那么应该使用
```
__repr__
```
登录后复制
方法。
如果你的类只有一个字符串表示，那么可以只定义
```
__repr__
```
登录后复制
方法，并让 Python 在需要时自动调用它。
始终确保
```
__repr__
```
登录后复制
方法返回一个明确的、无歧义的字符串表示，最好能够被
```
eval()
```
登录后复制
函数执行。

有没有最佳实践？

当然，以下是一些关于

__str__

登录后复制

和

__repr__

登录后复制

方法的最佳实践：

始终为你的类定义
```
__repr__
```
登录后复制
方法，即使你没有定义
```
__str__
```
登录后复制
方法。
确保
```
__repr__
```
登录后复制
方法返回一个明确的、无歧义的字符串表示。
如果你的类需要一个面向最终用户的字符串表示，那么也应该定义
```
__str__
```
登录后复制
方法。
确保
```
__str__
```
登录后复制
方法返回一个易于理解的字符串表示。
在
```
__str__
```
登录后复制
方法中使用
```
__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})"

    def __str__(self):
        return f"({self.x}, {self.y})" # 更简洁的用户友好显示

登录后复制

总结