25    Manipulation von Funktionen und Methoden 

In den vorangegangenen Kapiteln wurde unter anderem die Definition von Funktionen und Methoden behandelt. Aus verschiedenen Gründen möchte man Funktions- oder Methodenobjekte direkt bei der Definition oder nachträglich im Programm verändern. Beispielsweise lassen sich mit den in diesem Kapitel besprochenen Techniken Funktionsobjekte um Caching-Verfahren erweitern, ohne dass diese explizit implementiert werden müssen. Dazu behandeln wir im Folgenden zunächst die sogenannten Decorators und darauf aufbauend das Modul functools der Standardbibliothek, das unter anderem eine Sammlung hilfreicher Decorators enthält.

 

25.1    Decorator 

Aus Kapitel 21, »Objektorientierung«, kennen Sie die Built-in Function staticmethod, die folgendermaßen verwendet wurde:

class MeineKlasse:
    def methode(): 
        pass
    methode = staticmethod(methode)

Durch diese Schreibweise wird zunächst eine Methode angelegt und später durch die Built-in Function staticmethod modifiziert. Die angelegte Methode wird dann mit dem modifizierten Funktionsobjekt überschrieben.

Diese Art, staticmethod anzuwenden, ist richtig und funktioniert, ist aber gleichzeitig auch unidiomatisch und nicht gut lesbar. Aus diesem Grund unterstützt Python eine eigene Notation, um den oben dargestellten Code lesbarer zu gestalten. Das folgende Beispiel ist zu dem vorangegangenen äquivalent:

class MeineKlasse:
    @staticmethod
    def methode(): 
        pass

Die Funktion, die die angelegte Methode modifizieren soll, wird nach einem @-Zeichen vor die Methodendefinition geschrieben. Eine solche Notation wird Function Decorator genannt. Function Decorators sind nicht auf den Einsatz mit staticmethod beschränkt, Sie können beliebige Decorators erstellen. Auf diese Weise können Sie eine Funktion durch bloßes Hinzufügen eines Decorators erweitern.

Function Decorators können nicht nur auf Methoden angewendet werden, sondern genauso auf Funktionen. Zudem können sie ineinander verschachtelt werden, wie folgendes Beispiel zeigt:

@dec1
@dec2
def funktion():
    pass

Diese Funktionsdefinition ist äquivalent zu folgendem Code:

def funktion():
    pass
funktion = dec1(dec2(funktion))

Es erübrigt sich zu sagen, dass sowohl dec1 als auch dec2 implementiert werden müssen, bevor die Beispiele lauffähig sind.

Das folgende Beispiel zeigt einen interessanten Ansatz zum Cachen (dt. »Zwischenspeichern«) von Funktionsaufrufen, bei dem die Ergebnisse komplexer Berechnungen automatisch gespeichert werden. Diese können dann beim nächsten Funktionsaufruf mit den gleichen Parametern wiedergegeben werden, ohne die Berechnungen erneut durchführen zu müssen. Das Caching einer Funktion erfolgt allein durch Angabe eines Function Decorators, also ohne in die Funktion selbst einzugreifen, und funktioniert zudem mit allen Funktionsaufrufen, bei denen nur hashbare Instanzen übergeben werden. Dazu sehen wir uns zunächst die Definition der Berechnungsfunktion an, die in diesem Fall die Fakultät einer ganzen Zahl berechnet, inklusive Function Decorator:

@CacheDecorator()
def fak(n): 
    ergebnis = 1
    for i in range(2, n+1): 
        ergebnis *= i
    return ergebnis

Interessant ist hier der Function Decorator, denn es handelt sich dabei nicht um eine Funktion, sondern um eine Klasse namens CacheDecorator, die im Decorator instanziiert wird. Sie erinnern sich sicherlich, dass eine Klasse durch Implementieren der Magic Method __call__ aufrufbar gemacht werden kann und sich damit wie ein Funktionsobjekt verhält. Wir müssen diesen Umweg gehen, da wir die Ergebnisse der Berechnungen so speichern müssen, dass sie auch in späteren Aufrufen des Decorators noch verfügbar sind. Das ist mit einer Funktion nicht möglich, wohl aber mit einer Klasse. Die Definition der Decorator-Klasse sieht folgendermaßen aus:

class CacheDecorator:
    def __init__(self):
        self.cache = {}
        self.func = None
    def cachedFunc(self, *args): 
        if args not in self.cache: 
            self.cache[args] = self.func(*args) 
        return self.cache[args]
    def __call__(self, func): 
        self.func = func
        return self.cachedFunc

Im Konstruktor der Klasse CacheDecorator wird ein leeres Dictionary für die zwischengespeicherten Werte angelegt. Neben dem Konstruktor ist unter anderem die Methode __call__ implementiert. Durch diese Methode werden Instanzen der Klasse aufrufbar,[ 108 ](Näheres dazu erfahren Sie in Abschnitt 21.7.1, »Allgemeine Magic Methods«. ) können also wie ein Funktionsobjekt verwendet werden. Um als Function Decorator verwendet werden zu können, muss die Methode __call__ ein Funktionsobjekt als Parameter akzeptieren und ein Funktionsobjekt zurückgeben. Das zurückgegebene Funktionsobjekt wird dann als veränderte Version der ursprünglich übergebenen Funktion mit dieser assoziiert. In unserem Beispiel gibt __call__ das Funktionsobjekt der Methode cachedFunc zurück.

Die Methode cachedFunc soll jetzt also anstelle der ursprünglich angelegten Funktion aufgerufen werden. Damit sie ihre Aufgabe erledigen kann, hat sie Zugriff auf das Funktionsobjekt der eigentlichen Funktion, das vom Attribut self.func referenziert wird. Die Methode cachedFunc akzeptiert beliebig viele Positional Arguments, da sie später für so viele Funktionsschnittstellen wie möglich funktionieren soll[ 109 ](Da die bei einem Funktionsaufruf übergebenen Parameter als Schlüssel für das interne Cache-Dictionary verwendet werden, dürfen nur Instanzen hashbarer Datentypen übergeben werden. ). Diese Argumente sind innerhalb der Methode als Tupel verfügbar.

Jetzt wird geprüft, ob das Tupel mit den übergebenen Argumenten bereits als Schlüssel im Dictionary self.cache existiert. Wenn ja, wurde die Funktion bereits mit exakt den gleichen Argumenten aufgerufen, und der im Cache gespeicherte Rückgabewert kann direkt zurückgegeben werden. Ist der Schlüssel nicht vorhanden, wird die Berechnungsfunktion self.func mit den übergebenen Argumenten aufgerufen und das Ergebnis im Cache gespeichert. Anschließend wird es zurückgegeben.

Um zu testen, ob das Speichern der Werte funktioniert, wird das Beispiel um zwei Ausgaben erweitert, je nachdem, ob ein Ergebnis neu berechnet oder aus dem Cache geladen wurde. Und tatsächlich, es funktioniert:

>>> fak(10)
Ergebnis berechnet
3628800
>>> fak(20) 
Ergebnis berechnet
2432902008176640000
>>> fak(20) 
Ergebnis geladen
2432902008176640000
>>> fak(10) 
Ergebnis geladen
3628800

Wie Sie sehen, wurden die ersten beiden Ergebnisse berechnet, während die letzten beiden aus dem internen Cache geladen wurden. Diese Form des Cachings bietet je nach Anwendungsbereich und Komplexität der Berechnung erhebliche Geschwindigkeitsvorteile. Beachten Sie aber, dass keine Logik zum Löschen von Cache-Einträgen implementiert ist. Der Cache wird also bei Benutzung immer weiter anwachsen.