functools.wraps 有什么作用？

Question

在对此另一个答案的评论中问题，有人说他们不确定 functools.wraps 在做什么。 所以，我问这个问题是为了在 StackOverflow 上记录它以供将来参考： functools.wraps 到底是做什么的？

Answer 1

当您使用装饰器时，您正在将一个函数替换为另一个函数。 换句话说，如果你有一个装饰器，

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

与所说的完全相同

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

时，你的函数 f 就会被函数 with_logging 替换。 不幸的是，这意味着如果您随后说

print(f.__name__)

它将打印 with_logging 因为这是您的新函数的名称。 事实上，如果您查看 f 的文档字符串，它将是空白的，因为 with_logging 没有文档字符串，因此您编写的文档字符串将不再存在。 另外，如果您查看该函数的 pydoc 结果，它不会被列为采用一个参数 x； 相反，它将被列为采用 *args 和 **kwargs 因为这就是 with_logging 所采用的。

如果使用装饰器总是意味着丢失有关函数的信息，那么这将是一个严重的问题。 这就是我们有 functools.wraps 的原因。 这需要装饰器中使用的函数，并添加复制函数名称、文档字符串、参数列表等的功能。并且由于 wraps 本身就是一个装饰器，因此以下代码执行正确的操作：

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'

Answer 2

从 python 3.5+ 开始：

@functools.wraps(f)
def g():
    pass

是 g = functools.update_wrapper(g, f) 的别名。 它只做了三件事：

• 复制 __module__、__name__、__qualname__、__doc__ 和 __annotations__ g 上 f 的 属性。 这个默认列表位于 WRAPPER_ASSIGNMENTS 中，您可以在 functools 源。
• 它使用 f.__dict__ 中的所有元素更新 g 的 __dict__。 （请参阅源代码中的 WRAPPER_UPDATES ）
• 它在 g 上设置新的 __wrapped__=f 属性，

结果是 g显示为与 f 具有相同的名称、文档字符串、模块名称和签名。 唯一的问题是，关于签名，这实际上不是真的：只是 inspect.signature 默认情况下遵循包装器链。 您可以使用 inspect.signature(g, follow_wrapped=False) 进行检查，如

• 即使提供的参数无效，包装器代码也会执行。
• 包装器代码无法轻松地使用参数名称从接收到的 *args、**kwargs 访问参数。 事实上，我们必须处理所有情况（位置、关键字、默认），因此要使用诸如 Signature.bind() 之类的东西。

现在，functools.wraps 和装饰器之间存在一些混淆，因为开发装饰器的一个非常常见的用例是包装函数。 但两者是完全独立的概念。 如果您有兴趣了解差异，我为两者实现了帮助程序库： decopatch 来编写轻松装饰器，并 makefun 为 @wraps 提供保留签名的替代品. 请注意，makefun 依赖于与著名的 decorator 库相同的经过验证的技巧。

Answer 3

1. 假设我们有这样的：简单装饰器，它接受函数的输出并将其放入字符串中，后跟三个!!!!。

def mydeco(func):
    def wrapper(*args, **kwargs):
        return f'{func(*args, **kwargs)}!!!'
    return wrapper

2. 现在让我们用“mydeco”装饰两个不同的函数：

@mydeco
def add(a, b):
    '''Add two objects together, the long way'''
    return a + b

@mydeco
def mysum(*args):
    '''Sum any numbers together, the long way'''
    total = 0
    for one_item in args:
        total += one_item
    return total

3. 当运行 add(10,20)、mysum(1,2,3,4) 时，它起作用了！

>>> add(10,20)
'30!!!'

>>> mysum(1,2,3,4)
'10!!!!'

4. 但是，name 属性在定义函数时为我们提供了函数的名称，

>>>add.__name__
'wrapper`

>>>mysum.__name__
'wrapper'

5. 更糟糕的是，

>>> help(add)
Help on function wrapper in module __main__:
wrapper(*args, **kwargs)

>>> help(mysum)
Help on function wrapper in module __main__:
wrapper(*args, **kwargs)

6. 我们可以通过以下方式部分修复：

def mydeco(func):
    def wrapper(*args, **kwargs):
        return f'{func(*args, **kwargs)}!!!'
    wrapper.__name__ = func.__name__
    wrapper.__doc__ = func.__doc__
    return wrapper

7. 现在我们再次运行步骤 5（第二次）：

>>> help(add)
Help on function add in module __main__:

add(*args, **kwargs)
     Add two objects together, the long way

>>> help(mysum)
Help on function mysum in module __main__:

mysum(*args, **kwargs)
    Sum any numbers together, the long way

8. 但我们可以使用 functools。包裹（decotator工具）

from functools import wraps

