WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

dataclasses.dataclass

Erzeugt aus Feldannotationen standardmäßig Initialisierer, Darstellung und Wertvergleich.

Version: Python 3.14; repository image, production runtime not attested

Syntax

@dataclasses.dataclass(frozen=True)

Erzeugt aus Feldannotationen standardmäßig Initialisierer, Darstellung und Wertvergleich.

Eine erzeugte Methode garantiert keine hashbaren Feldwerte. hash für Item([]) löst wegen der beteiligten Liste TypeError aus. Ohne eigenes __hash__ erzeugen eq=True und frozen=True einen Hash, eine veränderliche Klasse mit eq=True ist unhashbar und eq=False erhält die Regel der Basisklasse. unsafe_hash=True erzwingt die Erzeugung. slots=True liefert eine neue Klasse. Basisfelder werden in umgekehrter MRO gesammelt, ein überschriebenes Feld behält seine Position. Die erzeugte Gleichheit vergleicht die ausgewählten Felder von Instanzen genau derselben Klasse. Zwei Point(4) sind daher gleich.

Bei frozen=True löst Zuweisen von p.x FrozenInstanceError aus, eine in einem eingefrorenen Feld gespeicherte Liste kann sich aber ändern.

from dataclasses import dataclass, FrozenInstanceError
@dataclass(frozen=True)
class Item:
    tags: list
x = Item([])
x.tags.append("ok")
assert x == Item(["ok"])
try:
    x.tags = []
except FrozenInstanceError:
    pass
else:
    raise AssertionError
class C: pass
assert dataclass(slots=True)(C) is not C
assert dataclass()(type("A", (), {})).__hash__ is None
assert callable(dataclass(frozen=True)(type("B", (), {})).__hash__)
try:
    hash(Item([]))
except TypeError:
    pass
else:
    raise AssertionError

Beispiele

import dataclasses
@dataclasses.dataclass(frozen=True)
class Point:
    x: int

p = Point(4)
print(p == Point(4))
try:
    p.x = 9
except dataclasses.FrozenInstanceError as error:
    print(type(error).__name__)

Ergebnis

True
FrozenInstanceError

Bei frozen=True löst Zuweisen von p.x FrozenInstanceError aus, eine in einem eingefrorenen Feld gespeicherte Liste kann sich aber ändern.

Quellen