Python中__str__和__repr_之间有什么区别?
当前回答
Python中__str__和__repr_之间有什么区别?
__str__(读作“dunder(双下划线)字符串”)和__repr_(读作”dunder repper“(代表“表示”))都是基于对象状态返回字符串的特殊方法。
__如果缺少__str__,repr_将提供备份行为。
因此,应该首先编写一个__repr_,允许您从它返回的字符串中重新实例化等效对象,例如使用eval或在Python shell中逐个字符地键入它。
在以后的任何时候,如果认为有必要,可以为实例的用户可读字符串表示编写__str__。
__字符串__
如果打印对象,或将其传递给format、str.format或str,则如果定义了__str__方法,则将调用该方法,否则将使用__repr_。
__代表__
__repr_方法由内置函数repr调用,当它计算返回对象的表达式时,它会在python外壳上响应。
由于它为__str__提供了备份,如果只能编写一个,请从__repr开始__
下面是repr的内置帮助:
repr(...)
repr(object) -> string
Return the canonical string representation of the object.
For most object types, eval(repr(object)) == object.
也就是说,对于大多数对象,如果您键入repr打印的内容,您应该能够创建一个等效的对象。但这不是默认实现。
__repr的默认实现__
默认对象__repr_是(C Python源代码),类似于:
def __repr__(self):
return '<{0}.{1} object at {2}>'.format(
type(self).__module__, type(self).__qualname__, hex(id(self)))
这意味着默认情况下,您将打印对象所在的模块、类名以及其在内存中位置的十六进制表示形式,例如:
<__main__.Foo object at 0x7f80665abdd0>
这些信息不是很有用,但没有办法得出如何准确地创建任何给定实例的规范表示,这总比什么都没有好,至少告诉我们如何在内存中唯一地识别它。
__repr__如何有用?
让我们看看使用Pythonshell和datetime对象它有多有用。首先,我们需要导入datetime模块:
import datetime
如果我们在shell中调用datetime.now,我们将看到重新创建等效datetime对象所需的一切。这是由datetime __repr_创建的:
>>> datetime.datetime.now()
datetime.datetime(2015, 1, 24, 20, 5, 36, 491180)
如果我们打印一个datetime对象,我们会看到一种很好的可读(实际上是ISO)格式。这由datetime的__str__实现:
>>> print(datetime.datetime.now())
2015-01-24 20:05:44.977951
重新创建我们丢失的对象很简单,因为我们没有通过复制和粘贴__repr_输出将其分配给变量,然后打印它,我们在与其他对象相同的人类可读输出中获得它:
>>> the_past = datetime.datetime(2015, 1, 24, 20, 5, 36, 491180)
>>> print(the_past)
2015-01-24 20:05:36.491180
#我如何实施它们?
在开发过程中,如果可能的话,您希望能够以相同的状态再现对象。例如,datetime对象就是这样定义__repr_(Python源代码)的。它相当复杂,因为复制这样一个对象所需的所有属性:
def __repr__(self):
"""Convert to formal string, for repr()."""
L = [self._year, self._month, self._day, # These are never zero
self._hour, self._minute, self._second, self._microsecond]
if L[-1] == 0:
del L[-1]
if L[-1] == 0:
del L[-1]
s = "%s.%s(%s)" % (self.__class__.__module__,
self.__class__.__qualname__,
", ".join(map(str, L)))
if self._tzinfo is not None:
assert s[-1:] == ")"
s = s[:-1] + ", tzinfo=%r" % self._tzinfo + ")"
if self._fold:
assert s[-1:] == ")"
s = s[:-1] + ", fold=1)"
return s
如果您希望您的对象具有更具可读性的表示形式,那么接下来可以实现__str__。datetime对象(Python源代码)是如何实现__str__的,这很容易实现,因为它已经有了一个以ISO格式显示的函数:
def __str__(self):
"Convert to string, for str()."
return self.isoformat(sep=' ')
设置__repr_=__str__?
这是对另一个建议设置__repr_=__str__的答案的批评。
设置__repr__=__str__是愚蠢的-__repr__是__str__的后备方案,在编写__str__之前,应该编写一个__repr___,供开发人员在调试中使用。
只有当需要对象的文本表示时,才需要__str__。
结论
为您编写的对象定义__repr_,以便您和其他开发人员在开发时使用它时有一个可复制的示例。当需要可读字符串表示时,定义__str__。
其他回答
亚历克斯总结得很好,但令人惊讶的是,过于简洁。
首先,让我重申亚历克斯帖子中的要点:
默认的实现是无用的(很难想到一个不会是,但是的)__代表的目标是明确无误__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()用户用于非开发人员(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__())
直观地理解和永久地区分它们。
__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
希望这能帮助你建立具体的基础来探索更多的答案。
基本上__str__或str()用于创建人类可读的输出,这些输出必须面向最终用户。另一方面,repr()或__repr_主要返回对象的规范字符串表示,用于调试和开发,帮助程序员。
您可以从以下代码中获得一些见解:
class Foo():
def __repr__(self):
return("repr")
def __str__(self):
return("str")
foo = Foo()
foo #repr
print(foo) #str
推荐文章
- 将Pandas或Numpy Nan替换为None以用于MysqlDB
- 使用pandas对同一列进行多个聚合
- 使用Python解析HTML
- django MultiValueDictKeyError错误,我如何处理它
- 如何在for循环期间修改列表条目?
- 我如何在Django中创建一个鼻涕虫?
- 没有名为'django.core.urlresolvers'的模块
- 蟒蛇导出环境文件
- Django - makemigrations -未检测到任何更改
- SQLAlchemy:引擎、连接和会话差异
- 在Python Pandas中删除多个列中的所有重复行
- 更改pandas DataFrame中的特定列名
- 将Pandas多索引转换为列
- 熊猫在每组中获得最高的n个记录
- 熊猫数据帧得到每组的第一行