（2020条目）

Q： __str__（）和__repr___（）之间有什么区别？

TL；博士：

LONG

这个问题已经存在了很长一段时间，有很多答案都是正确的（更不用说来自几个Python社区的传说[！]）。然而，当谈到本质时，这个问题类似于询问str（）和repr（）内置函数之间的区别。我将用我自己的语言描述这些差异（这意味着我可能是在“借用”核心Python编程，所以请原谅我）。

str（）和repr（）都有相同的基本任务：它们的目标是返回Python对象的字符串表示。什么样的字符串表示是它们的区别。

str（）和__str__（）返回可打印的字符串表示形式对象。。。人类可读/供人类食用的东西repr（）&__repr_（）返回一个对象的字符串表示，该对象是一个有效的Python表达式，您可以传递给eval（）或在Python shell中键入，而不会出现错误。

例如，让我们将一个字符串分配给x，将一个int分配给y，并简单地显示每个字符串的可读字符串版本：

>>> x, y = 'foo', 123
>>> str(x), str(y)
('foo', '123')

我们可以在这两种情况下获取引号中的内容并将其逐字输入Python解释器吗？让我们试一试：

>>> 123
123
>>> foo
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'foo' is not defined

显然，您可以使用int，但不必使用str。同样，虽然我可以将“123”传递给eval（），但这对“foo”不起作用：

>>> eval('123')
123
>>> eval('foo')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<string>", line 1, in <module>
NameError: name 'foo' is not defined

所以这告诉你Python shell只是eval（）是你给它的。明白了吗？现在，让我们repr（）两个表达式，看看我们得到了什么。更具体地说，获取其输出并将其转储到解释器中（这一点我们将在后面讨论）：

>>> repr(x), repr(y)
("'foo'", '123')
>>> 123
123
>>> 'foo'
'foo'

哇，他们都工作了？这是因为“foo”虽然是该字符串的可打印字符串表示，但它不是可求值的，但“'fo'”是.123是str（）或repr（）调用的有效Python int。当我们用这些调用eval（）时会发生什么？

>>> eval('123')
123
>>> eval("'foo'")
'foo'

它之所以有效，是因为123和“foo”是有效的Python对象。另一个关键点是，虽然有时两者都返回相同的东西（相同的字符串表示），但情况并非总是如此。（是的，是的，我可以在eval（）工作的地方创建一个变量foo，但这不是重点。）

关于这两对的更多事实

有时，str（）和repr（）是隐式调用的，这意味着它们是代表用户调用的：当用户执行print（Py1/Py2）或调用print（）（Py3+）时，即使用户没有显式调用str（（），也会在显示对象之前代表用户进行这样的调用。在Pythonshell（交互式解释器）中，如果在>>提示符下输入变量并按RETURN，解释器将显示对该对象隐式调用repr（）的结果。要将str（）和repr（）连接到__str__（）和__repr___（），请认识到对内置函数（即str（x）或repr（y））的调用会导致调用其对象的相应特殊方法：x.__str____通过为Python类实现__str__（）和__repr_（），可以重载内置函数（str（）和repr（）），允许将类的实例传递给str（（）和repr（）。当进行此类调用时，它们会返回并调用类'__str__（）和__repr___（）（根据#3）。

亚历克斯总结得很好，但令人惊讶的是，过于简洁。

首先，让我重申亚历克斯帖子中的要点：

默认的实现是无用的（很难想到一个不会是，但是的）__代表的目标是明确无误__str__目标是可读容器的__str__使用包含对象的__repr__

默认实现是无用的

这主要是一个惊喜，因为Python的默认值往往非常有用。然而，在这种情况下，__repr_的默认值如下：

return "%s(%r)" % (self.__class__, self.__dict__)

如果对象相互引用，就太危险了（例如，太容易陷入无限递归）。所以Python就退出了。请注意，有一个默认值是真的：如果__repr_已定义，而__str__未定义，则对象将表现为__str__=__repr___。

简单地说，这意味着：几乎你实现的每个对象都应该有一个可用于理解对象的函数__repr_。实现__str__是可选的：如果您需要“漂亮的打印”功能（例如，由报表生成器使用），可以这样做。

__repr__的目标是明确

让我直接说出来——我不相信调试器。我真的不知道如何使用任何调试器，也从未认真使用过。此外，我认为调试器的最大缺点是它们的基本特性——我调试的大多数失败都发生在很久以前，在遥远的星系中。这意味着我怀着宗教热情，确实相信伐木。日志记录是任何优秀的即发即弃服务器系统的生命线。Python使日志记录变得容易：使用一些特定于项目的包装器，您只需要一个

log(INFO, "I am in the weird function and a is", a, "and b is", b, "but I got a null C — using default", default_c)

