Что такое декоратор @dataclass в Python?

Sobes Copilot

Получайте ответы в реальном времени

Ответ от нейросети

sobes.tech AI

@dataclass — это декоратор из модуля dataclasses, который автоматически генерирует специальные методы, такие как __init__, __repr__, __eq__ и другие, для классов, предназначенных для хранения данных. Это значительно упрощает создание классов-контейнеров для данных.

Пример:

# Без декоратора
class PointManual:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return f"PointManual(x={self.x}, y={self.y})"

    def __eq__(self, other):
        if not isinstance(other, PointManual):
            return NotImplemented
        return self.x == other.x and self.y == other.y

# С декоратором @dataclass
from dataclasses import dataclass

@dataclass
class PointData:
    x: int
    y: int

# Использование
p1_manual = PointManual(1, 2)
p2_manual = PointManual(1, 2)
print(p1_manual)        # Вывод: PointManual(x=1, y=2)
print(p1_manual == p2_manual) # Вывод: True

p1_data = PointData(1, 2)
p2_data = PointData(1, 2)
print(p1_data)          # Вывод: PointData(x=1, y=2)
print(p1_data == p2_data)   # Вывод: True

Основные преимущества:

Сокращение boilerplate-кода: Автоматическое создание стандартных методов
Читаемость: Четко видно, что класс предназначен для хранения данных
Типизация: Поддерживает аннотации типов
Настраиваемость: Позволяет включать/отключать генерацию определенных методов (init=False, repr=False и т.д.)

Недостатки (в сравнении с namedtuple):

Классы, созданные с @dataclass, мутабельны по умолчанию, если поля не объявлены как field(frozen=True).
Потребляют немного больше памяти, чем namedtuple.

Параметры декоратора @dataclass(...):

Параметр	Описание	По умолчанию
`init`	Генерировать ли метод `__init__()`.	`True`
`repr`	Генерировать ли метод `__repr__()`.	`True`
`eq`	Генерировать ли метод `__eq__()`.	`True`
`order`	Генерировать ли методы сравнения (`__lt__`, `__le__`, `__gt__`, `__ge__`).	`False`
`unsafe_hash`	Форсировать ли генерацию `__hash__()`. Используется с осторожностью.	`False`
`frozen`	Сделать ли экземпляр неизменяемым (попытки присвоения вызовут исключение).	`False`

Поля также могут быть определены с использованием функции field() из того же модуля для задания дополнительных параметров, например, значений по умолчанию, метаданных или для исключения поля из автоматически генерируемых методов.

from dataclasses import field

@dataclass
class Item:
    name: str
    price: float = field(default=0.0) # Значение по умолчанию
    quantity: int = field(default=1, init=False, repr=False) # Не включать в init и repr

@dataclass — это современный и предпочтительный способ создания простых классов для хранения данных в Python 3.7+.