Рубріки: Основи

Data classes в Python: де варто застосовувати декоратор dataclass

Дмитро Сімагін

12.10.2024 11:46

Python відомий тим, що це мова програмування з підтримкою об’єктно-орієнтованих парадигм, де класи є одним з основних інструментів для роботи з даними та функціоналом. Але в реальній роботі часто доводиться писати звичайний клас, завданням якого має бути лише зберігання даних, без будь-якої премудрої логіки. Щоб уникнути шаблонності в коді та скоротити випадки дублювання, у версії 3.7 мові Python з’явилася нова можливість – Data Classes.

Для чого потрібні Data Classes?

До появи Data Classes кодерам доводилося вручну описувати прості класи Python для представлення сутностей з кількома атрибутами. Наприклад:

class Person:
   def __init__(self, name: str, age: int):
     self.name = name
     self.age = age

   def __repr__(self):
     return f"Person(name={self.name}, age={self.age})"

У цьому фрагменті ми вручну створюємо конструктор і метод для рядкового представлення об’єкта. Але при додаванні нових атрибутів або методів код швидко розростається, стаючи менш зручним та підтримуваним. Data Classes автоматизують цей процес.

Основні переваги Data Classes

Менше шаблонного коду: Базові методи, такі як __init__(), __repr__() та __eq__(), генеруються автоматично.
Простота коду: Створення класів стає більш читабельним і менш громіздким.
Автоматичне створення методів порівняння: Data Classes самі створюють методи для порівняння екземплярів класів, виходячи зі значення їх атрибутів.
Легке налаштування: Data Classes підтримують налаштування через параметри, такі як frozen і order, що дозволяє створити незмінні чи впорядковані об’єкти.
Типізація: Data Classes відмінно працюють з інструкціями типів, що сприяє більшій безпеці коду.

Як працюють Data Classes?

Щоб створити Data Class, потрібно вказати декоратор @dataclass з модуля dataclasses. Розглянемо простий приклад:

від dataclasses import dataclass

@dataclass
class Point:
   x: int
   y: int

У цьому фрагменті Point є класом, що містить атрибути x та y. Завдяки декоратору @dataclass, Python самостійно створює конструктор __init__(), метод __repr__() та інші корисні методи.

Тепер можна створити об’єкт цього класу:

point = Point(10, 20)
print(point) # Output: Point(x=10, y=20)

Можливості Data Classes

Конструктор init()

Декоратор @dataclass автоматично створює метод __init__(), який ініціалізує атрибути об’єкта:

@dataclass
class Person:
   name: str
   age: int

p = Person("Laura", 20)
print(p) # Output: Person(name='Laura', age=20)

Метод repr()

Data Classes самі генерують рядкове представлення для екземплярів класу, що дуже корисно при налагодженні:

print(repr(p)) # Output: Person(name='Laura', age=20)

Методи порівняння

Data Classes генерують метод __eq__(), який може порівняти об’єкти між собою виходячи з їхніх атрибутів. Ось один приклад:

p1 = Person("Laura", 20)
p2 = Person("Laura", 20)
print(p1 == p2) # Output: True

Оскільки обидва об’єкти мають однакові значення атрибутів, вони вважаються рівними.

Незмінні Data Classes

Об’єкти, створені за допомогою Data Classes, вважаються мутабельними (змінними) за замовчанням. Але ви можете створити незмінний клас, якщо встановите параметр frozen=True. Тепер, якщо хтось спробує змінити атрибут після створення об’єкта, з’явиться помилка:

@dataclass(frozen=True)
class ImmutablePoint:
   x: int
   y: int

point = ImmutablePoint(1, 2)
# point.x = 10  # Помилка: Cannot assign to field 'x'

Упорядковані Data Classes

Data Classes здатні автоматично створювати методи порівняння (__lt__(), __le__(), __gt__(), і __ge__()), якщо буде вказано параметр order=True:

@dataclass(order=True)
class Item:
   name: str
   price: float

item1 = Item("Apple", 1.0)
item2 = Item("Banana", 2.0)

print(item1 < item2) # Output: True

Використання такого параметра стане в нагоді, коли потрібно порівняти та сортувати об’єкти класу.

Параметри та налаштування Data Classes

Data Classes підтримує кілька корисних параметрів, які можуть передаватися в декоратор @dataclass:

1. init=False: Якщо ви не хочете, щоб для якогось поля автоматично створювався конструктор, його можна вимкнути. Розглянемо наступний код:

