Чем отличаются методы __str__ и __repr__ в классе?

В Python существуют два специальных метода, которые используются для представления объектов: __str__ и __repr__. Оба метода предназначены для возвращения строкового представления объекта, но у них разные цели и области применения.

Основные отличия

Цель:

• __str__: Предназначен для создания "человеко-читаемого" представления объекта. Он используется, когда мы хотим вывести объект на экран, например, с помощью функции print().
• __repr__: Предназначен для создания "официального" или "программного" представления объекта. Этот метод должен возвращать строку, которая, по возможности, может быть использована для создания объекта с теми же параметрами (обычно через функцию eval()).

Использование:

• __str__: Вызывается, когда необходимо вывести объект в удобном для чтения формате. Например, при использовании функции print() или при вызове str() для объекта.
• __repr__: Вызывается, когда объект передается в интерактивной оболочке Python или при использовании функции repr(). Это более формальное представление.

Примеры

Рассмотрим класс Point, представляющий точку в двумерном пространстве:

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

    def __str__(self):
        return f"Point({self.x}, {self.y})"

    def __repr__(self):
        return f"Point({self.x!r}, {self.y!r})"

Примеры использования:

p = Point(1, 2)

# Использование __str__
print(p)  # Вывод: Point(1, 2)

# Использование __repr__
print(repr(p))  # Вывод: Point(1, 2)

# В интерактивной оболочке
p  # Возвращает: Point(1, 2)

Моменты для обсуждения:

• Важно отметить, что если метод __str__ не определен, Python будет использовать __repr__ в качестве резервного варианта.
• Лучше всего, если __repr__ возвращает корректную строку, которую можно использовать для создания объекта с теми же параметрами.

Практические советы

1. Ясность: Строка, возвращаемая методом __str__, должна быть понятной для конечного пользователя. Например, для точки это может быть просто координаты.
2. Обратимость: Строка, возвращаемая методом __repr__, должна быть, по возможности, валидным кодом Python.
3. Отладка: Метод __repr__ часто используется для отладки, поэтому его нужно делать как можно более информативным.

Распространенные ошибки

• Не забывать определять оба метода, если предполагается, что объект будет выводиться как для пользователя, так и для разработчика.
• Не выводить слишком много информации в __str__, чтобы не запутать пользователя.
• Не использовать eval() с __repr__, если это не безопасно, так как может привести к уязвимостям.

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