__slots__ und slots=True-Dataclasses: kleinere Instanzen mit festen Attributen

Worum es geht

Standardmässig trägt jede Instanz ein __dict__ für ihre Attribute sowie einen __weakref__-Slot. Das Deklarieren von __slots__ = ("x", "y") reserviert festen Speicher für diese Namen; die Sprachreferenz hält fest, dass dies die Erzeugung von __dict__ und __weakref__ verhindert, sofern sie nicht aufgeführt sind, dass der eingesparte Speicher erheblich sein kann und dass der Attributzugriff schneller sein kann. @dataclass(slots=True) (3.10) erzeugt __slots__ aus den Feldern und gibt laut Dokumentation eine neue Klasse anstelle der ursprünglichen zurück; weakref_slot=True (3.11) fügt __weakref__ wieder hinzu, damit Instanzen schwach referenziert werden können.

Warum es wichtig ist

Programme, die Millionen kleiner Datensätze halten (geparste Logzeilen, Graphknoten, Cache-Einträge), bezahlen für ein Dictionary pro Instanz. Slots fangen zudem Tippfehler ab: Die Zuweisung eines Namens, der nicht in __slots__ steht, löst AttributeError aus, statt still ein neues Attribut anzulegen.

So wird es angewendet

• @dataclass(slots=True, frozen=True) für wertartige, in grosser Zahl erzeugte Datensätze verwenden; mit tracemalloc an einer repräsentativen Stichprobe vorher und nachher messen und die Änderung nur behalten, wenn die Einsparung ins Gewicht fällt.
• __slots__ in jeder Klasse der Hierarchie deklarieren (ein leeres Tupel, wo keine Attribute hinzukommen). Die Referenz hält fest, dass Instanzen beim Erben von einer Klasse ohne __slots__ immer __dict__ und __weakref__ haben, sodass die Einsparung entfällt.
• "__dict__" zu __slots__ hinzufügen, wenn dynamische Attribute tatsächlich gebraucht werden, sowie weakref_slot=True (oder "__weakref__"), wenn Instanzen in ein WeakValueDictionary oder eine andere schwach referenzierende Struktur gelangen.
• Die Felder einer Dataclass mit dataclasses.fields() auflisten, nicht durch Lesen von __slots__; die Dokumentation merkt an, dass Felder, die in einer Basisklasse bereits geslottet sind, im erzeugten __slots__ ausgelassen werden.

Stolpersteine

Weil slots=True eine neue Klasse zurückgibt, verwiesen ursprünglich im Klassenkörper geschriebene Methoden über die implizite __class__-Zelle weiterhin auf die alte Klasse. Die 3.13-Dokumentation warnt, dass super() ohne Argumente in einer solchen Methode TypeError auslöst, und nennt super() mit zwei Argumenten als Umgehung; das 3.14-Änderungsprotokoll verzeichnet die Behebung (gh-90562). Code, der auf 3.10 bis 3.13 laufen muss, schreibt daher super(ClassName, self) oder verlagert den Aufruf in eine nicht geslottete Basisklasse. Die Dokumentation warnt zudem, dass die Übergabe von Parametern an __init_subclass__ einer Basisklasse bei slots=True TypeError auslöst. Die Referenz hält fest, dass Mehrfachvererbung von mehr als einer Basisklasse mit nicht leeren Slots TypeError auslöst und dass Klassenattribute nicht zum Setzen von Standardwerten für geslottete Variablen verwendet werden können, da sie den Deskriptor überschreiben würden. cached_property braucht ein __dict__ und funktioniert daher bei geslotteten Klassen nicht.