預備知識

在瞭解wraps修飾器之前，我們首先要了解partial和update_wrapper這兩個函式，因為在wraps的程式碼中，用到了這兩個函式。

partial

首先說partial函式，在官方文件的描述中，這個函式的宣告如下：functools.partial(func, *args, **keywords)。它的作用就是返回一個partial物件，當這個partial物件被呼叫的時候，就像通過func(*args, **kwargs)的形式來呼叫func函式一樣。如果有額外的 位置引數(args) 或者 關鍵字引數(*kwargs) 被傳給了這個partial物件，那它們也都會被傳遞給func

個人感覺這個函式很像C++中的bind函式，都是把某個函式的某個引數固定，從而構造出一個新的函式來。比如下面這個例子：

from functools import partial

def add(x:int, y:int):
    return x+y

# 這裡創造了一個新的函式add2，只接受一個整型引數，然後將這個引數統一加上2
add2 = partial(add, y=2)

add2(3)  # 這裡將會輸出5

這個函式是使用C而不是Python實現的，但是官方文件中給出了Python實現的程式碼，如下所示，大家可以進行參考：

def partial(func, *args, **keywords):
    def newfunc(*fargs, **fkeywords):
        newkeywords = keywords.copy()
        newkeywords.update(fkeywords)
        return func(*args, *fargs, **newkeywords)
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc
 

update_wrapper

接下來，我們再來聊一聊update_wrapper這個函式，顧名思義，這個函式就是用來更新修飾器函式的，具體更新些什麼呢，我們可以直接把它的原始碼搬過來看一下：

WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
                       '__annotations__')
WRAPPER_UPDATES = ('__dict__',)
def update_wrapper(wrapper,
                   wrapped,
                   assigned = WRAPPER_ASSIGNMENTS,
                   updated = 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, {}))
    wrapper.__wrapped__ = wrapped
    return wrapper

大家可以發現，這個函式的作用就是從 被修飾的函式(wrapped) 中取出一些屬性值來，賦值給 修飾器函式(wrapper) 。為什麼要這麼做呢，我們看下面這個例子。

自定義修飾器v1

首先我們寫個自定義的修飾器，沒有任何的功能，僅有文件字串，如下所示：

def wrapper(f):
    def wrapper_function(*args, **kwargs):
        """這個是修飾函式"""
        return f(*args, **kwargs)
    return wrapper_function
    
@wrapper
def wrapped():
    """這個是被修飾的函式"""
    print('wrapped')

print(wrapped.__doc__)  # 輸出`這個是修飾函式`
print(wrapped.__name__)  # 輸出`wrapper_function`

從上面的例子我們可以看到，我想要獲取wrapped這個被修飾函式的文件字串，但是卻獲取成了wrapper_function的文件字串，wrapped函式的名字也變成了wrapper_function函式的名字。這是因為給wrapped新增上@wrapper修飾器相當於執行了一句wrapped = wrapper(wrapped)，執行完這條語句之後，wrapped函式就變成了wrapper_function函式。遇到這種情況該怎麼辦呢，首先我們可以手動地在wrapper函式中更改wrapper_function的__doc__和__name__屬性，但聰明的你肯定也想到了，我們可以直接用update_wrapper函式來實現這個功能。

自定義修飾器v2

我們對上面定義的修飾器稍作修改，添加了一句update_wrapper(wrapper_function, f)。

from functools import update_wrapper

def wrapper(f):
    def wrapper_function(*args, **kwargs):
        """這個是修飾函式"""
        return f(*args, **kwargs)
    update_wrapper(wrapper_function, f)  # <<  添加了這條語句
    return wrapper_function
    
@wrapper
def wrapped():
    """這個是被修飾的函式"""
    print('wrapped')


print(wrapped.__doc__)  # 輸出`這個是被修飾的函式`
print(wrapped.__name__)  # 輸出`wrapped`

此時我們可以發現，__doc__和__name__屬性已經能夠按我們預想的那樣顯示了，除此之外，update_wrapper函式也對__module__和__dict__等屬性進行了更改和更新。

wraps修飾器

OK，至此，我們已經瞭解了partial和update_wrapper這兩個函式的功能，接下來我們翻出wraps修飾器的原始碼：

WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
                       '__annotations__')
WRAPPER_UPDATES = ('__dict__',)
def wraps(wrapped,
          assigned = WRAPPER_ASSIGNMENTS,
          updated = WRAPPER_UPDATES):
    return partial(update_wrapper, wrapped=wrapped,
                   assigned=assigned, updated=updated)

沒錯，就是這麼的簡單，只有這麼一句，我們可以看出，wraps函式其實就是一個修飾器版的update_wrapper函式，它的功能和update_wrapper是一模一樣的。我們可以修改我們上面的自定義修飾器的例子，做出一個更方便閱讀的版本。

自定義修飾器v3

from functools import wraps

def wrapper(f):
    @wraps(f)
    def wrapper_function(*args, **kwargs):
        """這個是修飾函式"""
        return f(*args, **kwargs)
    return wrapper_function
    
@wrapper
def wrapped():
    """這個是被修飾的函式
    """
    print('wrapped')

print(wrapped.__doc__)  # 輸出`這個是被修飾的函式`
print(wrapped.__name__)  # 輸出`wrapped`

至此，我想大家應該明白wraps這個修飾器的作用了吧，就是將 被修飾的函式(wrapped) 的一些屬性值賦值給 修飾器函式(wrapper) ，最終讓屬性的顯示更符合我們的直覺。