Was macht „functools.wraps' in Python-Dekoratoren?

Enthüllung der Funktionalitäten von functools.wraps

Im Bereich der Python-Dekoratoren stellt sich die Frage: Was ist der Zweck von functools.wraps? ?

Verständnis Dekoratoren

Dekoratoren ermöglichen es uns, die Funktionalität vorhandener Funktionen zu verbessern, indem wir sie mit benutzerdefinierter Logik umschließen. Dieser Umhüllungsprozess kann jedoch zum Verlust von Metadaten führen, die mit der ursprünglichen Funktion verknüpft sind, nämlich Name, Dokumentation und Argumentliste.

Wir stellen vor: functools.wraps

Hier kommt functools.wraps ins Spiel. Es handelt sich um einen Dekorateur, der das Problem des Metadatenverlusts angeht. Indem wir @wraps(func) auf eine Dekoratorfunktion anwenden, weisen wir den Dekorator an, die Metadaten der ursprünglichen Funktion zu erben.

Funktionsweise von functools.wraps

• Behält den Funktionsnamen bei: Verhindert, dass der Name der dekorierten Funktion durch den Namen der ersetzt wird Dekorator.
• Behält Docstring: Kopiert die Dokumentation der ursprünglichen Funktion in die dekorierte Funktion.
• Argumente beibehalten: Stellt sicher, dass die dekorierte Funktion dieselbe behält Argumentsignatur als Originalfunktion.

Beispiel Verwendung

Betrachten Sie das folgende Beispiel:

def logged(func):
    @wraps(func)
    def with_logging(*args, **kwargs):
        print(func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging

@logged
def f(x):
    """Computes a mathematical operation."""
    return x + x * x

Durch die Anwendung von @wraps(func) auf den protokollierten Dekorator stellen wir sicher, dass die umschlossene Funktion f ihren ursprünglichen Namen und ihre Dokumentation beibehält. und Argumentliste:

• print(f.__name__) gibt aus 'f'
• print(f.__doc__) gibt „Berechnet eine mathematische Operation aus.“

Fazit

functools.wraps spielt a Sie spielen eine entscheidende Rolle bei der Erhaltung der Metadaten von Funktionen, die mit Dekoratoren umschlossen sind, und stellen sicher, dass wesentliche Informationen nicht verloren gehen. Durch die Verwendung von @wraps(func) können wir flexible und informative Dekoratoren erstellen, die das Funktionsverhalten effektiv verbessern, ohne ihre ursprünglichen Eigenschaften zu beeinträchtigen.

Das obige ist der detaillierte Inhalt vonWas macht „functools.wraps' in Python-Dekoratoren?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!