functools.wraps是做什么的？

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

在对另一个问题的答案发表评论时，有人说他们不确定functools.wraps在做什么。所以，我问这个问题，以便在StackOverflow上有它的记录以备将来参考： functools.wraps是什么？

#1楼

我经常将类而不是函数用于装饰器。我在这方面遇到了麻烦，因为对象不会具有函数所期望的所有相同属性。例如，一个对象将没有属性__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)

#2楼

使用装饰器时，您将一个功能替换为另一个功能。换句话说，如果您有一个装饰器

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'

#3楼

先决条件：您必须知道如何使用装饰器，尤其是包装器。该评论对其进行了清晰解释，或者该链接也对其进行了很好的解释。
每当我们使用For例如：@wraps后跟我们自己的包装函数。根据此链接中给出的详细信息，它表示

functools.wraps是方便函数，用于在定义包装函数时调用update_wrapper（）作为函数装饰器。

它等效于partial（update_wrapper，wraped = wrapped，assigned = assigned，updated = updated）。

因此，@ wraps装饰器实际上会调用functools.partial（func [，* args] [，** keywords]）。

functools.partial（）定义说

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

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

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

#4楼

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

wraps（f）返回一个对象，例如O1 。它是Partial类的对象
下一步是@ O1 ... ，这是python中的修饰符符号。它的意思是

wrapper = O1 .__ call __（wrapper）

检查的执行__call__ ，我们看到这一步，（左侧）包装成为对象造成的self.func（* self.args，* ARGS，** newkeywords）检查在__new__ O1的创建后，我们知道self.func是功能update_wrapper。 它使用参数* args （右侧包装器 ）作为其第一个参数。检查update_wrapper的最后一步，可以看到返回了右侧包装器 ，并根据需要修改了一些属性。

#5楼

这是关于包装的源代码：

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)

来源：oschina

链接：https://my.oschina.net/u/3797416/blog/3153496

标签

wrapper