Что такое dataclass и когда его использовать?

Что такое dataclass и когда его использовать?

Dataclass - встроенный инструмент Python (с 3.7+) для автоматического создания классов с методами init, repr, eq. Это мощный инструмент для работы с данными.

Основная идея

from dataclasses import dataclass

# Старый способ
class User:
    def __init__(self, name: str, email: str, age: int):
        self.name = name
        self.email = email
        self.age = age
    
    def __repr__(self):
        return f"User({self.name}, {self.email}, {self.age})"

# Новый способ - одна строка
@dataclass
class User:
    name: str
    email: str
    age: int

user = User("John", "john@test.com", 30)
print(user)  # User(name='John', email='john@test.com', age=30)

Основные возможности

1. Default значения

@dataclass
class User:
    name: str
    email: str
    age: int = 0
    is_active: bool = True

user = User("John", "john@test.com")
# age=0, is_active=True автоматически

2. Immutable dataclass (frozen)

@dataclass(frozen=True)
class Point:
    x: float
    y: float

p = Point(1.0, 2.0)
p.x = 3.0  # FrozenInstanceError!

# Теперь можно использовать как dict ключ
points = {Point(0,0): "origin"}

3. Post-init обработка

@dataclass
class Order:
    quantity: int
    price: float
    total: float = None
    
    def __post_init__(self):
        if self.total is None:
            self.total = self.quantity * self.price

order = Order(5, 10.0)
print(order.total)  # 50.0

4. Field параметры

from dataclasses import dataclass, field

@dataclass
class Team:
    name: str
    # default_factory для списков
    members: list = field(default_factory=list)
    # repr=False для скрытия в выводе
    password: str = field(default="", repr=False)
    # compare=False для исключения из сравнения
    internal_id: str = field(default="", compare=False)

team = Team("Python")
# team.members = [], password скрыт в repr

Когда использовать dataclass?

✅ Используй для:

1. DTO (Data Transfer Objects)

@dataclass
class UserDTO:
    id: int
    name: str
    email: str

@dataclass
class CreateUserRequest:
    name: str
    email: str
    password: str

def create_user(request: CreateUserRequest) -> UserDTO:
    return UserDTO(id=1, name=request.name, email=request.email)

2. Конфигурационные объекты

@dataclass
class Config:
    database_host: str = "localhost"
    database_port: int = 5432
    debug: bool = False
    timeout: int = 30

config = Config(database_host="prod.example.com")

3. Results функций (вместо tuple/dict)

@dataclass
class SearchResult:
    items: list
    total: int
    page: int
    limit: int = 20

def search(query: str) -> SearchResult:
    return SearchResult(
        items=[...],
        total=1000,
        page=1
    )

4. Event объекты (Domain-Driven Design)

@dataclass(frozen=True)
class UserCreatedEvent:
    user_id: int
    email: str
    timestamp: datetime

@dataclass(frozen=True)
class UserEmailChangedEvent:
    user_id: int
    old_email: str
    new_email: str

Когда НЕ использовать

❌ Избегай dataclass для:

1. Сложная бизнес-логика (используй обычный класс)

# Плохо
@dataclass
class User:
    name: str
    email: str
    
    def authenticate(self, password: str):
        # Много логики...
        pass

# Хорошо: отделить DTO от Entity
@dataclass
class UserDTO:
    id: int
    name: str
    email: str

class User(Entity):  # Domain Entity с логикой
    def authenticate(self, password: str) -> bool:
        pass

2. Валидация (используй Pydantic)

# Dataclass не валидирует
@dataclass
class User:
    email: str
    age: int

user = User(email="invalid", age=-5)  # OK!

# Pydantic валидирует
from pydantic import BaseModel, EmailStr, Field

class User(BaseModel):
    email: EmailStr
    age: int = Field(ge=0, le=150)

user = User(email="invalid", age=-5)  # ValidationError!

Dataclass vs Альтернативы

Практический пример

from dataclasses import dataclass, field
from datetime import datetime
from typing import List, Optional

# API Request
@dataclass
class CreateProductRequest:
    name: str
    description: str
    price: float
    category: str

# API Response
@dataclass
class ProductDTO:
    id: int
    name: str
    description: str
    price: float
    category: str
    created_at: datetime
    updated_at: datetime

# Event (immutable)
@dataclass(frozen=True)
class ProductCreatedEvent:
    product_id: int
    name: str
    price: float
    timestamp: datetime = field(default_factory=datetime.now)

# Config
@dataclass
class AppConfig:
    api_host: str = "localhost"
    api_port: int = 8000
    debug: bool = False
    allowed_categories: List[str] = field(default_factory=lambda: [])

# Use case
def create_product(request: CreateProductRequest) -> ProductDTO:
    # Бизнес-логика
    product = Product.create(
        name=request.name,
        description=request.description,
        price=request.price,
        category=request.category
    )
    
    # Возвращаем DTO
    return ProductDTO(
        id=product.id,
        name=product.name,
        description=product.description,
        price=product.price,
        category=product.category,
        created_at=product.created_at,
        updated_at=product.updated_at
    )

Вывод

Dataclass - отличный выбор для:

✅ DTO и передачи данных между слоями ✅ Конфигурационные объекты ✅ Value Objects (immutable with frozen=True) ✅ Event объекты в DDD ✅ Результаты функций с несколькими значениями

Это замена для наивного написания init, repr, eq. Но это НЕ замена для:

❌ Классов с бизнес-логикой (используй обычные классы) ❌ Валидации (используй Pydantic) ❌ Сложного наследования

Правило: если класс только хранит данные - dataclass. Если нужна логика - обычный класс.