python functools.wrap装饰器

这个装饰器是用来维护被装饰的方法中一些最基本的属性的 ，位于functools.py文件中，使用的格式如下：

from functools import wraps
def outer(f):
    @wraps(f)
    def inner(*args,**kwargs):
        return f(*args,**kwargs)
    return inner

可以看到被装饰的方法被要求作为wraps的参数传入进去。

它的原型如下：

def wraps(wrapped,assigned = WRAPPER_ASSIGNMENTS,updated = WRAPPER_UPDATES):
　　return partial(update_wrapper, wrapped=wrapped,
               assigned=assigned, updated=updated)

参数说明：

wrapped:被装饰并且要保证基本属性的方法;

assigned:默认值是 WRAPPER_ASSIGNMENTS = (‘module’, ‘name’, ‘qualname’, ‘doc’,‘annotations’)，它是一个元组，确切的说它是一个可迭代对象；这个值指明了要明确保留下来的被装饰方法的属性值，这里的明确保留的意思是要用被装饰函数的属性值直接替换装饰器函数本身同名的属性的值，如__name__属性 __doc__属性这些因为是要明确保留的，所以必须直接用内部函数属性值替代装饰器函数的属性值，这也正是我们能继续看到内部函数这些属性的原因；

updated:默认值是 WRAPPER_UPDATES = (‘dict’,)，这同样是一个可迭代对象，是要用被装饰方法中同名的属性值更新装饰器同名的属性值，即字典的update方法，从相应的英文注释中可以推断出来；

从方法的实现代码看，它调用了一个叫做partial的可能是函数也可能是类的对象，传入的第一个参数是一个叫做update_wrapper的对象；我们先看一下update_wrapper，这其实是一个函数:

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:
        try:
            value = getattr(wrapped, attr)
        except AttributeError:
            pass
        else:
            setattr(wrapper, attr, value)
    for attr in updated:
        getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
    # Issue #17482: set __wrapped__ last so we don't inadvertently copy it
    # from the wrapped function when updating __dict__
    wrapper.__wrapped__ = wrapped # todo 这个属性暂时没有明白有什么地方会用到
    # Return the wrapper so this can be used as a decorator via partial()
    return wrapper

从源码的实现可以看到，根据assigned指定的属性，doc 和__name__其实就是通过将内部被装饰函数的属性值直接付给wraps装饰器的对应属性的，而最后又将这个被更新后的装饰器函数返回。

再看partial，这个其实是一个类，是一个可执行类；只看跟wraps相关的部分代码：

 class partial:
     """New function with partial application of the given arguments
     and keywords.
     """
 
     __slots__ = "func", "args", "keywords", "__dict__", "__weakref__"
 
     def __new__(*args, **keywords):
         if not args:
             raise TypeError("descriptor '__new__' of partial needs an argument")
         if len(args) < 2:
             raise TypeError("type 'partial' takes at least one argument")
         cls, func, *args = args
         if not callable(func):
             raise TypeError("the first argument must be callable")
         args = tuple(args)
 
         if hasattr(func, "func"):
             args = func.args + args
             tmpkw = func.keywords.copy()
             tmpkw.update(keywords)
             keywords = tmpkw
             del tmpkw
             func = func.func
 
         self = super(partial, cls).__new__(cls)
 
         self.func = func
         self.args = args
         self.keywords = keywords
         return self
 
     def __call__(*args, **keywords):
         if not args:
             raise TypeError("descriptor '__call__' of partial needs an argument")
         self, *args = args
         newkeywords = self.keywords.copy()
         newkeywords.update(keywords)
         return self.func(*self.args, *args, **newkeywords)

首先看__new__方法，它要求至少传递一个可被执行的对象，这个对象用来保留被装饰方法的相关属性，在wraps中即调用上面的update_wrapper函数，然后要保留的属性会被作为partial对象的实例属性保留在内部供实例被call时使用。

再看__call__，可以看到当它被执行时，本质上就是调用那个用来保留以及更新装饰器函数本身的方法，在这里装饰器是wraps，而那个方法即是update_wrapper。

最后来回顾一下整个wraps的过程：

from functools import wraps
def outer(f):
    @wraps(f)
    def inner(*args,**kwargs):
        return f(*args,**kwargs)
    return inner

首先第3行，wraps=wraps(f)，它返回一个partial类的可执行实例对象，然后再执行第四行的inner=wraps(inner)，此时在wraps中就会执行update_wrapper去用f的属性值更新wraps的属性值，这样必要的属性值就被保留下来了。

有两点还需要说明：

1 整个代码的逻辑还是比较清晰的，如果想保留的属性是另一套内容，完全可以通过@wraps时自己指定；

2 上面的partial代码在wraps被调用时并没有执行，因为源码中在最后居然还有几行内容：

try:
    from _functools import partial
except ImportError:
    pass

partial的逻辑应该是通过c实现的，不过具体的逻辑就是这里的partial代码，如果注释掉上面这几行代码 ，完全不影响执行。