45. 为被装饰函数保存元数据

在函数对象中保存着一些函数的元数据，例如：

__name__        函数的名字
__doc__         函数文档字符串
__module__      函数所属模块名
__dict__        属性字典
__default__     默认参数元组
...

在使用装饰器后，再访问上面这些属性时，看到的是内部包裹函数的元数据，原来函数的元数据便丢失了。

要求：为被装饰函数保存元数据。

解决方案：

1. 使用标准库functools中的update_wrapper()函数更新内部包裹函数的属性为被包裹函数的属性。

2. 使用标准库functools中的wraps装饰内部包裹函数，可以指定将原函数的某些属性，更新到包裹函数。

---

• 对于functools.update_wrapper()函数：

functools.update_wrapper(wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

此函数的主要用途是包装修饰函数并返回wrapper函数。wrapper函数是包裹函数，wrapped函数就是被包裹函数。

更新wrapper函数，使其看起来像wrapped函数。可选参数assigned是元组，用于指定将原始函数的哪些属性直接分配给wrapper函数上匹配的属性，以及使用原始函数的相应属性更新wrapper函数的哪些属性（比如__dict__属性字典）。

>>> from functools import WRAPPER_ASSIGNMENTS

>>> WRAPPER_ASSIGNMENTS
('__module__', '__name__', '__qualname__', '__doc__', '__annotations__')

>>> from functools import WRAPPER_UPDATES

>>> WRAPPER_UPDATES
('__dict__',)

一般来说，使用默认参数即可，即functools.update_wrapper(wrapper, wrapped)。

• 对于functools.wraps()函数：

functools.wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

用于在定义wrapper函数（包裹函数）时调用update_wrapper()作为函数装饰器。它等价于partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)。作为wrapper函数的装饰器时参数是wrapped函数名（被包裹函数名）。

---

• 方案1示例：

from functools import update_wrapper

def my_decorator(func):
    def wrap(*args ,**kwargs):
        '''某功能包裹函数'''
        #此处实现某种功能
        return func(*args ,**kwargs)
    update_wrapper(wrap, func)              #保留被装饰函数元数据
    return wrap

@my_decorator
def xxx_func(a, b):
    '''xxx_func函数文档:...'''
    pass

print(xxx_func.__name__)
print(xxx_func.__doc__)

xxx_func                #结果
xxx_func函数文档:...

---

• 方案2示例：

from functools import wraps

def my_decorator(func):
    @wraps(func)                #保留被装饰函数元数据
    def wrap(*args ,**kwargs):
        '''某功能包裹函数'''
        #此处实现某种功能
        return func(*args ,**kwargs)
    return wrap

@my_decorator
def xxx_func(a, b):
    '''xxx_func函数文档:...'''
    pass

print(xxx_func.__name__)
print(xxx_func.__doc__)

xxx_func                #结果
xxx_func函数文档:..

上面两种方案都可以为被装饰函数保存元数据，方案2更为简便。

---