Antwort.

Geschichte der Frage:

Sequenzen sind eines der ältesten und grundlegendsten Konzepte in Python. Klassische Beispiele sind Listen (list), Zeichenfolgen (str) und Tupel (tuple). Um mit Sequenzen zu interagieren, wurde ein spezielles Protokoll definiert: Es ist notwendig, die Methoden __getitem__ und __len__ zu implementieren. Dadurch kann sich das Objekt "wie eine Sequenz" verhalten – Indizierung, Slicing, Iterationen und sogar einige Standardfunktionen werden unterstützt.

Problem:

Ohne die richtige Implementierung dieser Methoden kann eine benutzerdefinierte Klasse nicht mit Indizierungsoperationen, for-Schleifen oder Funktionen wie len() arbeiten. Oft implementieren Anfänger nur eine der Methoden, berücksichtigen nicht die Ausnahmebehandlung und implementieren keine Unterstützung für Slices, was zu fehlerhaftem oder unerwartetem Verhalten führt.

Lösung:

Es muss die Methode __getitem__(self, key) zur Unterstützung von Indizierung und Slicing sowie __len__(self) zur Verwendung der len()-Funktion und korrekten Iterierbarkeit implementiert werden. Um Slices zu unterstützen, muss der Typ von key in __getitem__ unterschieden und korrekt behandelt werden.

Beispielcode:

def is_even(n):
    return n % 2 == 0

class EvenSequence:
    def __init__(self, size):
        self.size = size
    def __getitem__(self, index):
        if isinstance(index, slice):
            return [x for x in range(self.size)[index] if is_even(x)]
        if index < 0 or index >= self.size:
            raise IndexError('Index out of bounds')
        return index if is_even(index) else None
    def __len__(self):
        return self.size

Wichtige Merkmale:

Interaktion mit den meisten Funktionen und der Syntax von Python, wenn beide Methoden implementiert sind.
Für die Unterstützung von Slices müssen Objekte vom Typ slice in getitem verarbeitet werden.
Wenn len nicht implementiert ist, funktioniert das Objekt nicht mit len() und der vollständige Satz einiger Standardfunktionen.

Trickfragen.

Kann man sich nur mit der Methode getitem begnügen, damit das Objekt wie eine Sequenz funktioniert?

Teilweise. Wenn nur __getitem__ implementiert wird, kann man über das Objekt mit for iterieren und Elemente indizieren, aber len() wird nicht funktionieren.

Beispielcode:

class SeqOnlyGetitem:
    def __getitem__(self, index):
        if index >= 10:
            raise IndexError
        return index * 2

s = SeqOnlyGetitem()
for x in s:
    print(x)  # Funktioniert (iterierbar)
# print(len(s))  # Fehler TypeError

Wie behandelt man negative Indizes und was passiert, wenn man sie nicht berücksichtigt?

Negative Indizes sind ein zentrales Merkmal von Sequenzen in Python. Wenn sie nicht verarbeitet werden, verhält sich das Objekt unerwartet für den Benutzer.

class NegIndex:
    def __init__(self, data):
        self.data = data
    def __getitem__(self, index):
        if index < 0:
            index += len(self.data)
        return self.data[index]

Muss man contains oder iter für seine Sequence-Klasse implementieren?

Nicht zwingend. Wenn __getitem__ und __len__ implementiert sind, funktioniert die in-Funktion und for wird sie zur Iteration verwenden. Die Implementierung dieser Methoden ist in der Regel nicht notwendig, kann jedoch die Leistung erhöhen.

Typische Fehler und Anti-Pattern

Überprüfen nicht den Indexbereich, was zu IndexError oder unerwarteten Ergebnissen führt.
Implementieren keine Unterstützung für Slices, weshalb obj[2:10:2] einen Fehler auslöst.
Vergessen negative Indizes (obj[-1]).

Beispiel aus dem Leben

Negativer Fall

Der Entwickler hat nur getitem für seine Klasse nur für positive Indizes implementiert. Das Modul hat einige Unit-Tests bestanden, aber bei der tatsächlichen Nutzung sind bei dem Versuch, einen nicht existierenden Index oder einen negativen Index zuzugreifen, alle zusammengebrochen.

Vorteile:

Schnelle erste Implementierung.

Nachteile:

Unerwartete Fehler in der Praxis.
Unbequem zu verwenden (kann keine letzten Elemente über negative Indizes abrufen, funktioniert nicht mit Slices, funktioniert nicht mit len()).

Positiver Fall

Das Team hat beide Methoden (getitem und len) implementiert, Slices, negative Indizes berücksichtigt und korrekte Ausnahmen geworfen. Die endgültige Klasse funktionierte in allen Standardfällen von Python.