如何使用print()打印类的实例?

当我试图打印一个类的实例时，我得到了这样的输出:

>>> class Test():
...     def __init__(self):
...         self.a = 'foo'
...
>>> print(Test())
<__main__.Test object at 0x7fc9a9e36d60>

我如何使它打印将显示自定义的东西(例如，包括属性值的东西)?也就是说，我如何才能定义类的实例在打印时将如何出现(他们的字符串表示)?

参见如何为类本身(而不是类的实例)选择自定义字符串表示?如果你想为类本身定义行为(在这种情况下，print(Test)显示一些自定义的东西，而不是<class __main__。测试>或类似)。(事实上，技术本质上是相同的，但应用起来更棘手。)

当前回答

正如Chris Lutz解释的那样，这是由类中的__repr__方法定义的。

来自repr()的文档:

对于许多类型，此函数尝试返回一个字符串，该字符串在传递给eval()时将产生一个具有相同值的对象，否则表示为尖括号括起来的字符串，其中包含对象类型的名称以及通常包括对象名称和地址的附加信息。类可以通过定义__repr__()方法来控制该函数为其实例返回的内容。

给定以下类Test:

class Test:
    def __init__(self, a, b):
        self.a = a
        self.b = b

    def __repr__(self):
        return f"<Test a:{self.a} b:{self.b}>"

    def __str__(self):
        return f"From str method of Test: a is {self.a}, b is {self.b}"

．．它在Python shell中的作用如下:

>>> t = Test(123, 456)
>>> t
<Test a:123 b:456>
>>> print(repr(t))
<Test a:123 b:456>
>>> print(t)
From str method of Test: a is 123, b is 456
>>> print(str(t))
From str method of Test: a is 123, b is 456

如果没有定义__str__方法，print(t)(或print(str(t)))将使用__repr__的结果

如果没有定义__repr__方法，则使用默认值，大致相当于:

def __repr__(self):
    cls = self.__class__
    return f"<{cls.__module_}.{cls.__qualname__} object at {id(self)}>"

2009-10-08 02:55:04

其他回答

对于Python 3:

如果特定的格式不重要(例如调试)，可以从下面的Printable类继承。不需要为每个对象编写代码。

受到这个答案的启发

class Printable:
    def __repr__(self):
        from pprint import pformat
        return "<" + type(self).__name__ + "> " + pformat(vars(self), indent=4, width=1)

# Example Usage
class MyClass(Printable):
    pass

my_obj = MyClass()
my_obj.msg = "Hello"
my_obj.number = "46"
print(my_obj)

2016-05-20 14:26:51

@user394430回复的更漂亮的版本

class Element:
    def __init__(self, name, symbol, number):
        self.name = name
        self.symbol = symbol
        self.number = number

    def __str__(self):
        return  str(self.__class__) + '\n'+ '\n'.join(('{} = {}'.format(item, self.__dict__[item]) for item in self.__dict__))

elem = Element('my_name', 'some_symbol', 3)
print(elem)

生成视觉上漂亮的名称和值列表。

<class '__main__.Element'>
name = my_name
symbol = some_symbol
number = 3

一个更花哨的版本(感谢Ruud)对项目进行排序:

def __str__(self):
    return  str(self.__class__) + '\n' + '\n'.join((str(item) + ' = ' + str(self.__dict__[item]) for item in sorted(self.__dict__)))

2018-03-14 15:44:48

__repr__和__str__已经在许多答案中提到。我只是想补充一点，如果你懒得把这些神奇的函数添加到你的类中，你可以使用objprint。一个简单的装饰器@add_objprint将帮助你将__str__方法添加到你的类中，你可以为实例使用print。当然，如果你愿意，你也可以使用库中的objprint函数以人类可读的格式打印任何任意对象。

from objprint import add_objprint

class Position:
    def __init__(self, x, y):
        self.x = x
        self.y = y

@add_objprint
class Player:
    def __init__(self):
        self.name = "Alice"
        self.age = 18
        self.items = ["axe", "armor"]
        self.coins = {"gold": 1, "silver": 33, "bronze": 57}
        self.position = Position(3, 5)

print(Player())

输出是这样的

<Player
  .name = 'Alice',
  .age = 18,
  .items = ['axe', 'armor'],
  .coins = {'gold': 1, 'silver': 33, 'bronze': 57},
  .position = <Position
    .x = 3,
    .y = 5
  >
>

2021-03-13 00:59:55

>>> class Test:
...     def __repr__(self):
...         return "Test()"
...     def __str__(self):
...         return "member of Test"
... 
>>> t = Test()
>>> t
Test()
>>> print(t)
member of Test

__str__方法是当你打印它时被调用的方法，而__repr__方法是当你使用repr()函数(或当你用交互式提示符查看它时)时发生的方法。

如果没有给出__str__方法，Python将打印__repr__的结果。如果你定义了__str__而不是__repr__， Python将使用上面所看到的__repr__，但仍然使用__str__进行打印。

2009-10-08 02:39:35