如何使用 print() 打印 class 的实例？

Question

当我尝试print class 的实例时，我得到一个 output，如下所示：

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

如何定义 class 及其实例的打印行为（或字符串表示形式）？ 例如，参考上面的代码，如何修改Test class 以便print实例显示a值？

Answer 1

>>> 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__进行打印。

Answer 2

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

从repr()的文档中：

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

给定以下类测试：

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)}>"

Answer 3

可以在没有特定格式的情况下应用于任何类的通用方法可以如下完成：

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

    def __str__(self):
        return str(self.__class__) + ": " + str(self.__dict__)

接着，

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

生产

__main__.Element: {'symbol': 'some_symbol', 'name': 'my_name', 'number': 3}

Answer 4

如果您处于@Keith 之类的情况，您可以尝试：

print(a.__dict__)

它违背了我认为好的风格，但如果你只是想调试，那么它应该做你想做的事。

Answer 5

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

Answer 6

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

Answer 7

只是将我的两分钱添加到@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")

但是，正如我在上一条评论中所说：更多信息就在这里！

Answer 8

简单的。 在打印中，执行：

print(foobar.__dict__)

只要构造函数是

__init__

Answer 9

您需要使用__repr__ 。 这是一个像__init__这样的标准函数。 例如：

class Foobar():
    """This will create Foobar type object."""

    def __init__(self):
        print "Foobar object is created."

    def __repr__(self):
        return "Type what do you want to see here."

a = Foobar()

print a

Answer 10

许多答案中已经提到了__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
  >
>

Answer 11

该线程中已经有很多答案，但没有一个对我有特别帮助，我必须自己解决，所以我希望这个答案能提供更多信息。

您只需要确保在课程结束时有括号，例如：

print(class())

这是我正在处理的项目中的代码示例：

class Element:
    def __init__(self, name, symbol, number):
        self.name = name
        self.symbol = symbol
        self.number = number
    def __str__(self):
        return "{}: {}\nAtomic Number: {}\n".format(self.name, self.symbol, self.number

class Hydrogen(Element):
    def __init__(self):
        super().__init__(name = "Hydrogen", symbol = "H", number = "1")

为了打印我的 Hydrogen 课程，我使用了以下内容：

print(Hydrogen())

请注意，如果没有 Hydrogen 末尾的括号，这将不起作用。 它们是必要的。

希望这会有所帮助，如果您还有问题，请告诉我。

Answer 12

只需在您的类中使用“ __str__”特殊方法。 对于前。

Adiprogrammer类：

def __init__(self, name):
    self.company_name = name

def __str__(self):
    return "I am the Founder of Adiprogrammer!"

yash = Adiprogrammer（“ Aaditya”）

打印（yash）

Answer 13

尽管这是一篇较早的文章，但在数据类中也引入了一种非常方便的方法（从Python 3.7 开始）。 除了__eq__和__hash__等其他特殊功能外，它还为 class 属性提供了一个__repr__ function。 您的示例将是：

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')