How Does `functools.wraps` Preserve Function Metadata in Python Decorators?

Unveiling the Mysteries of functools.wraps: Maintaining Function Metadata

Decorators play a crucial role in extending the functionality of Python functions. However, they often come at the cost of losing important function metadata like the name, docstring, and argument list. Fortunately, functools.wraps emerges as a savior, preserving this invaluable information.

When applying a decorator, the original function is replaced with a wrapper function, causing certain key details to be obscured. For instance, consider the following example:

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

If you execute print(f.__name__), it will yield "with_logging," and f.__doc__ will return an empty string. This consequence arises because the wrapper function with_logging has taken the place of f.

functools.wraps addresses this issue by wrapping the decorator function and ensuring that the metadata of the decorated function remains intact. By applying @wraps(func) to the inner function, as seen below, we restore the desired behavior:

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 this revised example, f.__name__ displays "f," and f.__doc__ correctly reflects the original function's docstring. Metadata preservation is crucial for maintaining the function's identity, documentation, and introspection capabilities.

Thus, remember that functools.wraps is an essential tool in the decorator toolkit, safeguarding against information loss and ensuring that your decorated functions retain their intended attributes.

The above is the detailed content of How Does `functools.wraps` Preserve Function Metadata in Python Decorators?. For more information, please follow other related articles on the PHP Chinese website!