一.簡單裝飾器

裝飾器其實就是一個以函數作為參數并返回一個替換函數的可執行函數。本質上就是一個函數，該函數用來處理其他函數，它可以讓其他函數在不需要修改代碼的前提下增加額外的功能，裝飾器的返回值也是一個函數對象，它經常用于有切面需求的場景，比如：插入日志、性能測試、事務處理、緩存、權限校驗等應用場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函數功能本身無關的雷同代碼并繼續重用。

概括的講，裝飾器的作用就是為已經存在的對象添加額外的功能。

從一個例子說起：

業務生產中大量調用的函數：：

def foo():print('hello foo') foo()

現在有一個新的需求，希望可以記錄下函數的執行時間，于是在代碼中添加日志代碼：

import time def foo():start_time=time.time()print('hello foo')time.sleep(3)end_time=time.time()print('spend %s'%(end_time-start_time))foo()

bar()、bar2()也有類似的需求，怎么做？再在bar函數里調用時間函數？這樣就造成大量雷同的代碼，為了減少重復寫代碼，我們可以這樣做，重新定義一個函數：專門設定時間:

import time def show_time(func):start_time=time.time()func()end_time=time.time()print('spend %s'%(end_time-start_time))def foo():print('hello foo')time.sleep(3)show_time(foo)

邏輯上不難理解，而且運行正常。 但是這樣的話,你基礎平臺的函數修改了名字，容易被業務線的人投訴的，因為我們每次都要將一個函數作為參數傳遞給show_time函數。而且這種方式已經破壞了原有的代碼邏輯結構，之前執行業務邏輯時，執行運行foo()，但是現在不得不改成show_time(foo)。那么有沒有更好的方式的呢？當然有，答案就是裝飾器。

if foo()==show_time(foo) :問題解決!

所以，我們需要show_time(foo)返回一個函數對象，而這個函數對象內則是核心業務函數:執行func()與裝飾函數時間計算，修改如下：

import timedef show_time(func):def wrapper():start_time=time.time()func()end_time=time.time()print('spend %s'%(end_time-start_time))return wrapperdef foo():print('hello foo')time.sleep(3)foo=show_time(foo) foo()

函數show_time就是裝飾器，它把真正的業務方法func包裹在函數里面，看起來像foo被上下時間函數裝飾了。在這個例子中，函數進入和退出時 ，被稱為一個橫切面(Aspect)，這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。

@符號是裝飾器的語法糖，在定義函數的時候使用，避免再一次賦值操作

import timedef show_time(func):def wrapper():start_time=time.time()func()end_time=time.time()print('spend %s'%(end_time-start_time))return wrapper@show_time #foo=show_time(foo) def foo():print('hello foo')time.sleep(3)@show_time #bar=show_time(bar) def bar():print('in the bar')time.sleep(2)foo() print('***********') bar()

如上所示，這樣我們就可以省去bar = show_time(bar)這一句了，直接調用bar()即可得到想要的結果。如果我們有其他的類似函數，我們可以繼續調用裝飾器來修飾函數，而不用重復修改函數或者增加新的封裝。這樣，我們就提高了程序的可重復利用性，并增加了程序的可讀性。

這里需要注意的問題：

foo=show_time(foo)其實是把wrapper引用的對象引用給了foo，而wrapper里的變量func之所以可以用，就是因為wrapper是一個閉包函數。

二.帶參數的被裝飾函數

import timedef show_time(func):def wrapper(a,b):start_time=time.time()func(a,b)end_time=time.time()print('spend %s'%(end_time-start_time))return wrapper@show_time #add=show_time(add) def add(a,b):time.sleep(1)print(a+b)add(2,4)

import timedef show_time(func):def wrapper(a,b):start_time=time.time()ret=func(a,b)end_time=time.time()print('spend %s'%(end_time-start_time))return retreturn wrapper@show_time #add=show_time(add) def add(a,b):time.sleep(1)return a+bprint(add(2,5))

不定長參數

import timedef show_time(func):def wrapper(*args,**kwargs):start_time=time.time()func(*args,**kwargs)end_time=time.time()print('spend %s'%(end_time-start_time))return wrapper@show_time #add=show_time(add) def add(*args,**kwargs):time.sleep(1)sum=0for i in args:sum+=iprint(sum)add(2,4,8,9)

