python裝飾器中functools.wraps的作用詳解

直接上代碼看效果:

　　# 定義一個最簡單的裝飾器

　　def user_login_data(f): 　　　　def wrapper(*args, **kwargs): 　　　　　　return f(*args, **kwargs) 　　　　return wrapper 　　# 用裝飾器裝飾以下兩個函數
　　 　　@user_login_data 　　def num1(): 　　　　print("aaa") 　　@user_login_data 　　def num2(): 　　　　print("bbbb") 　　if __name__ == '__main__': 　　　　print(num1.__name__) 　　　　print(num2.__name__)

 

　以上代碼的輸出結果為:

　　　　wrapper

　　　　wrapper

 

由此函數使用裝飾器時,函數的函數名即 __name__已經被裝飾器改變.

一般定義裝飾器的話可以不用考慮這點,但是如果多個函數被兩個裝飾器裝飾時就報錯,因為兩個函數名一樣,第二個函數再去裝飾的話就報錯.

解決方案就是引入  functools.wraps  ,以上代碼的解決如下: 

　　　　

　　　　def user_login_data(f): 　　　　@functools.wraps(f) 　　　　　　def wrapper(*args, **kwargs): 　　　　　　　　return f(*args, **kwargs) 　　　　　　return wrapper

 

增加@functools.wraps(f), 可以保持當前裝飾器去裝飾的函數的 __name__ 的值不變

以上輸出結果就是: 

　　　　num1

　　　　num2

Python裝飾器（decorator）在實現的時候，有一些細節需要被注意。例如，被裝飾后的函數其實已經是另外一個函數了（函數名等函數屬性會發生改變）。這樣有時候會對程序造成一些不便，例如筆者想對flask框架中的一些函數添加自定義的decorator，添加后由於函數名和函數的doc發生了改變，對測試結果有一些影響。

所以，Python的functools包中提供了一個叫wraps的decorator來消除這樣的副作用。寫一個decorator的時候，最好在實現之前加上functools的wrap，它能保留原有函數的名稱和docstring。