python中__str__和__repr__方法有什么区别？-Python教程-PHP中文网

__str__用于生成人类可读的字符串，适合展示给用户；__repr__则生成明确无歧义的开发者用字符串，理想情况下可重构对象。两者分工明确，建议优先定义__repr__以保障调试信息完整，再根据需要定义__str__提供友好显示。若只选其一，应优先实现__repr__。

python中__str__和__repr__方法有什么区别？

在Python里，

__str__

登录后复制

和

__repr__

登录后复制

这两个特殊方法，虽然都是为了把对象变成字符串，但它们的目的和使用场景有着本质的区别。简单来说，

__str__

登录后复制

是为了给人类看的，追求可读性和美观；而

__repr__

登录后复制

则是给开发者看的，追求明确性和无歧义，最好能直接用来重现对象。

解决方案

理解

__str__

登录后复制

和

__repr__

登录后复制

，我觉得最好的方式是先从它们各自的“使命”说起。

__str__

登录后复制

方法：为人类而生

当你调用

print()

登录后复制

函数来打印一个对象，或者使用

str()

登录后复制

函数将对象显式转换为字符串时，Python会去寻找并执行对象的

__str__

登录后复制

方法。它的核心目标是提供一个“友好”的、易于理解的字符串表示。想象一下，你正在写一个程序，需要把一个自定义的用户对象展示给最终用户看，比如在日志里，或者在UI界面上。这时，你肯定不希望看到一堆技术细节，而是希望看到像“用户ID: 123, 姓名: 张三”这样简洁明了的信息。

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

如果一个类没有定义

__str__

登录后复制

方法，但定义了

__repr__

登录后复制

方法，那么

str()

登录后复制

函数会退而求其次，调用

__repr__

登录后复制

方法来获取字符串表示。这是Python的一个实用主义设计，毕竟有总比没有好，即使是开发者看的表示，也比默认的

<__main__.MyObject object at 0x...>

登录后复制

要强。

__repr__

登录后复制

方法：为开发者而生

而

__repr__

登录后复制

方法，则更多地服务于开发、调试和内部表示。当你直接在交互式解释器中输入一个对象变量，或者使用

repr()

登录后复制

函数来获取对象的字符串表示时，Python会调用

__repr__

登录后复制

。它的设计哲学是提供一个“无歧义”的、尽可能详细的字符串表示，理想情况下，这个字符串应该是一个有效的Python表达式，能够用来重新创建这个对象。这对于调试来说极其方便，你可以复制这个表示，然后在其他地方尝试重新构建对象，看看行为是否一致。

如果一个类既没有定义

__str__

登录后复制

也没有定义

__repr__

登录后复制

，那么

str()

登录后复制

和

repr()

登录后复制

都会返回一个默认的、通常是

<模块.类名 object at 内存地址>

登录后复制

这样的表示，这显然对我们理解对象内部状态没什么帮助。

让我们看一个简单的例子：

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

    def __str__(self):
        # 给人看的，更简洁、友好
        return f"坐标点: ({self.x}, {self.y})"

    def __repr__(self):
        # 给开发者看的，更明确，理想情况能重构对象
        return f"MyPoint(x={self.x}, y={self.y})"

p = MyPoint(10, 20)

print(p)         # 调用 __str__
# 输出: 坐标点: (10, 20)

print(str(p))    # 调用 __str__
# 输出: 坐标点: (10, 20)

print(repr(p))   # 调用 __repr__
# 输出: MyPoint(x=10, y=20)

# 在交互式解释器中直接输入 p 会调用 __repr__
# >>> p
# MyPoint(x=10, y=20)

登录后复制

通过这个例子，我们能很直观地看到它们的不同输出风格和背后的设计意图。

有道小P

有道小P，新一代AI全科学习助手，在学习中遇到任何问题都可以问我。

查看详情

为什么Python需要两种不同的字符串表示方法？

这背后其实有个挺有意思的设计理念，我个人觉得它体现了Python在“易用性”和“严谨性”之间的平衡。设想一下，如果只有一个

toString()

登录后复制

方法，我们该如何取舍？是让它足够简洁易读，还是足够详细精确？鱼和熊掌往往不可兼得。

Python选择将这个责任拆分开来，就是为了满足不同的使用场景。

__str__

登录后复制

的出现，让我们可以为最终用户提供一个“漂亮”的界面，让他们能轻松理解对象。比如，一个日期对象，用户可能只想看到“2023年10月26日”，而不是“datetime.datetime(2023, 10, 26, 14, 30, 0)”。这种分离，提升了程序的用户体验和输出的可读性。

而

__repr__

登录后复制

的存在，则保证了开发者在调试、日志记录或者序列化（虽然通常有专门的序列化库）时，能够获得一个完整、无歧义的对象状态表示。当你在排查一个复杂系统的问题时，能看到

