Spezialmethoden in Python

Funktionsweise von Spezialmethoden

Hauptsächlich aus historischen Gründen sieht die Objektorientierung in Python etwas anders aus, als in einigen anderen Sprachen. Um zum Beispiel die Länge von etwas zu ermitteln ruft man nicht something.len() sondern len(something) auf. Wenn man andere Sprachen gewohnt ist, kann das irritierend sein, es hat aber auch den Vorteil, dass die Länge bei allen Objekten gleich ermittelt wird und nicht ein Objekt eine len()-Methode, ein anderes eine length()- und wieder ein anderes eine size()-Methode hat.

Aber welche Methode muss eine Klasse haben, damit len(s) die Länge liefert? Würde man s.len() aufrufen, wäre die Sache klar: man müsste len() in der Klasse überschreiben, von der s eine Instanz ist. In Python wird aber hinter den Kulissen eine sogenannte Spezialmethode aufgerufen, die nicht offensichtlich ist.

>>> class S:
	def __len__(self):
		return 99
	
>>> s = S()
>>> len(s)
99

Auch die API-Dokumentation von len(s), gibt über diesen Zusammenhang leider keine Auskunft. Um die Arbeit etwas zu erleichtern, habe ich deshalb die folgende Liste mit Spezialmethoden aufgeschrieben.

Ein wesentlicher Zweck von Spezialmethoden ist außerdem die Operatorüberladung. Beispielsweise wird x < y durch die Methode __le__(self, other) auf dem Objekt x realisiert. "le" steht für den Namen des Operators "less" (kleiner).

Instanziierung

Darstellung

Funktionsobjekte

Kontextmanager

Vergleiche

Wenn __eq__(self, other) implementiert ist, wird der Ungleichheitsoperator != automatisch ergänzt. Zusammen mit __eq__(self, other) sollte auch __hash__() überschrieben werden, weil gleiche Objekte auch immer den gleichen Hash-Werte haben müssen, um in Collections, die Hash-Werte nutzen (z. B. set, dict), verwendet werden zu können. Falls die Objekte allerdings veränderlich sind, sollte __hash__() nicht implementiert werden, weil sich der Hash-Wert eines Objekts in einer Collection sonst nachträglich ändern würde, was zu Fehlern führen würde. Siehe Dokumentation zu __hash__()

Vergleichsoperatoren können mit dem Klassendekorator @functools.total_ordering auch aus einer einzigen Vergleichsmethode abgeleitet werden.

Rechenoperationen

Zusätzlich gibt es noch die Methoden __radd__, __rsub__, __rmul__, __rtruediv__, __rfloordiv__, __rmod__, __rdivmod__, __rpow__, __rlshift__, __rrshift__, __rand__, __rxor__, __ror__, die die binär-arithmetischen Operationen +, -, *, /, //, %, divmod(), pow(), **, <<, >>, &, ^, | implementieren. Diese Methoden werden aber nur aufgerufen, wenn der linke Operand die zugehörige "normale" Methode (ohne "r" am Anfang) nicht unterstützt und die Operanden von verschiedenen Typen sind.

Binäre Operationen

Operationen auf Collections

Beispiel: Mit diesen Methoden kann ein Dictionary geschrieben werden, das zu einem Schlüssel mehrere Werte speichert und standardmäßig den zuletzt eingefügten Wert zurückgibt. Diese Datenstruktur ist nützlich, um Werte aus HTTP-Requests zu speichern, wo ein Schlüssel mehrfach vorkommen kann.

class MultiValueDict(dict):
    """ Dictionary which can contain multiple values for each key. """
    
    def __setitem__(self, key, value):
        self.setdefault(key, []).insert(0, value)

    def __getitem__(self, key):
        """ Returns the last inserted value for the key. """
        return super(MultiValueDict, self).__getitem__(key)[0]

    def get_all(self, key):
        """ Returns a list with all values for the key. """
        return super(MultiValueDict, self).__getitem__(key)

Genutzt werden kann es fast wie ein normales Dictionary:

>>> mv = MultiValueDict()
>>> mv["x"] = "a"
>>> mv["x"] = "b"
>>> mv["x"]
'b'
>>> mv.get_all("x")
['b', 'a']

Weitere Information

• Python-Dokumentation: Special method names
• Why does python use 'magic methods'?
• Programming in Python 3, Second Edition, Mark Summerfield, Pearson Education 2010. Das Buch war auch Inspiration für diese Zusammenstellung.