Python中__str__和__repr_之间有什么区别?


当前回答

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

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

默认的实现是无用的(很难想到一个不会是,但是的)__代表的目标是明确无误__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__。

其他回答

简而言之,__repr_的目标是明确,__str__是可读。

这里有一个很好的例子:

>>> import datetime
>>> today = datetime.datetime.now()
>>> str(today)
'2012-03-14 09:21:58.130922'
>>> repr(today)
'datetime.datetime(2012, 3, 14, 9, 21, 58, 130922)'

阅读本文档以了解代表:

repr(对象)返回包含对象的可打印表示形式的字符串。这与转换产生的值相同(相反引号)。有时,作为一个普通的函数。对于许多类型,此函数会尝试返回一个字符串,当传递给eval(),否则表示形式是一个字符串包含对象类型名称的尖括号以及通常包括姓名和对象的地址。类可以控制此函数返回的内容为其实例定义__repr_()方法。

以下是str的文档:

str(对象=“”)返回一个字符串,该字符串包含可打印的对象的表示。对于字符串,这将返回字符串它本身与repr(object)的区别在于str(object)没有始终尝试返回eval()可接受的字符串;它的目标是返回一个可打印的字符串。如果未给定参数,则返回空字符串“”。

除非您特别采取行动以确保其他情况,否则大多数类对以下两种情况都没有帮助:

>>> class Sic(object): pass
... 
>>> print(str(Sic()))
<__main__.Sic object at 0x8b7d0>
>>> print(repr(Sic()))
<__main__.Sic object at 0x8b7d0>
>>> 

正如您所看到的,没有区别,也没有超出类和对象id的信息。如果您只覆盖这两个中的一个…:

>>> class Sic(object): 
...   def __repr__(self): return 'foo'
... 
>>> print(str(Sic()))
foo
>>> print(repr(Sic()))
foo
>>> class Sic(object):
...   def __str__(self): return 'foo'
... 
>>> print(str(Sic()))
foo
>>> print(repr(Sic()))
<__main__.Sic object at 0x2617f0>
>>> 

如您所见,如果重写__repr_,那么它也用于__str__,但反之亦然。

要知道的其他关键提示:内置容器上的__str__使用__repr_而不是__str__来表示它包含的项。而且,尽管在典型的文档中找到了关于这个主题的单词,但几乎没有人会将__repr_对象设置为eval可以用来构建相等对象的字符串(这太难了,而且不知道相关模块是如何实际导入的,这实际上是不可能的)。

因此,我的建议是:专注于使__str__合理地具有可读性,并尽可能地明确__repr___,即使这会干扰模糊的不可实现的目标,即使__repr_的返回值可接受作为__eval___的输入!

__repr_在任何地方都使用,但print和str方法除外(当定义了__str__时!)

(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()或__repr_主要返回对象的规范字符串表示,用于调试和开发,帮助程序员。