MyObject(id=123, status='active', created_at='2023-10-26')

登录后复制

这样的信息，远比一个模糊的描述要有用得多。这种区分，在我看来，是Python语言设计哲学中对“明确优于隐晦”原则的实践，它让代码在面对不同受众时，都能以最恰当的方式呈现信息。

什么时候应该定义

__str__

登录后复制

，什么时候定义

__repr__

登录后复制

？

这是一个非常实际的问题，我的经验是，遵循一些最佳实践可以避免很多困惑。

首先，几乎总是应该定义

__repr__

登录后复制

。这是我个人的一个“强迫症”或者说良好习惯。为所有自定义类定义一个清晰的

__repr__

登录后复制

，这被认为是Python社区的一个普遍共识。它为你的对象提供了一个“官方的”、无歧义的表示。理想情况下，

__repr__

登录后复制

的输出应该是一个有效的Python表达式，能够通过

eval()

登录后复制

重新创建对象。当然，这不总是可行的，比如对象依赖外部资源，或者构造函数参数太多。但即使不能完全重现，也要尽量让它包含足够的信息，让开发者能一眼看出对象的核心状态。

其次，只有当

__str__

登录后复制

的输出需要与
__repr__
登录后复制
不同时，才去定义
__str__
登录后复制
。如果你觉得

__repr__

登录后复制

的输出已经足够简洁、友好，可以直接作为人类可读的表示，那么完全可以不定义

__str__

登录后复制

。因为正如前面提到的，当

__str__

登录后复制

不存在时，

str()

登录后复制

函数会退而求其次调用

__repr__

登录后复制

。

举个例子：

简单的数据类（例如只有几个属性的Point类）：
```
__repr__
```
登录后复制
可能已经很简洁了，比如
```
Point(x=1, y=2)
```
登录后复制
。这种情况下，你可能就不需要单独的
```
__str__
```
登录后复制
，直接让
```
str()
```
登录后复制
也用
```
__repr__
```
登录后复制
的输出就行。
复杂业务对象（例如一个User类）：
- ```
__repr__
```
  登录后复制
  可能会是
```
User(id=123, username='alice', email='alice@example.com', status='active')
```
  登录后复制
  ，包含了所有关键信息。
- ```
__str__
```
  登录后复制
  可能只需要
```
用户: alice (ID: 123)
```
  登录后复制
  ，更简洁，更适合展示给用户看。

所以，我的建议是，先写好

__repr__

登录后复制

，让它尽可能地信息完整且无歧义。然后，如果你觉得这个表示对于非技术用户来说过于冗长或不够直观，再考虑为

__str__

登录后复制

提供一个更简洁、更友好的版本。

如果只定义其中一个，会有什么影响？

只定义其中一个，确实会带来一些后果，理解这些能帮助我们更好地设计类。

如果只定义了

__str__

登录后复制

，而没有定义
__repr__
登录后复制
：这会带来一个问题，就是当你尝试获取对象的“官方”或调试表示时，比如在交互式解释器中直接输入对象变量名，或者调用

repr()

登录后复制

时，你将得到Python默认的那个毫无用处的表示，比如

<__main__.MyObject object at 0x7f8d4c0b7d00>

登录后复制

。这对于调试来说是相当糟糕的体验，因为你无法快速查看对象内部的关键状态。这种情况下，虽然

print()

登录后复制

会输出你友好的

__str__

登录后复制

，但开发者在调试时会非常头疼。

class OnlyStr:
    def __init__(self, name):
        self.name = name
    def __str__(self):
        return f"我的名字是 {self.name}"

obj_str = OnlyStr("张三")
print(obj_str)      # 我的名字是 张三
print(repr(obj_str)) # <__main__.OnlyStr object at 0x...> (默认的repr，无用)

登录后复制

如果只定义了

__repr__

登录后复制

，而没有定义
__str__
登录后复制
：这种情况通常是更好的选择。因为正如之前所说，当

__str__

登录后复制

方法不存在时，

str()

登录后复制

函数和

print()

登录后复制

函数会转而调用

__repr__

登录后复制

方法。这意味着，即使你只定义了

__repr__

登录后复制

，你的对象依然能被

print()

登录后复制

出来，并且输出的是你为开发者准备的那个无歧义的表示。对于很多简单的数据结构或内部使用的对象来说，这种行为是完全可以接受的，甚至可以说是一种简化。

class OnlyRepr:
    def __init__(self, value):
        self.value = value
    def __repr__(self):
        return f"OnlyRepr(value={self.value})"

obj_repr = OnlyRepr(123)
print(obj_repr)      # OnlyRepr(value=123) (因为没有__str__，所以print调用了__repr__)
print(repr(obj_repr)) # OnlyRepr(value=123)

登录后复制

所以，总结一下，如果你只能选择定义一个，那么定义