dataclasses.dataclass, dataclasses.field, dataclasses.fields, dataclasses.is_dataclass, dataclasses.asdict, dataclasses.astuple, dataclasses.replace
@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)
dataclasses.field(*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING)
dataclasses.fields(class_or_instance)
dataclasses.is_dataclass(obj)
dataclasses.asdict(obj, *, dict_factory=dict)
dataclasses.astuple(obj, *, tuple_factory=tuple)
dataclasses.replace(obj, /, **changes)Declare fields, give each instance its own mutable default, and convert or copy a dataclass instance.
| Parameter | Description |
|---|---|
default_factory | A zero-argument callable used when a default value is needed. Do not pass both default and default_factory. |
obj / changes | asdict, astuple, and replace require a dataclass instance. replace accepts field=value replacements. |
Returns: fields returns a tuple of Field objects. is_dataclass returns a bool. asdict returns a dict. astuple returns a tuple. replace returns a new instance of the same type.
Raises
ValueError— Raised at class-decoration time for an unhashable field default such as a list. Also raised if replace is asked to change an init=False field.TypeError— asdict, astuple, and replace raise TypeError when obj is not a dataclass instance. replace also raises TypeError for unknown field names.
- asdict and astuple recurse into dataclasses, dicts, lists, and tuples. Other objects are copied with copy.deepcopy(). For a shallow mapping of fields, official documentation shows a comprehension over fields(obj).
- replace calls the dataclass __init__, so __post_init__ runs on the new instance.
from dataclasses import dataclass, field, fields, asdict, astuple, replace, is_dataclass
try:
@dataclass
class Bad:
items: list = []
except ValueError as err:
print(type(err).__name__)
@dataclass
class Bag:
items: list = field(default_factory=list)
label: str = "x"
a = Bag()
b = Bag()
a.items.append(1)
print(a.items, b.items, a.items is not b.items)
print(is_dataclass(Bag), is_dataclass(a), is_dataclass(list))
print(fields(Bag)[0].name, fields(Bag)[0].default_factory is list)
print(asdict(Bag([1, 2], "n")), astuple(Bag([1, 2], "n")))
print(replace(Bag([1], "n"), label="m"))Expected output
ValueError
[1] [] True
True True False
items True
{'items': [1, 2], 'label': 'n'} ([1, 2], 'n')
Bag(items=[1], label='m')Related: copy