Python 进阶 - 魔法方法1. __str__()和 __repr__()

<  这两个魔法方法极其容易混淆，整体分析下来还是很有意思的 >

1. 官方定义    

__str__(): str() , format(),  print() 这些内置函数均会调用，并不预期返回一个有效的 Python 表达式，只需要可以更方便或更准确的描述信息，从而输出 “非正式” 或格式良好的字符串表示。

__repr__(): 通过repr() 调用，能够用以个有效的 Python 表达式用来输出，把输出用“正式”或官方的字符串表示。

【注意：__str__和 __repr__的返回值都必须是字符串对象。】

2. 比较分析

2.1 在默认情况下

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

p1 = Person('Aaron_neil', 20) 
p2 = str(p1)
p3 = repr(p1)


>>> print(p1) 
<__main__.Person object at 0x7fad2ed18880>

>>> p2
'<__main__.Person object at 0x7fad2ed18880>'

>>> p3 
'<__main__.Person object at 0x7fad2ed18880>'

• str() 和 repr() 得到的返回值一样，看不出差别

2.2 只定义__str__() 方法

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

    def __str__(self):
        return 'This is __str__'

p1 = Person('Aaron_neil', 20)
p2 = str(p1)
p3 = repr(p1)


>>> print(p1)
This is __str__

>>> p2
'This is __str__'

>>> p3
'<__main__.Person object at 0x7f41d852e880>'

• print() 和 str() 的内置函数均会调用 __str__()
• 在只定义__str__()方法的时候，repr() 和str() 各自坚持调用自己的魔法方法

2.3 只定义__repr__()方法

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

    def __repr__(self):
        return 'This is __repr__'

p1 = Person('Aaron_neil', 20)
p2 = str(p1)
p3 = repr(p1)


>>> p1
This is __repr__

>>> p2
'This is __repr__'

>>> p3
'This is __repr__'

•   在只定义__repr__()方法的时候，print(), str() 和 repr() 均只能调用__repr__()方法

2.4 __str__() 和  __repr__() 方法全部定义

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

    def __str__(self):
        return 'This is __str__'

    def __repr__(self):
        return 'This is __repr__'

p1 = Person('Aaron_neil', 20)
p2 = str(p1)
p3 = repr(p1)

>>> print(p1)
This is __str__
>>> p2
'This is __str__'
>>> p3
'This is __repr__'

• 在__str__() 和  __repr__() 方法全部重写的时候，str() 和 repr() 各自调用自己的魔法方法

3. 总结

• str() 和 repr() 的返回值都是字符串对象
• str() 的目标是返回的字符串可读性好，repr() 的目标则是返回的字符串应该准确、无歧义
• 只有仅定义__repr__()方法的时候，print(), str(), repr() 结果全部返回调用__repr__()