但你必须做最后一步——确保你实现的每个对象都有一个有用的repr，这样的代码才能正常工作。这就是为什么会出现“eval”的问题：如果你有足够的信息，那么eval（repr（c））==c，这意味着你知道关于c的所有信息。如果这足够简单，至少以模糊的方式，那么就这样做。如果没有，那么无论如何都要确保你有足够关于c的信息。我通常使用类似eval的格式：“MyClass（this=%r，that=%r）”%（self.this，self.that）。这并不意味着你真的可以构造MyClass，或者这些是正确的构造函数参数，但它是一种有用的形式来表达“这是你需要了解的关于这个实例的一切”。

注意：我使用的是上面的%r，而不是%s。您总是希望在__repr_实现中使用repr（）[或%r格式字符，等效地]，否则您会破坏repr的目标。您希望能够区分MyClass（3）和MyClass（“3”）。

__str__的目标是可读

具体地说，这并不是要明确的——请注意str（3）==str（“3”）。同样，如果你实现了一个IP抽象，那么让它的str看起来像192.168.1.1就可以了。在实现日期/时间抽象时，str可以是“2010/4/12 15:35:22”等。目标是以用户（而不是程序员）想要阅读的方式表示它。去掉无用的数字，假装是其他类-只要它支持可读性，这就是一种改进。

容器的__str__使用包含对象的__repr__

这似乎令人惊讶，不是吗？它有点小，但如果使用它们的__str__，它的可读性会如何？

[moshe is, 3, hello
world, this is a list, oh I don't know, containing just 4 elements]

不是很好。具体来说，容器中的字符串太容易干扰其字符串表示。面对歧义，请记住，Python抵制猜测的诱惑。如果您在打印列表时想要上述行为，只需

print("[" + ", ".join(l) + "]")

（你可能还可以弄清楚该怎么处理字典。

总结

为您实现的任何类实现__repr_。这应该是第二天性。如果您认为字符串版本在可读性方面出错会很有用，请实现__str__。

Hans Petter Langtanch的《Python脚本用于计算科学》一书第358页明确指出

__repr_的目标是对象的完整字符串表示；__str__是返回一个用于打印的字符串。

所以，我更愿意把他们理解为

repr=再现str=字符串（表示）

从用户的角度来看尽管这是我在学习python时产生的误解。

同一页还提供了一个小但很好的示例，如下所示：

实例

In [38]: str('s')
Out[38]: 's'

In [39]: repr('s')
Out[39]: "'s'"

In [40]: eval(str('s'))
Traceback (most recent call last):

  File "<ipython-input-40-abd46c0c43e7>", line 1, in <module>
    eval(str('s'))

  File "<string>", line 1, in <module>

NameError: name 's' is not defined


In [41]: eval(repr('s'))
Out[41]: 's'

__str__必须返回字符串对象，而__repr_可以返回任何python表达式。如果缺少__str__实现，则__repr_函数用作回退。如果缺少__repr_函数实现，则没有回退。如果__repr_函数返回对象的String表示，我们可以跳过__str__函数的实现。

资料来源：https://www.journaldev.com/22460/python-str-repr-functions

直观地理解和永久地区分它们。

__str__返回给定对象的字符串伪装体，以便于眼睛阅读__repr_返回给定对象的真实肉身（返回自身），以便明确识别。

在示例中看到

In [30]: str(datetime.datetime.now())
Out[30]: '2017-12-07 15:41:14.002752'
Disguised in string form

关于__代表__

In [32]: datetime.datetime.now()
Out[32]: datetime.datetime(2017, 12, 7, 15, 43, 27, 297769)
Presence in real body which allows to be manipulated directly.

我们可以方便地对__repr_结果进行算术运算。

In [33]: datetime.datetime.now()
Out[33]: datetime.datetime(2017, 12, 7, 15, 47, 9, 741521)
In [34]: datetime.datetime(2017, 12, 7, 15, 47, 9, 741521) - datetime.datetime(2
    ...: 017, 12, 7, 15, 43, 27, 297769)
Out[34]: datetime.timedelta(0, 222, 443752)

如果对__str应用操作__

In [35]: '2017-12-07 15:43:14.002752' - '2017-12-07 15:41:14.002752'
TypeError: unsupported operand type(s) for -: 'str' and 'str'

只返回错误。

另一个例子。

In [36]: str('string_body')
Out[36]: 'string_body' # in string form

In [37]: repr('real_body')
Out[37]: "'real_body'" #its real body hide inside

希望这能帮助你建立具体的基础来探索更多的答案。

老实说，eval（repr（obj））从不使用。如果你发现自己在使用它，你应该停止，因为eval是危险的，字符串是一种非常低效的序列化对象的方法（改用pickle）。

因此，我建议设置__repr_=__str__。原因是str（list）在元素上调用repr（我认为这是Python最大的设计缺陷之一，Python 3没有解决）。实际的repr可能对打印（[your，objects]）的输出没有太大帮助。

为了证明这一点，根据我的经验，repr函数最有用的用例是将一个字符串放在另一个字符串中（使用字符串格式）。这样，您就不必担心转义引号或其他任何问题。但请注意，这里没有eval。