Python中__repr__和__str__区别详解

__repr__与__str__的基本区别

通过以下示例可以直观理解两者的差异。

class Test(object):
  def __init__(self, value='hello, world!'):
    self.data = value

>>> t = Test()
>>> t
<__main__.Test at 0x7fa91c307190>
>>> print t
<__main__.Test object at 0x7fa91c307190>

观察发现，直接打印类实例时显示的是内存地址，这种默认输出方式对用户不够友好。

接下来对类的__repr__和__str__方法进行重构，以对比它们的具体行为差异。

# 重构__repr__
class TestRepr(Test):
  def __repr__(self):
    return 'TestRepr(%s)' % self.data

>>> tr = TestRepr()
>>> tr        直接终端显示，不print就是面向程序员
TestRepr(hello, world!)
>>> print tr     print是面向程序员
TestRepr(hello, world!)

在重构__repr__方法后，无论是直接在终端交互界面输出对象实例，还是使用print函数打印，均会按照__repr__中定义的格式进行显示。

# 重构__str__
calss TestStr(Test):
  def __str__(self):
    return '[Value: %s]' % self.data

>>> ts = TestStr()
>>> ts
<__main__.TestStr at 0x7fa91c314e50>
>>> print ts
[Value: hello, world!]

值得注意的是，直接输出对象ts时并未采用__str__定义的格式，而是保持了默认的内存地址显示；但使用print函数输出时，结果已按__str__的定义进行了改变。

__repr__与__str__的设计定位

__repr__和__str__均用于对象显示，但定位不同：__str__面向最终用户，强调可读性；__repr__面向程序员，强调准确性和调试信息。

打印操作会优先尝试调用__str__方法（包括内置的print函数内部逻辑），其返回值通常是一个对用户友好的字符串表示。

__repr__用于其他所有显示场景，包括交互模式下的提示回应以及调用repr()函数时。如果未定义__str__，print和str()会回退使用__repr__。它通常返回一个编码字符串，该字符串可用于重新创建对象，或为开发者提供详细的内部状态信息。

若希望所有显示环境下保持一致，可仅重构__repr__方法；若需区分不同场景，例如终端用户看到友好格式而开发者看到底层细节，则应同时定义两者。实际上，__str__往往通过覆盖__repr__来提供更友好的用户视图。

以上内容涵盖了Python中__repr__与__str__的核心区别与应用场景，希望对读者有所帮助，欢迎继续支持本站获取更多技术资源。