После этого урока ты сможешь:

• Настраивать понятный человеку текст объекта с помощью __str__.
• Понимать разницу между __str__ и ориентированным на разработчика методом __repr__.
• Объявлять простые классы для хранения данных с помощью @dataclass и типизированных полей.
• Полагаться на сгенерированную dataclass инициализацию и сравнение по значениям.

В Python методы с именами вроде __str__ и __repr__ называют специальными методами (dunder methods, от double underscore). Функции str(obj) и print(obj) используют __str__, если он определен. Метод repr(obj) помогает разработчикам инспектировать объект; по умолчанию Python может показывать общее представление с именем класса и адресом в памяти.

Для классов, ориентированных на хранение данных, декоратор @dataclass из модуля dataclasses автоматически создает стандартные методы на основе объявленных полей с аннотациями типов. Это включает инициализатор, полезное строковое представление и сравнение по значениям (==). Аннотации типов описывают поля; они не выполняют автоматическую валидацию типов во время выполнения.

Ты по-прежнему можешь определить собственный __str__ в dataclass для управления отображением, сохраняя сгенерированные инициализатор и равенство. Отдавай предпочтение dataclasses для простых структурированных записей; сохраняй сложную логику внутри обычных классов, когда это добавляет ясности.

1. Предоставление понятного __str__

class Server:
    def __init__(self, name, region):
        self.name = name
        self.region = region

    def __str__(self):
        return f"{self.name}@{self.region}"

print(Server("worker", "eu"))

Вывод:

worker@eu

__str__ должен возвращать строку, а не выводить ее на экран.

2. Сравнение понятного представления и представления для разработчика

Этот класс определяет оба представления для разной аудитории.

class Build:
    def __init__(self, number):
        self.number = number

    def __str__(self):
        return f"Build #{self.number}"

    def __repr__(self):
        return f"Build(number={self.number})"

build = Build(9)
print(str(build))
print(repr(build))

Вывод:

Build #9
Build(number=9)

3. Создание инициализатора с помощью @dataclass

from dataclasses import dataclass

@dataclass
class Job:
    name: str
    retries: int

job = Job("backup", 2)
print(job.name)
print(repr(job))

Вывод:

backup
Job(name='backup', retries=2)

Поля автоматически становятся параметрами конструктора.

4. Сравнение значений dataclass

Два разных экземпляра могут представлять равные данные.

from dataclasses import dataclass

@dataclass
class Version:
    component: str
    major: int

first = Version("api", 2)
second = Version("api", 2)
print(first == second)
print(first is second)

Вывод:

True
False

1. Возврат числа или None из __str__; Python требует строку.
2. Использование is для сравнения независимых записей данных по значению.
3. Мысль о том, что аннотации типов в dataclass автоматически проверяют типы в рантайме.
4. Предположение, что @dataclass запрещает писать собственные методы; ты по-прежнему можешь добавлять нужное поведение.