dataclasses.md
1> **Источник:** https://python-all.ru/3.11/library/dataclasses.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `dataclasses` – Классы данных89**Исходный код:** [Lib/dataclasses.py](https://python-all.ru/src/3.11/Lib/dataclasses.py)1011---1213Этот модуль предоставляет декоратор и функции для автоматического добавления генерируемых [специальных методов](https://python-all.ru/3.11/glossary.html#term-special-method), таких как [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) и [`__repr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__repr__), в пользовательские классы. Изначально он описан в [**PEP 557**](https://python-all.ru/3.11/library/dataclasses.html).1415Переменные-члены, используемые в этих сгенерированных методах, определяются с помощью аннотаций типов [**PEP 526**](https://python-all.ru/3.11/library/dataclasses.html). Например, следующий код:1617```python18from dataclasses import dataclass1920@dataclass21class InventoryItem:22 """Класс для отслеживания предмета в инвентаре."""23 name: str24 unit_price: float25 quantity_on_hand: int = 02627 def total_cost(self) -> float:28 return self.unit_price * self.quantity_on_hand29```3031добавит, среди прочего, метод `__init__()`, который будет выглядеть так:3233```python34def __init__(self, name: str, unit_price: float, quantity_on_hand: int = 0):35 self.name = name36 self.unit_price = unit_price37 self.quantity_on_hand = quantity_on_hand38```3940Обратите внимание, что этот метод добавляется в класс автоматически: он не указан явно в определении `InventoryItem`, показанном выше.4142Добавлено в версии 3.7.4344## Содержимое модуля4546#### `@dataclasses.dataclass(*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False)`4748Эта функция – [декоратор](https://python-all.ru/3.11/glossary.html#term-decorator), который используется для добавления в классы сгенерированных [специальных методов](https://python-all.ru/3.11/glossary.html#term-special-method), как описано ниже.4950Декоратор `@dataclass` просматривает класс в поисках `field`. `field` определяется как переменная класса, имеющая [аннотацию типа](https://python-all.ru/3.11/glossary.html#term-variable-annotation). За двумя исключениями, описанными ниже, в `@dataclass` тип, указанный в аннотации переменной, не проверяется.5152Порядок полей во всех сгенерированных методах соответствует порядку их объявления в определении класса.5354Декоратор `@dataclass` добавит в класс различные «дандер»-методы, описанные ниже. Если какой-либо из добавляемых методов уже существует в классе, поведение зависит от параметра, как описано ниже. Декоратор возвращает тот же класс, к которому он был применён; новый класс не создаётся.5556Если `@dataclass` используется как простой декоратор без параметров, он ведёт себя так, как если бы использовались значения по умолчанию, описанные в этой сигнатуре. То есть следующие три варианта применения `@dataclass` эквивалентны:5758```python59@dataclass60class C:61 ...6263@dataclass()64class C:65 ...6667@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False,68 match_args=True, kw_only=False, slots=False, weakref_slot=False)69class C:70 ...71```7273Параметры `@dataclass`:7475- `init`: Если true (по умолчанию), будет сгенерирован метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__).7677 Если класс уже определяет `__init__()`, этот параметр игнорируется.78- `repr`: Если true (по умолчанию), будет сгенерирован метод [`__repr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__repr__). Сгенерированная repr-строка будет содержать имя класса и имя и repr каждого поля в порядке их определения в классе. Поля, помеченные как исключённые из repr, не включаются. Например: `InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)`.7980 Если класс уже определяет `__repr__()`, этот параметр игнорируется.81- `eq`: Если true (по умолчанию), будет сгенерирован метод [`__eq__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__eq__). Этот метод сравнивает класс так, как если бы он был кортежем его полей, по порядку. Оба сравниваемых экземпляра должны быть одного типа.8283 Если класс уже определяет `__eq__()`, этот параметр игнорируется.84- `order`: Если true (по умолчанию `False`), будут сгенерированы методы [`__lt__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__lt__), [`__le__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__le__), [`__gt__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__gt__) и [`__ge__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__ge__). Они сравнивают класс так, как если бы он был кортежем его полей, по порядку. Оба сравниваемых экземпляра должны быть одного типа. Если `order` равно true, а `eq` – false, возбуждается [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError).8586 Если класс уже определяет любой из `__lt__()`, `__le__()`, `__gt__()` или `__ge__()`, то вызывается [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).87- `unsafe_hash`: Если `False` (по умолчанию), метод [`__hash__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__hash__) генерируется в соответствии с тем, как установлены `eq` и `frozen`.8889 `__hash__()` используется встроенной [`hash()`](https://python-all.ru/3.11/library/functions.html#hash) и при добавлении объектов в хешируемые коллекции, такие как словари и множества. Наличие `__hash__()` подразумевает, что экземпляры класса неизменяемы. Изменяемость – сложное свойство, зависящее от намерений программиста, наличия и поведения `__eq__()`, а также значений флагов `eq` и `frozen` в декораторе `@dataclass`.9091 По умолчанию `@dataclass` не будет неявно добавлять метод [`__hash__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__hash__), если это не безопасно. Он также не будет добавлять или изменять существующий явно определённый метод `__hash__()`. Установка атрибута класса `__hash__ = None` имеет для Python определённое значение, описанное в документации `__hash__()`.9293 Если `__hash__()` не определён явно или установлен в `None`, то `@dataclass` *может* добавить неявный метод `__hash__()`. Хотя это не рекомендуется, можно принудительно заставить `@dataclass` создать метод `__hash__()` с помощью `unsafe_hash=True`. Это может потребоваться, если класс логически неизменяем, но на практике его всё же можно изменить. Это специализированный случай использования, и к нему следует подходить с осторожностью.9495 Вот правила, определяющие неявное создание метода `__hash__()`. Обратите внимание, что нельзя одновременно иметь явный метод `__hash__()` в классе данных и устанавливать `unsafe_hash=True`; это приведёт к [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).9697 Если `eq` и `frozen` оба равны true, по умолчанию `@dataclass` сгенерирует метод `__hash__()`. Если `eq` равно true, а `frozen` – false, `__hash__()` будет установлено в `None`, что делает объект нехешируемым (каковым он и является, поскольку изменяем). Если `eq` равно false, `__hash__()` останется без изменений, то есть будет использован метод `__hash__()` родительского класса (если родительский класс – [`object`](https://python-all.ru/3.11/library/functions.html#object), это означает возврат к хешированию на основе id).98- `frozen`: Если true (по умолчанию `False`), присваивание полям будет вызывать исключение. Это эмулирует неизменяемые (замороженные) экземпляры. Если [`__setattr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__setattr__) или [`__delattr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__delattr__) определён в классе, то возбуждается [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError). См. обсуждение ниже.99- `match_args`: Если true (по умолчанию `True`), кортеж `__match_args__` будет создан из списка параметров сгенерированного метода [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) (даже если `__init__()` не генерируется, см. выше). Если false, или если `__match_args__` уже определён в классе, то `__match_args__` не будет сгенерирован.100101> Новое в версии 3.10.102103- `kw_only`: Если true (значение по умолчанию `False`), то все поля будут помечены как keyword-only. Если поле помечено как keyword-only, то единственный эффект заключается в том, что параметр [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__), сгенерированный из такого поля, должен быть указан с ключевым словом при вызове `__init__()`. Это не влияет ни на какие другие аспекты dataclasses. Подробнее см. запись глоссария [параметр](https://python-all.ru/3.11/glossary.html#term-parameter). Также см. раздел [`KW_ONLY`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.KW_ONLY).104105> Новое в версии 3.10.106107- `slots`: Если true (по умолчанию `False`), будет сгенерирован атрибут [`__slots__`](https://python-all.ru/3.11/reference/datamodel.html#object.__slots__) и возвращён новый класс вместо исходного. Если `__slots__` уже определён в классе, то возбуждается [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).108109> Новое в версии 3.10.110>111> Изменено в версии 3.11: Если имя поля уже присутствует в `__slots__` базового класса, оно не будет включено в сгенерированный `__slots__`, чтобы избежать [их переопределения](https://python-all.ru/3.11/reference/datamodel.html#datamodel-note-slots). Поэтому не используйте `__slots__` для получения имён полей dataclass. Используйте [`fields()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.fields). Чтобы можно было определить унаследованные слоты, `__slots__` базового класса может быть любым итерируемым объектом, но *не* итератором.112113- `weakref_slot`: Если true (по умолчанию `False`), добавляет слот с именем «\_\_weakref\_\_», который необходим для создания слабых ссылок на экземпляр. Указывать `weakref_slot=True` без `slots=True` – ошибка.114115> Новое в версии 3.11.116117`field` могут опционально задавать значение по умолчанию, используя обычный синтаксис Python:118119```python120@dataclass121class C:122 a: int # 'a' не имеет значения по умолчанию123 b: int = 0 # задайте значение по умолчанию для 'b'124```125126В этом примере и `a`, и `b` будут включены в добавленный метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__), который будет определён как:127128```python129def __init__(self, a: int, b: int = 0):130```131132[`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError) будет возбуждено, если поле без значения по умолчанию следует за полем со значением по умолчанию. Это верно как для одного класса, так и в случае наследования классов.133134#### `dataclasses.field(*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING)`135136Для простых и распространённых случаев никакой дополнительной функциональности не требуется. Однако у dataclass есть некоторые возможности, для которых нужна дополнительная информация о полях. Чтобы восполнить эту потребность, можно заменить значение поля по умолчанию на вызов предоставленной функции `field()`. Например:137138```python139@dataclass140class C:141 mylist: list[int] = field(default_factory=list)142143c = C()144c.mylist += [1, 2, 3]145```146147Как показано выше, значение [`MISSING`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.MISSING) – это объект-страж, используемый для определения того, какие параметры были заданы пользователем. Этот страж используется, потому что `None` является допустимым значением для некоторых параметров и имеет собственный смысл. Код не должен напрямую использовать значение [`MISSING`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.MISSING).148149Параметры `field()`:150151- `default`: Если указано, это будет значением по умолчанию для данного поля. Это необходимо, потому что сам вызов `field()` заменяет обычную позицию значения по умолчанию.152- `default_factory`: Если указано, это должен быть вызываемый объект без аргументов, который будет вызван, когда потребуется значение по умолчанию для этого поля. Помимо прочего, это можно использовать для указания полей с изменяемыми значениями по умолчанию, как обсуждается ниже. Указывать одновременно `default` и `default_factory` – ошибка.153- `init`: Если true (по умолчанию), это поле включается в качестве параметра в сгенерированный метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__).154- `repr`: Если true (по умолчанию), это поле включается в строку, возвращаемую сгенерированным методом [`__repr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__repr__).155- `hash`: Это может быть bool или `None`. Если true, это поле включается в сгенерированный метод [`__hash__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__hash__). Если `None` (по умолчанию), используется значение `compare`: обычно это ожидаемое поведение. Поле должно учитываться в хеше, если оно используется для сравнений. Установка этого значения в любое значение, отличное от `None`, не рекомендуется.156157 Одна из возможных причин установить `hash=False`, но `compare=True` – если вычисление хэш-значения для поля дорого, это поле нужно для проверки равенства, а есть другие поля, которые вносят вклад в хэш типа. Даже если поле исключено из хэша, оно всё равно будет использоваться для сравнений.158- `compare`: Если true (по умолчанию), это поле включается в сгенерированные методы равенства и сравнения ([`__eq__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__eq__), [`__gt__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__gt__) и др.).159- `metadata`: Это может быть отображение или None. None обрабатывается как пустой словарь. Это значение оборачивается в [`MappingProxyType()`](https://python-all.ru/3.11/library/types.html#types.MappingProxyType) для обеспечения только для чтения и предоставляется в объекте [`Field`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.Field). Оно вообще не используется Data Classes и предоставляется как механизм расширения сторонними библиотеками. Несколько сторонних библиотек могут иметь свои собственные ключи для использования в качестве пространства имён в метаданных.160- `kw_only`: Если true, это поле будет помечено как keyword-only. Это используется при вычислении параметров сгенерированного метода [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__).161162> Новое в версии 3.10.163164Если значение поля по умолчанию задаётся вызовом `field()`, то атрибут класса для этого поля будет заменён указанным значением `default`. Если `default` не указан, атрибут класса будет удалён. Предполагается, что после выполнения декоратора [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass) атрибуты класса будут содержать значения по умолчанию для полей, как если бы было указано само значение по умолчанию. Например, после:165166```python167@dataclass168class C:169 x: int170 y: int = field(repr=False)171 z: int = field(repr=False, default=10)172 t: int = 20173```174175Атрибут класса `C.z` будет равен `10`, атрибут класса `C.t` будет равен `20`, а атрибуты класса `C.x` и `C.y` не будут установлены.176177#### `class dataclasses.Field`178179Объекты `Field` описывают каждое определённое поле. Эти объекты создаются внутренне и возвращаются методом уровня модуля [`fields()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.fields) (см. ниже). Пользователи никогда не должны создавать экземпляр `Field` напрямую. Его документированные атрибуты:180181- `name`: Имя поля.182- `type`: Тип поля.183- `default`, `default_factory`, `init`, `repr`, `hash`, `compare`, `metadata` и `kw_only` имеют те же значения и смысл, что и в функции [`field()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.field).184185Могут существовать и другие атрибуты, но они приватные, и на них не следует полагаться или проверять их.186187#### `dataclasses.fields(class_or_instance)`188189Возвращает кортеж объектов [`Field`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.Field), определяющих поля этого датакласса. Принимает либо датакласс, либо экземпляр датакласса. Вызывает [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError), если передан не датакласс и не его экземпляр. Не возвращает псевдополя, которые являются `ClassVar` или `InitVar`.190191#### `dataclasses.asdict(obj, *, dict_factory=dict)`192193Преобразует dataclass `obj` в словарь (с помощью фабричной функции `dict_factory`). Каждый dataclass преобразуется в словарь своих полей в виде пар `name: value`. Рекурсивно обрабатываются dataclass'ы, словари, списки и кортежи. Другие объекты копируются с помощью [`copy.deepcopy()`](https://python-all.ru/3.11/library/copy.html#copy.deepcopy).194195Пример использования `asdict()` на вложенных датаклассах:196197```python198@dataclass199class Point:200 x: int201 y: int202203@dataclass204class C:205 mylist: list[Point]206207p = Point(10, 20)208assert asdict(p) == {'x': 10, 'y': 20}209210c = C([Point(0, 0), Point(10, 4)])211assert asdict(c) == {'mylist': [{'x': 0, 'y': 0}, {'x': 10, 'y': 4}]}212```213214Для создания поверхностной копии можно использовать следующий обходной путь:215216```python217dict((field.name, getattr(obj, field.name)) for field in fields(obj))218```219220`asdict()` возбуждает [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError), если `obj` не является экземпляром dataclass.221222#### `dataclasses.astuple(obj, *, tuple_factory=tuple)`223224Преобразует dataclass `obj` в кортеж (с помощью фабричной функции `tuple_factory`). Каждый dataclass преобразуется в кортеж значений своих полей. Рекурсивно обрабатываются dataclass'ы, словари, списки и кортежи. Другие объекты копируются с помощью [`copy.deepcopy()`](https://python-all.ru/3.11/library/copy.html#copy.deepcopy).225226Продолжая предыдущий пример:227228```python229assert astuple(p) == (10, 20)230assert astuple(c) == ([(0, 0), (10, 4)],)231```232233Для создания поверхностной копии можно использовать следующий обходной путь:234235```python236tuple(getattr(obj, field.name) for field in dataclasses.fields(obj))237```238239`astuple()` возбуждает [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError), если `obj` не является экземпляром dataclass.240241#### `dataclasses.make_dataclass(cls_name, fields, *, bases=(), namespace=None, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False)`242243Создаёт новый dataclass с именем `cls_name`, полями, определёнными в `fields`, базовыми классами, указанными в `bases`, и инициализируется пространством имён, заданным в `namespace`. `fields` – это итерируемый объект, элементы которого могут быть либо `name`, `(name, type)`, либо `(name, type, Field)`. Если указан только `name`, то `typing.Any` используется для `type`. Значения `init`, `repr`, `eq`, `order`, `unsafe_hash`, `frozen`, `match_args`, `kw_only`, `slots` и `weakref_slot` имеют тот же смысл, что и в [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass).244245Эта функция не является строго обязательной, поскольку любой механизм Python для создания нового класса с помощью `__annotations__` может затем применить функцию `@dataclass` для преобразования этого класса в датакласс. Эта функция предоставляется для удобства. Например:246247```python248C = make_dataclass('C',249 [('x', int),250 'y',251 ('z', int, field(default=5))],252 namespace={'add_one': lambda self: self.x + 1})253```254255Эквивалентно:256257```python258@dataclass259class C:260 x: int261 y: 'typing.Any'262 z: int = 5263264 def add_one(self):265 return self.x + 1266```267268#### `dataclasses.replace(obj, /, **changes)`269270Создаёт новый объект того же типа, что и `obj`, заменяя поля значениями из `changes`. Если `obj` не является Data Class, возбуждает [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError). Если значения в `changes` не указывают поля, возбуждает [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).271272Вновь возвращаемый объект создаётся вызовом метода [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) dataclass. Это гарантирует, что [\_\_post\_init\_\_](https://python-all.ru/3.11/library/dataclasses.html#post-init-processing), если он присутствует, также вызывается.273274Переменные, предназначенные только для инициализации, без значений по умолчанию (если таковые имеются) должны быть указаны в вызове `replace()`, чтобы их можно было передать в `__init__()` и `__post_init__()`.275276Ошибкой считается, если `changes` содержит какие-либо поля, определённые как имеющие `init=False`. В этом случае будет возбуждено [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError).277278Следует заранее знать, как работают поля `init=False` при вызове `replace()`. Они не копируются из исходного объекта, а инициализируются в `__post_init__()`, если вообще инициализируются. Ожидается, что поля `init=False` будут использоваться редко и осмотрительно. Если они используются, возможно, разумно иметь альтернативные конструкторы класса или, возможно, пользовательский метод `replace()` (или с похожим именем), который обрабатывает копирование экземпляра.279280#### `dataclasses.is_dataclass(obj)`281282Возвращает `True`, если его параметр является dataclass или экземпляром dataclass, иначе возвращает `False`.283284Если нужно узнать, является ли класс экземпляром dataclass (а не самим dataclass), добавьте дополнительную проверку на `not isinstance(obj, type)`:285286```python287def is_dataclass_instance(obj):288 return is_dataclass(obj) and not isinstance(obj, type)289```290291#### `dataclasses.MISSING`292293Сторожевое значение, обозначающее отсутствие значения по умолчанию или default\_factory.294295#### `dataclasses.KW_ONLY`296297Сторожевое значение, используемое в качестве аннотации типа. Все поля после псевдополя с типом `KW_ONLY` помечаются как keyword-only поля. Обратите внимание, что псевдополе типа `KW_ONLY` в остальном полностью игнорируется, включая имя такого поля. По соглашению имя `_` используется для поля `KW_ONLY`. Keyword-only поля означают параметры [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__), которые должны быть указаны как ключевые слова при создании класса.298299В этом примере поля `y` и `z` будут помечены как keyword-only поля:300301```python302@dataclass303class Point:304 x: float305 _: KW_ONLY306 y: float307 z: float308309p = Point(0, y=1.5, z=2.0)310```311312В одном dataclass указывать более одного поля с типом `KW_ONLY` – ошибка.313314Новое в версии 3.10.315316#### `exception dataclasses.FrozenInstanceError`317318Возбуждается, когда неявно определённые [`__setattr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__setattr__) или [`__delattr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__delattr__) вызываются для dataclass, определённого с `frozen=True`. Является подклассом [`AttributeError`](https://python-all.ru/3.11/library/exceptions.html#AttributeError).319320## Обработка после инициализации321322Сгенерированный код [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) вызовет метод с именем `__post_init__()`, если `__post_init__()` определён в классе. Обычно он вызывается как `self.__post_init__()`. Однако, если определены какие-либо поля `InitVar`, они также будут переданы в `__post_init__()` в порядке их определения в классе. Если метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) не сгенерирован, то `__post_init__()` не будет вызываться автоматически.323324> Если метод определён в классе, он будет вызван сгенерированным [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__), обычно как `self.__post_init__()`. Однако, если определены какие-либо поля `InitVar`, они также будут переданы в `__post_init__()` в порядке их определения в классе. Если метод `__init__()` не сгенерирован, то `__post_init__()` не будет вызван автоматически.325>326> > @dataclass class C:327> >328> > > a: float b: float c: float = field(init=False)329> > >330> > > **def \_\_post\_init\_\_(self):**331> > >332> > > self.c = self.a + self.b333334Метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__), сгенерированный [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass), не вызывает методы `__init__()` базового класса. Если базовый класс имеет метод `__init__()`, который необходимо вызвать, обычно этот метод вызывается в методе `__post_init__()`:335336```python337class Rectangle:338 def __init__(self, height, width):339 self.height = height340 self.width = width341342@dataclass343class Square(Rectangle):344 side: float345346 def __post_init__(self):347 super().__init__(self.side, self.side)348```349350Однако обратите внимание, что в целом вызывать сгенерированные dataclass методы `__init__()` не требуется, поскольку производный dataclass сам позаботится об инициализации всех полей любого базового класса, который сам является dataclass.351352Смотрите раздел ниже о переменных, используемых только для инициализации, чтобы узнать о способах передачи параметров в `__post_init__()`. Также обратите внимание на предупреждение о том, как [`replace()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.replace) обрабатывает поля `init=False`.353354## Переменные класса355356Одно из немногих мест, где [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass) фактически проверяет тип поля, – это определение, является ли поле переменной класса, как определено в [**PEP 526**](https://python-all.ru/3.11/library/dataclasses.html). Это делается путём проверки, является ли тип поля `typing.ClassVar`. Если поле является `ClassVar`, оно исключается из рассмотрения как поле и игнорируется механизмами dataclass. Такие псевдополя `ClassVar` не возвращаются функцией модульного уровня [`fields()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.fields).357358## Переменные только для инициализации359360Ещё одно место, где [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass) проверяет аннотации типов, – это определение, является ли поле переменной, используемой только при инициализации. Это делается путём проверки, является ли тип поля типом `dataclasses.InitVar`. Если поле является `InitVar`, оно считается псевдополем, называемым init-only полем. Поскольку это не настоящее поле, оно не возвращается функцией уровня модуля [`fields()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.fields). Поля init-only добавляются в качестве параметров в сгенерированный метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) и передаются опциональному методу [\_\_post\_init\_\_](https://python-all.ru/3.11/library/dataclasses.html#post-init-processing). В остальном dataclasses их не используют.361362Например, предположим, что поле будет инициализироваться из базы данных, если значение не указано при создании класса:363364```python365@dataclass366class C:367 i: int368 j: int | None = None369 database: InitVar[DatabaseType | None] = None370371 def __post_init__(self, database):372 if self.j is None and database is not None:373 self.j = database.lookup('j')374375c = C(10, database=my_database)376```377378В этом случае [`fields()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.fields) вернёт объекты [`Field`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.Field) для `i` и `j`, но не для `database`.379380## Замороженные экземпляры381382Создать по-настоящему неизменяемые объекты Python невозможно. Однако, передав `frozen=True` декоратору [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass), можно эмулировать неизменяемость. В этом случае dataclasses добавит в класс методы [`__setattr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__setattr__) и [`__delattr__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__delattr__). При вызове эти методы вызовут исключение [`FrozenInstanceError`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.FrozenInstanceError).383384Использование `frozen=True` сопряжено с небольшим снижением производительности: [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) не может использовать простое присваивание для инициализации полей и должен использовать `__setattr__()`.385386## Наследование387388Когда dataclass создаётся декоратором [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass), он просматривает все базовые классы в порядке, обратном MRO (начиная с [`object`](https://python-all.ru/3.11/library/functions.html#object)), и для каждого найденного dataclass добавляет поля из этого базового класса в упорядоченное отображение полей. После добавления всех полей базовых классов он добавляет свои собственные поля в это упорядоченное отображение. Все сгенерированные методы будут использовать это объединённое вычисленное упорядоченное отображение полей. Поскольку поля располагаются в порядке вставки, производные классы переопределяют базовые. Пример:389390```python391@dataclass392class Base:393 x: Any = 15.0394 y: int = 0395396@dataclass397class C(Base):398 z: int = 10399 x: int = 15400```401402Итоговый список полей в порядке: `x`, `y`, `z`. Итоговый тип `x` – `int`, как указано в классе `C`.403404Сгенерированный метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) для `C` будет выглядеть так:405406```python407def __init__(self, x: int = 15, y: int = 0, z: int = 10):408```409410## Переупорядочивание keyword-only параметров в `__init__()`411412После того как вычислены параметры, необходимые для [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__), все параметры, доступные только по ключевому слову, перемещаются так, чтобы они следовали за всеми обычными (не ключевыми) параметрами. Это требование реализации ключевых параметров в Python: они должны идти после обычных параметров.413414В этом примере `Base.y`, `Base.w` и `D.t` – поля, доступные только по ключевому слову, а `Base.x` и `D.z` – обычные поля.415416```python417@dataclass418class Base:419 x: Any = 15.0420 _: KW_ONLY421 y: int = 0422 w: int = 1423424@dataclass425class D(Base):426 z: int = 10427 t: int = field(kw_only=True, default=0)428```429430Сгенерированный метод `__init__()` для `D` будет выглядеть так:431432```python433def __init__(self, x: Any = 15.0, z: int = 10, *, y: int = 0, w: int = 1, t: int = 0):434```435436Обратите внимание, что порядок параметров изменился по сравнению с тем, как они указаны в списке полей: параметры, полученные из обычных полей, следуют за параметрами, полученными из ключевых полей.437438Относительный порядок ключевых параметров сохраняется в переупорядоченном списке параметров `__init__()`.439440## Функции фабрики по умолчанию441442Если [`field()`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.field) указывает `default_factory`, то он вызывается без аргументов, когда требуется значение по умолчанию для поля. Например, чтобы создать новый экземпляр списка, используйте:443444```python445mylist: list = field(default_factory=list)446```447448Если поле исключено из [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) (с помощью `init=False`) и поле также указывает `default_factory`, то функция фабрики значений по умолчанию всегда будет вызываться из сгенерированной функции `__init__()`. Это происходит потому, что нет другого способа задать полю начальное значение.449450## Изменяемые значения по умолчанию451452Python хранит значения переменных-членов по умолчанию в атрибутах класса. Рассмотрим этот пример без использования dataclasses:453454```python455class C:456 x = []457 def add(self, element):458 self.x.append(element)459460o1 = C()461o2 = C()462o1.add(1)463o2.add(2)464assert o1.x == [1, 2]465assert o1.x is o2.x466```467468Обратите внимание, что два экземпляра класса `C` разделяют одну и ту же переменную класса `x`, как и ожидалось.469470При использовании dataclasses, *если* бы этот код был корректным:471472```python473@dataclass474class D:475 x: list = [] # Этот код вызывает ValueError476 def add(self, element):477 self.x.append(element)478```479480он бы сгенерировал код, похожий на:481482```python483class D:484 x = []485 def __init__(self, x=x):486 self.x = x487 def add(self, element):488 self.x.append(element)489490assert D().x is D().x491```492493Это та же проблема, что и в исходном примере с классом `C`. То есть два экземпляра класса `D`, которые не указывают значение для `x` при создании экземпляра класса, будут использовать одну и ту же копию `x`. Поскольку dataclasses просто используют обычное создание классов Python, они также разделяют это поведение. Не существует общего способа для Data Classes обнаружить эту ситуацию. Вместо этого декоратор [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass) вызовет исключение [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError), если обнаружит нехешируемый параметр по умолчанию. Предполагается, что если значение нехешируемо, то оно изменяемо. Это частичное решение, но оно защищает от многих распространённых ошибок.494495Использование фабричных функций по умолчанию – это способ создавать новые экземпляры изменяемых типов в качестве значений полей по умолчанию:496497```python498@dataclass499class D:500 x: list = field(default_factory=list)501502assert D().x is not D().x503```504505Изменено в версии 3.11: Вместо поиска и запрета объектов типа `list`, `dict` или `set`, теперь нехешируемые объекты не допускаются в качестве значений по умолчанию. Нехешируемость используется для приблизительной оценки изменяемости.506507## Поля с типом дескриптора508509Поля, которым назначены [объекты-дескрипторы](https://python-all.ru/3.11/reference/datamodel.html#descriptors) в качестве значения по умолчанию, обладают следующим особым поведением:510511- Значение поля, переданное в метод [`__init__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__init__) класса данных, передается в метод [`__set__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__set__) дескриптора, а не перезаписывает объект-дескриптор.512- Аналогично, при чтении или записи поля вызывается метод [`__get__()`](https://python-all.ru/3.11/reference/datamodel.html#object.__get__) или `__set__()` дескриптора, а не возвращается или перезаписывается объект-дескриптор.513- Чтобы определить, содержит ли поле значение по умолчанию, [`@dataclass`](https://python-all.ru/3.11/library/dataclasses.html#dataclasses.dataclass) вызовет метод `__get__()` дескриптора, используя его форму доступа к классу: `descriptor.__get__(obj=None, type=cls)`. Если дескриптор в этом случае возвращает значение, оно будет использовано как значение поля по умолчанию. С другой стороны, если дескриптор вызывает [`AttributeError`](https://python-all.ru/3.11/library/exceptions.html#AttributeError) в этой ситуации, значение по умолчанию для поля предоставлено не будет.514515```python516class IntConversionDescriptor:517 def __init__(self, *, default):518 self._default = default519520 def __set_name__(self, owner, name):521 self._name = "_" + name522523 def __get__(self, obj, type):524 if obj is None:525 return self._default526527 return getattr(obj, self._name, self._default)528529 def __set__(self, obj, value):530 setattr(obj, self._name, int(value))531532@dataclass533class InventoryItem:534 quantity_on_hand: IntConversionDescriptor = IntConversionDescriptor(default=100)535536i = InventoryItem()537print(i.quantity_on_hand) # 100538i.quantity_on_hand = 2.5 # вызывает __set__ с 2.5539print(i.quantity_on_hand) # 2540```541542Обратите внимание: если поле аннотировано типом дескриптора, но ему не назначен объект-дескриптор в качестве значения по умолчанию, такое поле будет вести себя как обычное поле.543