def mydeco(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        return f'{func(*args, **kwargs)}!!!'
    return wrapper

9. 现在再次运行步骤5（第三次）

>>> help(add)
Help on function add in module main:
add(a, b)
     Add two objects together, the long way

>>> help(mysum)
Help on function mysum in module main:
mysum(*args)
     Sum any numbers together, the long way

参考

Answer 4

我经常为我的装饰器使用类，而不是函数。 我在这方面遇到了一些麻烦，因为对象不会具有函数所期望的所有相同属性。 例如，对象不会具有属性 __name__。 我遇到了一个具体问题，很难追踪 Django 报告错误“对象没有属性 '__name__'”的位置。 不幸的是，对于类风格的装饰器，我不相信 @wrap 能完成这项工作。 相反，我创建了一个基本装饰器类，如下所示：

class DecBase(object):
    func = None

    def __init__(self, func):
        self.__func = func

    def __getattribute__(self, name):
        if name == "func":
            return super(DecBase, self).__getattribute__(name)

        return self.func.__getattribute__(name)

    def __setattr__(self, name, value):
        if name == "func":
            return super(DecBase, self).__setattr__(name, value)

        return self.func.__setattr__(name, value)

该类将所有属性调用代理到正在装饰的函数。 因此，您现在可以创建一个简单的装饰器来检查是否指定了 2 个参数，如下所示：

class process_login(DecBase):
    def __call__(self, *args):
        if len(args) != 2:
            raise Exception("You can only specify two arguments")

        return self.func(*args)

Answer 5

1. 先决条件：您必须知道如何使用装饰器，特别是包装器。 这个评论解释得有点清楚或者这个链接也很好地解释了它。

2. 每当我们使用 For 例如：@wraps 后跟我们自己的包装函数。 根据此 链接 中给出的详细信息，它说

functools.wraps 是在定义包装器函数时调用 update_wrapper() 作为函数装饰器的便捷函数。

它相当于partial(update_wrapper,wrapped=wrapped,signed=assigned,updated=updated)。

所以@wraps装饰器实际上调用了functools.partial(func[,*args][,**keywords])。

functools.partial() 定义表示

partial() 用于部分函数应用程序，它“冻结”函数参数和/或关键字的某些部分，从而产生具有简化签名的新对象。 例如，partial() 可用于创建一个可调用函数，其行为类似于 int() 函数，其中基本参数默认为 2：

>>> from functools import partial
>>> basetwo = partial(int, base=2)
>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
>>> basetwo('10010')
18

这使我得出结论，@wraps 调用了partial() 并传递了您的包装函数作为它的参数。 partial() 最后返回简化版本，即包装函数内部的对象，而不是包装函数本身。

Answer 6

这是关于包装的源代码：

WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__doc__')

WRAPPER_UPDATES = ('__dict__',)

def update_wrapper(wrapper,
                   wrapped,
                   assigned = WRAPPER_ASSIGNMENTS,
                   updated = WRAPPER_UPDATES):

    """Update a wrapper function to look like the wrapped function

       wrapper is the function to be updated
       wrapped is the original function
       assigned is a tuple naming the attributes assigned directly
       from the wrapped function to the wrapper function (defaults to
       functools.WRAPPER_ASSIGNMENTS)
       updated is a tuple naming the attributes of the wrapper that
       are updated with the corresponding attribute from the wrapped
       function (defaults to functools.WRAPPER_UPDATES)
    """
    for attr in assigned:
        setattr(wrapper, attr, getattr(wrapped, attr))
    for attr in updated:
        getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
    # Return the wrapper so this can be used as a decorator via partial()
    return wrapper

def wraps(wrapped,
          assigned = WRAPPER_ASSIGNMENTS,
          updated = WRAPPER_UPDATES):
    """Decorator factory to apply update_wrapper() to a wrapper function

   Returns a decorator that invokes update_wrapper() with the decorated
   function as the wrapper argument and the arguments to wraps() as the
   remaining arguments. Default arguments are as for update_wrapper().
   This is a convenience function to simplify applying partial() to
   update_wrapper().
    """
    return partial(update_wrapper, wrapped=wrapped,
                   assigned=assigned, updated=updated)

Answer 7

简而言之，functools.wraps只是一个常规函数。 让我们考虑一下这个官方示例。 借助源代码，我们可以有关实现和运行步骤的更多详细信息，如下所示：

1. wraps(f) 返回一个对象，例如O1。 它是 类 Partial
2. 下一步是@O1...，这是Python 中的装饰器表示法。 它的意思是

wrapper=O1.__call__(包装器)

检查 __call__，我们看到在这一步之后，(左侧)wrapper 变成了 self.func 结果的对象(*self.args, *args, **newkeywords) 检查__new__中O1的创建，我们知道self.func > 是函数update_wrapper。 它使用参数*args（右侧包装器）作为其第一个参数。 检查update_wrapper的最后一步，可以看到返回了右侧wrapper，并根据需要修改了一些属性。