python魔法方法中的str和repr使用和区别

很多时候我们自己编写一个类，在将它的实例在终端上打印或查看的时候，我们往往会看到一个不太满意的结果。所以，我们可能会手动打印对象的一些属性或者是在类里自己实现一个方法来返回我们需要的信息。

使用__str__方法实现类到字符串的转化

class Car:
    def __init__(self, color):
        self.color = color
    def  __str__(self):
        return f'a {self.color} car'

my_car = Car('red')
print(my_car)
my_car
str(my_car)
'{}'.format(my_car)

输出结果

a red car
<__main__.Car object at 0x000001BEDBDDEC18>
'a red car'
'a red car'

有了 str 这个方法，你就不用手动去打印对象的一些信息或者添加额外的方法去达到目的。类到字符串的转化使用 str 这种 Pythonic 的方式实现即可。

使用__repr__实现类到字符串的转化

__repr__的工作方式与__str__类似，但是它被调用的时机不同。

class Car:
    def __init__(self, color):
        self.color = color
    def  __str__(self):
        return '__str__ for car'
    def __repr__(self):
        return '__repr__ for car'

my_car = Car('red')
print(my_car)
'{}'.format(my_car)
my_car

输出结果

__str__ for car
'__str__ for car'
__repr__ for car

从这个操作我们可以看出什么时候调用str什么时候调用repr。
另外，列表以及字典等容器总是会使用 repr 方法。即使你显式的调用 str 方法，也是如此。

__str__和__repr__的差别

import datetime
today = datetime.date.today()
today
str(today)
repr(today)

输出结果

datetime.date(2020, 4, 22)
'2020-04-22'
'datetime.date(2020, 4, 22)'

因此，我们有个初步的答案。
__str__的返回结果可读性强。__str__的意义是得到便于人们阅读的信息。
__repr__的返回结果应更准确。__repr__存在的目的在于调试，便于开发者使用，将__repr__返回的方式直接复制到命令行上，是可以直接执行的。

由上我们可以总结出使用__str__和__repr__方法定义类到字符串的转化方式，而不需要手动打印某些属性或是添加额外的方法。__str__的返回结果在于强可读性，而__repr__的返回结果在于准确性。我们至少需要添加一个__repr__方法来保证类到字符串的自定义转化的有效性，__str__是可选的。因为默认情况下，在需要却找不到__str__方法的时候，会自动调用 __repr__方法。