Dataclasses в Python: понятное руководство с примерами и лучшими практиками

Dataclasses в Python — это способ описывать данные компактно и понятно, не вручную прописывая __init__, __repr__, __eq__ и другую рутину. Для новичков и продолжающих разработчиков это один из самых полезных инструментов повседневной разработки: меньше кода — меньше ошибок и больше читаемости.

Что такое dataclasses в Python и когда их использовать

Модуль dataclasses (стандартная библиотека) позволяет объявлять классы данных с помощью декоратора @dataclass. Он автоматически генерирует конструктор, методы сравнения, человекочитаемое представление и многое другое. Используйте dataclasses в Python, когда вам нужны «контейнеры» с полями и минимальной логикой: сущности доменной модели, DTO, настройки, результаты функций и т.п.

Быстрый старт: @dataclass за 2 минуты

from dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int = 0  # значение по умолчанию

p1 = Person("Алиса", 30)
p2 = Person("Алиса", 30)
print(p1)         # Person(name='Алиса', age=30)
print(p1 == p2)   # True — сравнение по полям

Три вещи сразу готовы: конструктор, repr и равенство по значению полей. Без шаблонного кода!

field и default_factory: аккуратно с изменяемыми значениями

Частая ошибка — использовать изменяемое значение по умолчанию (например, список). Делать так нельзя: все экземпляры будут делить один и тот же объект. Правильно — применить default_factory через field.

from dataclasses import dataclass, field
from typing import List

@dataclass
class Order:
    customer: str
    items: List[str] = field(default_factory=list)

    def add_item(self, name: str) -> None:
        self.items.append(name)

order = Order("Иван")
order.add_item("Кофе")
print(order.items)  # ['Кофе']

Запомнить правило просто: для списков, словарей, множеств и других изменяемых структур используйте default_factory.

Иммутабельность: frozen=True и hash

Иногда объекты должны быть неизменяемыми (например, ключи словаря). Поможет параметр frozen=True: попытка изменить поле вызовет ошибку, а сам объект можно безопасно использовать в set и как ключ dict (если все поля хешируемые).

from dataclasses import dataclass

@dataclass(frozen=True)
class Product:
    sku: str
    price: float

p = Product("A-001", 9.99)
# p.price = 10.99  # dataclasses.FrozenInstanceError
s = {p}
print(p in s)  # True

По умолчанию при frozen=True и eq=True хеш корректно генерируется, так что объект готов к использованию в хеш-коллекциях.

Сравнение и сортировка: order, compare=False

Если нужно сравнивать экземпляры по порядку (, =), включите order=True. Иногда полезно исключить поле из сравнения — например, метку времени. Для этого используйте compare=False в field.

from dataclasses import dataclass, field
from time import time

@dataclass(order=True)
class Score:
    points: int
    created_at: float = field(default_factory=time, compare=False)

s1 = Score(10)
s2 = Score(20)
print(s1 < s2)  # True — сравнение только по points

Инициализация после конструктора: __post_init__

Иногда нужно «досчитать» поле после автогенерированного __init__. Используйте метод __post_init__. Поля, которые не должны задаваться из конструктора, объявляйте с init=False.

from dataclasses import dataclass, field

@dataclass
class Article:
    title: str
    slug: str = field(init=False)

    def __post_init__(self):
        self.slug = (
            self.title.strip().lower()
            .replace(" ", "-")
            .replace("—", "-")
        )

a = Article("Dataclasses в Python — кратко")
print(a.slug)  # dataclasses-v-python-—-kratko -> после предобработки

asdict, astuple, replace и metadata

Для преобразования экземпляров удобно использовать утилиты из модуля dataclasses:

from dataclasses import dataclass, asdict, astuple, replace, field

@dataclass
class Config:
    host: str
    port: int
    # можно хранить произвольные метаданные о поле
    env: str = field(default="dev", metadata={"allowed": ["dev", "prod"]})

cfg = Config("localhost", 8000)
print(asdict(cfg))       # {'host': 'localhost', 'port': 8000, 'env': 'dev'}
print(astuple(cfg))      # ('localhost', 8000, 'dev')
cfg2 = replace(cfg, port=8001)
print(cfg2)              # Config(host='localhost', port=8001, env='dev')
print(cfg.__dataclass_fields__["env"].metadata)

metadata удобно использовать для валидации, генерации форм или автодокументации — храните подсказки рядом с полями.

Методы в dataclasses — это нормально

Датаклассы — не только «мешки с данными». Вы можете добавлять методы, инкапсулировать простую бизнес-логику и следить за инвариантами.

from dataclasses import dataclass, field
from typing import List

@dataclass
class Cart:
    items: List[tuple[str, float]] = field(default_factory=list)

    def add(self, name: str, price: float) -> None:
        if price < 0:
            raise ValueError("Цена не может быть отрицательной")
        self.items.append((name, price))

    def total(self) -> float:
        return round(sum(p for _, p in self.items), 2)

cart = Cart()
cart.add("Кофе", 3.5)
cart.add("Батончик", 1.2)
print(cart.total())  # 4.7

Частые ошибки и лучшие практики

Короткое резюме

Dataclasses в Python упрощают жизнь: меньше кода, больше структуры. Они отлично подходят для моделей данных, настроек и транспортных объектов. Освоив @dataclass, field, default_factory, frozen, order, asdict/astuple и replace, вы закроете 90% повседневных сценариев.

Хотите быстро и системно прокачаться в Python с практикой и разбором реальных задач? Загляните в курс: Пойти на мощный практический курс «Python с Нуля до Гуру» →

Источник