三.帶參數的裝飾器

裝飾器還有更大的靈活性，例如帶參數的裝飾器：在上面的裝飾器調用中，比如@show_time，該裝飾器唯一的參數就是執行業務的函數。裝飾器的語法允許我們在調用時，提供其它參數，比如@decorator(a)。這樣，就為裝飾器的編寫和使用提供了更大的靈活性。

import timedef time_logger(flag=0):def show_time(func):def wrapper(*args,**kwargs):start_time=time.time()func(*args,**kwargs)end_time=time.time()print('spend %s'%(end_time-start_time))if flag:print('將這個操作的時間記錄到日志中')return wrapperreturn show_time@time_logger(3) def add(*args,**kwargs):time.sleep(1)sum=0for i in args:sum+=iprint(sum)add(2,7,5)

@time_logger(3)做了兩件事：

（1）ime_logger(3)：得到閉包函數show_time，里面保存環境變量flag

（2）@show_time ：add＝show_time(add)

上面的time_logger是允許帶參數的裝飾器。它實際上是對原有裝飾器的一個函數封裝，并返回一個裝飾器(一個含有參數的閉包函數)。當我 們使用@time_logger(3)調用的時候，Python能夠發現這一層的封裝，并把參數傳遞到裝飾器的環境中。

四，多層裝飾器

def makebold(fn):def wrapper():return "<b>" + fn() + "</b>"return wrapperdef makeitalic(fn):def wrapper():return "<i>" + fn() + "</i>"return wrapper@makebold @makeitalic def hello():return "hello alvin"hello()

過程：

五.類裝飾器

再來看看類裝飾器，相比函數裝飾器，類裝飾器具有靈活度大、高內聚、封裝性等優點。使用類裝飾器還可以依靠類內部的__call__方法，當使用 @ 形式將裝飾器附加到函數上時，就會調用此方法。

''' 學習中遇到問題沒人解答？小編創建了一個Python學習交流QQ群：725638078 尋找有志同道合的小伙伴，互幫互助,群里還有不錯的視頻學習教程和PDF電子書！ ''' import timeclass Foo(object):def __init__(self, func):self._func = funcdef __call__(self):start_time=time.time()self._func()end_time=time.time()print('spend %s'%(end_time-start_time))@Foo #bar=Foo(bar)def bar():print ('bar')time.sleep(2)bar() #bar=Foo(bar)()>>>>>>>沒有嵌套關系了,直接active Foo的 __call__方法

六.functools.wraps

使用裝飾器極大地復用了代碼，但是他有一個缺點就是原函數的元信息不見了，比如函數的docstring、__name__、參數列表，先看例子：

def foo():print("hello foo")print(foo.__name__) #####################def logged(func):def wrapper(*args, **kwargs):print (func.__name__ + " was called")return func(*args, **kwargs)return wrapper@logged def cal(x):return x + x * xprint(cal.__name__)######## # foo # wrapper

解釋：

@logged def f(x):return x + x * x

等價于：

def f(x):return x + x * x f = logged(f)

不難發現，函數f被wrapper取代了，當然它的docstring，__name__就是變成了wrapper函數的信息了。

print (f.__name__ ) # prints 'wrapper' print (f.__doc__ ) # prints None

這個問題就比較嚴重的，好在我們有functools.wraps，wraps本身也是一個裝飾器，它能把原函數的元信息拷貝到裝飾器函數中，這使得裝飾器函數也有和原函數一樣的元信息了。

from functools import wrapsdef logged(func):@wraps(func)def wrapper(*args, **kwargs):print (func.__name__ + " was called")return func(*args, **kwargs)return wrapper@logged def cal(x):return x + x * xprint(cal.__name__) #cal

結尾給大家推薦一個非常好的學習教程，希望對你學習Python有幫助！

Python基礎入門教程推薦：←點擊左邊藍色文字就可以跳轉觀看了

Python爬蟲案例教程推薦：←點擊左邊藍色文字就可以跳轉觀看了

總結

以上是生活随笔為你收集整理的一篇文章带你从认识Python装饰器到熟练使用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。