Wie bewahrt „functools.wraps' Funktionsmetadaten in Python-Dekoratoren?

Enthüllung der Geheimnisse von functools.wraps: Funktionsmetadaten pflegen

Dekoratoren spielen eine entscheidende Rolle bei der Erweiterung der Funktionalität von Python-Funktionen. Sie gehen jedoch häufig mit dem Verlust wichtiger Funktionsmetadaten wie Name, Dokumentzeichenfolge und Argumentliste einher. Glücklicherweise erweist sich functools.wraps als Retter und bewahrt diese unschätzbaren Informationen.

Beim Anwenden eines Dekorators wird die ursprüngliche Funktion durch eine Wrapper-Funktion ersetzt, wodurch bestimmte wichtige Details verdeckt werden. Betrachten Sie zum Beispiel das folgende Beispiel:

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

@logged
def f(x):
    """does some math"""
    return x + x * x

Wenn Sie print(f.__name__) ausführen, wird „with_logging“ zurückgegeben und f.__doc__ gibt eine leere Zeichenfolge zurück. Diese Konsequenz entsteht, weil die Wrapper-Funktion with_logging an die Stelle von f getreten ist.

functools.wraps behebt dieses Problem, indem es die Dekoratorfunktion umschließt und sicherstellt, dass die Metadaten der dekorierten Funktion intakt bleiben. Indem wir @wraps(func) auf die innere Funktion anwenden, wie unten gezeigt, stellen wir das gewünschte Verhalten wieder her:

from functools import wraps
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):
    """does some math"""
    return x + x * x

print(f.__name__)  # prints 'f'
print(f.__doc__)   # prints 'does some math'

In diesem überarbeiteten Beispiel zeigt f.__name__ „f“ an und f.__doc__ spiegelt es korrekt wider die Dokumentzeichenfolge der ursprünglichen Funktion. Die Erhaltung der Metadaten ist für die Aufrechterhaltung der Identität, Dokumentation und Selbstbeobachtungsfähigkeiten der Funktion von entscheidender Bedeutung.

Denken Sie daher daran, dass functools.wraps ein wesentliches Werkzeug im Decorator-Toolkit ist, das vor Informationsverlust schützt und sicherstellt, dass Ihre dekorierten Funktionen ihre Eigenschaften behalten beabsichtigte Attribute.

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