Как распечатать объекты класса, используя print ()? - PullRequest
449 голосов
/ 08 октября 2009

Я изучаю веревки в Python. Когда я пытаюсь напечатать объект класса Foobar с помощью функции print(), я получаю вывод, подобный этому:

<__main__.Foobar instance at 0x7ff2a18c>

Есть ли способ, которым я могу установить поведение печати (или строковое представление ) класса и его объектов ? Например, когда я вызываю print() для объекта класса, я хотел бы напечатать его элементы данных в определенном формате. Как этого добиться в Python?

Если вы знакомы с классами C ++, вышеприведенного можно достичь для стандартного ostream, добавив метод friend ostream& operator << (ostream&, const Foobar&) для класса.

Ответы [ 10 ]

523 голосов
/ 08 октября 2009
>>> 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() (или когда вы смотрите на нее с помощью интерактивного приглашения). ). Если это не самый Pythonic метод, я прошу прощения, потому что я все еще учусь - но он работает.

Если метод __str__ не указан, Python вместо этого выведет результат __repr__. Если вы определите __str__, но не __repr__, Python будет использовать то, что вы видите выше, как __repr__, но по-прежнему будет использовать __str__ для печати. ​​

117 голосов
/ 08 октября 2009

Как сказал Крис Латс , это определяется методом __repr__ в вашем классе.

Из документации repr():

Для многих типов эта функция пытается вернуть строку, которая выдаст объект с тем же значением при передаче в eval(), в противном случае представление представляет собой строку, заключенную в угловые скобки, которая содержит имя типа объект вместе с дополнительной информацией, часто включая имя и адрес объекта. Класс может управлять тем, что эта функция возвращает для своих экземпляров, определяя метод __repr__().

Дан следующий класс теста:

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

    def __repr__(self):
        return "<Test a:%s b:%s>" % (self.a, self.b)

    def __str__(self):
        return "From str method of Test: a is %s, b is %s" % (self.a, self.b)

.. в Python будет действовать следующим образом:

>>> 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):
    return "<%s instance at %s>" % (self.__class__.__name__, id(self))
41 голосов
/ 17 сентября 2015

Общий способ, который можно применить к любому классу без специального форматирования, можно сделать следующим образом:

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}
13 голосов
/ 20 декабря 2012

Просто добавьте мои два цента к ответу @ 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")

Но, как я уже сказал в своем последнем комментарии: больше информации просто здесь !

12 голосов
/ 16 января 2013

Вам нужно использовать __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
10 голосов
/ 26 октября 2018

Если вы находитесь в ситуации, подобной @ Кит , вы можете попробовать:

print a.__dict__

Это идет вразрез с тем, что я считаю хорошим стилем, но если вы просто пытаетесь отлаживать, тогда он должен делать то, что вы хотите.

7 голосов
/ 14 марта 2018

Более симпатичная версия ответа @ 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

Еще более привлекательная версия (спасибо Рууду) сортирует предметы:

def __str__(self):
    return  str(self.__class__) + '\n' + '\n'.join((str(item) + ' = ' + str(self.__dict__[item]) for item in sorted(self.__dict__)))
7 голосов
/ 20 мая 2016

Для 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)
1 голос
/ 11 ноября 2017

просто используйте "__ str __" специальный метод внутри вашего класса. Например,

класс Адипрограммист:

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

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

yash = Адипрограммист («Аадитя»)

печать (Яши)

1 голос
/ 04 августа 2015

В этой ветке уже есть много ответов, но ни один из них мне особо не помог, мне пришлось самому заняться, поэтому я надеюсь, что этот ответ будет немного более информативным.

Вы просто должны убедиться, что у вас есть скобки в конце вашего класса, например:

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

Чтобы напечатать мой класс Водорода, я использовал следующее:

print(Hydrogen())

Обратите внимание, что это не будет работать без скобок в конце Водорода. Они необходимы.

Надеюсь, это поможет, дайте мне знать, если у вас есть еще вопросы.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...