`functools.wraps` 如何在 Python 装饰器中保留函数元数据？

揭开 functools.wraps 的神秘面纱：维护函数元数据

装饰器在扩展 Python 函数的功能方面发挥着至关重要的作用。然而，它们通常以丢失重要的函数元数据为代价，例如名称、文档字符串和参数列表。幸运的是，functools.wraps 作为救世主出现，保留了这些宝贵的信息。

应用装饰器时，原始函数被包装函数替换，导致某些关键细节被掩盖。例如，考虑以下示例：

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

如果执行 print(f.__name__)，它将产生“with_logging”，并且 f.__doc__ 将返回一个空字符串。出现这种结果是因为包装函数 with_logging 已经取代了 f.

functools.wraps 通过包装装饰器函数并确保装饰函数的元数据保持完整来解决此问题。通过将 @wraps(func) 应用于内部函数，如下所示，我们恢复了所需的行为：

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'

在这个修改后的示例中，f.__name__ 显示“f”，而 f.__doc__ 正确反映原始函数的文档字符串。元数据保存对于维护函数的身份、文档和自省功能至关重要。

因此，请记住 functools.wraps 是装饰器工具包中的重要工具，可防止信息丢失并确保您的装饰函数保留其功能预期属性。

以上是`functools.wraps` 如何在 Python 装饰器中保留函数元数据？的详细内容。更多信息请关注PHP中文网其他相关文章！