（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__和__repr_之间的差异，对我来说，这归结为前者即使是最终用户也可以阅读，后者对开发人员尽可能有用。考虑到这一点，我发现__repr_的默认实现常常无法实现这一目标，因为它忽略了对开发人员有用的信息。

出于这个原因，如果我有一个足够简单的__str__，我通常只会尝试通过以下方式来达到两全其美：

def __repr__(self):
    return '{0} ({1})'.format(object.__repr__(self), str(self))

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

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

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

每个对象都从所有对象创建的基类继承__repr_。

class Person:
     pass

p=Person()

如果你调用repr（p），你会得到默认值：

 <__main__.Person object at 0x7fb2604f03a0>

但如果调用str（p），则会得到相同的输出。这是因为当__str__不存在时，Python调用__repr__

让我们实现自己的__str__

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

p=Person("ali",20)

print（p）和str（p）将返回

 __repr__ called
     Person(name='ali',age=20)

让我们添加__str__（）

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

p=Person("ali",20)

如果我们调用print（p）和str（p），它将调用__str__（），因此它将返回

__str__ called
ali

repr（p）将返回

repr调用“人（name=‘ali，age=self.age’）”

让我们省略__repr_，只实现__str__。

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

def __str__(self):
    print('__str__ called')
    return self.name

p=Person('ali',20)

print（p）将查找__str__并返回：

__str__ called
ali

注意：如果我们定义了__repr_和__str__，则f'name为｛p｝'将调用__str__

repr（）用于调试或日志。它用于开发人员理解代码。另一方面，str（）用户用于非开发人员（QA）或用户。

class Customer:
    def __init__(self,name):
        self.name = name
    def __repr__(self):
        return "Customer('{}')".format(self.name)
    def __str__(self):
        return f"cunstomer name is {self.name}"

cus_1 = Customer("Thusi")
print(repr(cus_1)) #print(cus_1.__repr__()) 
print(str(cus_1)) #print(cus_1.__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'