@dataclass
class Product:
    name: str
    price: float = 0.0
    in_stock: bool = False
    discount: float = field(init=False, default=0.1)

У цьому фрагменті для атрибута конструктор автоматично не згенерується.

2. repr=False: Ця властивість виключає поле з рядкового представлення об’єкта:

@dataclass
class PrivateData:
    id: int
    secret: str = field (repr = False)

pd = PrivateData(1, "top_secret")
print(pd) # Output: PrivateData(id=1)

3. default_factory: Дає можливість задавати значення за замовчуванням за допомогою функції:

from typing import List

@dataclass
class DataContainer:
    items: List[int] = field(default_factory=list)

container = DataContainer()
print(container.items) # Output: []

Наслідування Data Classes

Data Classes допускає наслідування. Тому ви можете розширювати класи, додавати нові атрибути або методи. Однак, якщо ви успадкуєте від іншого класу з @dataclass, потрібно враховувати порядок ініціалізації:

@dataclass
class Employee(Person):
employee_id: int

e = Employee("Bob", 25, 1234)
print(e) # Output: Employee(name='Bob', age=25, employee_id=1234)

Тут клас Employee отримує наслідування від Person та додає нове поле employee_id.

Порівняння з іншими способами

Data Classes часто порівнюються з іншими способами роботи з даними Python, такими як іменовані кортежі (namedtuple) і словники. Розглянемо коротке порівняння:

namedtuple:

Підходить для незмінних об’єктів.
Менш гнучкий у налаштуванні.
Поступається Data Classes у плані розширюваності та типізації.

словники:

Підходять для динамічних та змінюваних даних.
Не забезпечують чітку структуру та типізацію.
Менш зручні порівняння об’єктів.

Data Classes забезпечують баланс між простотою і гнучкістю, роблячи їх кращими для структурованих даних.

Коли від використання Data Classes у Python краще відмовитись

Незважаючи на цілу низку очевидних переваг Data Classes у Python, можуть виникнути ситуації, коли їх використання не зовсім підходить. Ось кілька випадків, коли краще не застосовувати Data Classes:

Складна логіка у конструкторі. Data Classes ідеальні для простих класів, які призначені для зберігання даних та автоматичної генерації методів типу __init__(). Але якщо вам потрібно реалізувати складнішу логіку в конструкторі, то Data Classes тут не найкращий помічник.
Контроль за мутаціями. Якщо вам потрібні об’єкти зі зміною даних, варто використовувати звичайні, а не Data-класи, та прописувати методи вручну.
Наслідування та складні ієрархії класів. Тут у Data Classes можуть виникнути проблеми з правильною реалізацією. Якщо в класах є глибока ієрархія, Data Classes тільки все ускладнить, тому що автоматична генерація методів не дуже коректно працює з успадкуванням.
Робота із динамічними атрибутами. Якщо виникає потреба динамічно додавати або змінювати атрибути об’єктів, Data Classes будуть не найкращим вибором. Все тому, що Data Classes припускають фіксований набір полів, оголошених на етапі створення класу.
Особливі вимоги до серіалізації та десеріалізації. Хоча Data Classes допускають серіалізацію за допомогою бібліотек, таких як json або pickle, зазвичай вони менш гнучкі в порівнянні зі звичайним класом. Це особливо помітно, коли об’єкти потребують складних механізмів серіалізації/десеріалізації.
Високі вимоги до продуктивності. Data Classes створені для покращення читання коду. Але якщо ви працюєте над проектом, де важлива максимальна продуктивність, краще уникайте їх.
Необхідність гнучких перевірок доступу до атрибутів. У разі потреби додаткових перевірок при доступі до атрибутів (наприклад, при валідації даних або обчисленні значень у режимі реального часу), Data Classes не мають зручного для цього механізму. У звичайних класах можна використовувати властивості (@property), а Data Classes це робить код громіздким.

Висновок

Data Classes — це потужний спосіб роботи з класами, які використовуються для зберігання даних. Вони значно спрощують написання коду, скорочуючи число шаблонних методів, підвищуючи читаність і продуктивність. Data Classes особливо корисні, коли вам потрібні зручні та легко настроювані структури даних з підтримкою методів порівняння та відображення. З іншого боку, у них є свої обмеження: вони не підтримують складну логіку в конструкторі і високу продуктивність.