使用 __str__ 表示来打印容器中的对象

Question

我注意到，当具有重载 __str__ 方法的实例作为参数传递给 print 函数时，它会按预期打印。但是，当将包含这些实例之一的容器传递给 print 时，它会使用 __repr__ 方法。也就是说，print(x)显示了x的正确字符串表示，并且print(x, y)工作正常，但是< code>print([x]) 或 print((x, y)) 会打印 __repr__ 表示形式。

首先，为什么会发生这种情况？其次，在这种情况下有没有办法纠正 print 的行为？

Answer 1

使用对象的 __str__ 的容器的问题是完全不明确的——比如说，如果 print L 显示 [1, 2]，这意味着什么？ L 可以是 ['1, 2'] （单个项目列表，其字符串项目包含逗号）或四个 2 项目列表中的任何一个（因为每个项目都可以是字符串或整数）。当然，类型的歧义对于 print 来说很常见，但是项目数量的总歧义（因为每个逗号可能分隔项目或部分）字符串项目）是决定性的考虑因素。

Answer 2

我不确定为什么列表的__str__方法返回其中包含的对象的__repr__ - 所以我查了一下：< a href="http://mail.python.org/pipermail/python-3000/2008-May/013876.html" rel="noreferrer">[Python-3000] PEP: str(container) 应该调用 str(item )，而不是 repr(item)

论证：

-- 容器拒绝猜测用户想在 str(container) 上看到什么 - 周围环境、分隔符等；

-- repr(item) 通常显示类型信息 - 字符串、类名等周围的撇号。

因此更清楚列表中到底是什么（因为对象的字符串表示形式可能包含逗号等）。根据 Guido "BDFL" van Rossum 的说法，这种行为不会消失：

让我为大家节省很多
时间并说我反对这个
改变，并且我相信它
会造成太多的干扰
在接近测试版的情况下被接受。

---

现在，有两种方法可以解决您的代码的此问题。

第一个是子类 list 并实现您自己的 __str__ 方法。

class StrList(list):
    def __str__(self):
        string = "["
        for index, item in enumerate(self):
            string += str(item)
            if index != len(self)-1:
                string += ", "
        return string + "]"

class myClass(object):
    def __str__(self):
        return "myClass"

    def __repr__(self):
        return object.__repr__(self)

现在来测试一下：

>>> objects = [myClass() for _ in xrange(10)]
>>> print objects
[<__main__.myClass object at 0x02880DB0>, #...
>>> objects = StrList(objects)
>>> print objects
[myClass, myClass, myClass #...
>>> import random
>>> sample = random.sample(objects, 4)
>>> print sample
[<__main__.myClass object at 0x02880F10>, ...

我个人认为这是一个糟糕的主意。某些函数 - 例如 random.sample，如演示的那样 - 实际上返回 list 对象 - 即使您对列表进行了子类化。因此，如果您采用此路线，可能会有大量 result = strList(function(mylist)) 调用，这可能会导致效率低下。这也是一个坏主意，因为这样您可能有一半的代码使用常规 list 对象，因为您不打印它们，而另一半则使用 strList 对象，这可能会导致您的代码变得更加混乱和混乱。尽管如此，选项仍然存在，并且这是让 print 函数（或语句，对于 2.x）按照您希望的方式运行的唯一方法。

另一个解决方案是编写您自己的函数 strList() ，它以您想要的方式返回字符串：

def strList(theList):
    string = "["
    for index, item in enumerate(theList):
        string += str(item)
        if index != len(theList)-1:
            string += ", "
    return string + "]"

>>> mylist = [myClass() for _ in xrange(10)]
>>> print strList(mylist)
[myClass, myClass, myClass #...

不幸的是，这两种解决方案都要求您重构现有代码 - 但 str(容器） 将会继续存在。

Answer 3

因为当你打印列表时，通常你是从程序员的角度来看，或者是调试。如果您打算显示列表，则需要以有意义的方式处理其项目，因此使用 repr。

如果您希望在容器中打印对象，请定义 repr

class MyObject:
    def __str__(self): return ""

    __repr__ = __str__

当然，repr 应该返回一个字符串，该字符串可用作重新创建对象的代码，但您可以执行您想要的操作。