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

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

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


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


当前回答

对于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)

其他回答

对于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)

简单。在打印时,请:

print(foobar.__dict__)

只要构造函数是

__init__

__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
  >
>

尽管这是一篇较老的文章,但在数据类中也引入了一个非常方便的方法(从Python 3.7开始)。除了其他特殊函数,如__eq__和__hash__,它还为类属性提供了__repr__函数。你的例子是:

from dataclasses import dataclass, field
@dataclass
class Test:
    a: str = field(default="foo")
    b: str = field(default="bar")

t = Test()
print(t) 
# prints Test(a='foo', b='bar')

如果你想隐藏某个属性不被输出,你可以将字段装饰器参数repr设置为False:

@dataclass
class Test:
    a: str = field(default="foo")
    b: str = field(default="bar", repr=False)

t = Test()
print(t) 
# prints Test(a='foo')

只是对@dbr的回答补充我的意见,以下是如何从他引用的官方文件中实现这句话的例子:

“[…]返回一个字符串,当传递给eval()时,该字符串将产生一个具有相同值的对象,[…]"

给出这个类定义:

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

    def __str__(self):
        return "An instance of class Test with state: a=%s b=%s" % (self._a, self._b)

    def __repr__(self):
        return 'Test("%s","%s")' % (self._a, self._b)

现在,很容易序列化Test类的实例:

x = Test('hello', 'world')
print 'Human readable: ', str(x)
print 'Object representation: ', repr(x)
print

y = eval(repr(x))
print 'Human readable: ', str(y)
print 'Object representation: ', repr(y)
print

因此,运行最后一段代码,我们将得到:

Human readable:  An instance of class Test with state: a=hello b=world
Object representation:  Test("hello","world")

Human readable:  An instance of class Test with state: a=hello b=world
Object representation:  Test("hello","world")

但是,正如我在上一条评论中所说的:更多信息就在这里!