python 由自定义对象作为元素组成的列表被 print 时，__str__ 和 __repr__ 的区别（笔记）

1、引言

在尝试制作一些 demo 代码的时候，机缘巧合发现的一些关于 `__str__` 和 `__repr__` 的特殊用法。

2、正片

我写了一个类，用来存储一个数字，意在探索 sort 函数排序的时候涉及到的魔术方法。当我写好这个类之后，需要将其进行输出来检查是否创建成功以及效果如何的时候，我直接使用 print 来完成这个目的。

import random

class Num:
    def __init__(self, n):
        self.n = n

    def __str__(self):
        return str(self.n)

l = [Num(random.randint(1, 100)) for _ in range(10)]
print(l)

 由于要打印自定义对象的内容，或者说直接使用 print 打印自定义对象，我以往的知识告诉我：我需要定义一个 __str__ 魔术方法来控制当自定义对象被 print 打印的时候显示什么内容。于是就有了上面的代码，并得到了下面的输出

[<__main__.Num object at 0x03897FA0>, <__main__.Num object at 0x03BCE058>, <__main__.Num object at 0x03BCE088>, <__main__.Num object at 0x03BCE0B8>, <__main__.Num object at 0x03BCE0E8>, <__main__.Num object at 0x03BCE130>, <__main__.Num object at 0x03BCE160>, <__main__.Num object at 0x03BCE1A8>, <__main__.Num object at 0x03BCE1D8>, <__main__.Num object at 0x03BCE208>]

问题出现

很明显这不是我想要的，这样的输出意味着我的 __str__ 函数没有任何作用，这很奇怪，因为我了解的知识告诉我如果一个对象被直接 print 的时候会将 __str__ 的返回值作为对象内容输出。但是我意识到这里我是通过直接打印列表，从而显示出里面的内容，这是否意味着这种情况下不属于直接 print，而是会调用 __repr__ 函数。于是我进行了如下尝试：

小心的尝试

import random

class Num:
    def __init__(self, n):
        self.n = n

    def __str__(self):
        return str(self.n)

    def __repr__(self):
        return str(self.n)

l = [Num(random.randint(1, 100)) for _ in range(10)]
print(l)

我写了一个 __repr__ 方法，并期待它的返回值可以被正确作为结果输出，结果不出所料，果然得到了我想要的结果：

[28, 81, 52, 64, 34, 88, 4, 15, 59, 10]

 3、总结

所以我得出了一个结果，我认为，如果这个对象直接被 print 所打印，则打印的结果由 __str__ 方法进行控制，如果这个对象被 print 打印的东西所附带着显示出来，则打印的结果由 __repr__ 控制。