轉載的，希望學習中方便查看，如果有需要修改，請聯繫我，謝謝！
原地址http://www.cnblogs.com/yuanchenqi/articles/5830025.html
裝飾器
在Python這個國家裏，裝飾器以及後面講到的迭代器，生成器都是十二分重要的高級函數。
如果將裝飾器比作取經路上的一個大boss，那麼想幹掉它必須拿到三件法寶
法寶一（作用域）：
法寶二（函數即對象）：
在python的世界裏，函數和我們之前的[1,2,3],'abc',8等一樣都是對象，而且函數是最高級的對象（對象是類的實例化，可以調用相應的方法，函數是包含變量對象的對象，牛逼！）。
1 2 3 4 5 6 7 8 9 10 | def foo(): print('i am the foo') bar() def bar(): print('i am the bar')foo()# def bar(): #報錯# print('i am the bar') |
帶着這個問題，我們聊一聊函數在內存的存儲情況：
圖1
函數對象的調用僅僅比其它對象多了一個()而已！foo,bar與a,b一樣都是個變量名。
那上面的問題也就解決了，只有函數加載到內存纔可以被調用。
既然函數是對象，那麼自然滿足下面兩個條件：
1. 其可以被賦給其他變量
1 2 3 4 5 6 | def foo(): print('foo')bar=foobar()foo()print(id(foo),id(bar)) #4321123592 4321123592 |
2. 其可以被定義在另外一個函數內(作爲參數&作爲返回值),類似於整形，字符串等對象。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | #*******函數名作爲參數**********def foo(func): print('foo') func()def bar(): print('bar')foo(bar)#*******函數名作爲返回值*********def foo(): print('foo') return bardef bar(): print('bar')b=foo()b() |
注意：這裏說的函數都是指函數名，比如foo；而foo()已經執行函數了，foo()是什麼類型取決於return的內容是什麼類型！！！
另外，如果大家理解不了對象，那麼就將函數理解成變量，因爲函數對象總會由一個或多個變量引用，比如foo，bar。
法寶三（函數的嵌套以及閉包）：
拋一個小問題：
1 2 3 4 5 6 | def foo(): print('foo') def bar(): print('bar') # bar()bar() |
是的，bar就是一個變量名，有自己的作用域的。
Python允許創建嵌套函數。通過在函數內部def的關鍵字再聲明一個函數即爲嵌套：
1 2 3 4 5 6 7 8 9 10 11 | #想執行inner函數,兩種方法def outer(): x = 1 def inner(): print (x) # 1 # inner() # 2 return inner# outer()in_func=outer()in_func() |
在這裏，你有沒有什麼疑問？如果沒有，那我問你：
1 兩種調用方式有區別嗎，不都是在外面調用inner嗎？
1 2 3 4 | in_func=outer() in_func() ###########inner()(已經加載到內存啦) |
def outer(): x = 1 def inner(): b=6 print (x) return inner #inner()#報錯原因:找不到這個引用變量 in_func=outer()#這裏其實就是一個變量賦值,將inner的引用對象賦值給in_func,類似於a=5,b=a一樣 #有同學會想直接賦值不行嗎:in_func=inner? 哥,inner不還是找不到嗎,對吧 in_func()
2
1 2 3 | def outer(): x=1 #函數outer執行完畢即被銷燬print(x) |
既然這樣，i()執行的時候outer函數已經執行完了，爲什麼inner還可以調用outer裏的變量x呢？
哈，這就涉及到我們叫講的閉包啦！
因爲：outer裏return的inner是一個閉包函數，有x這個環境變量。
OK，那麼什麼是閉包呢？
閉包(closure)是函數式編程的重要的語法結構。
定義：如果在一個內部函數裏，對在外部作用域（但不是在全局作用域）的變量進行引用，那麼內部函數就被認爲是閉包(closure).
如上實例，inner就是內部函數，inner裏引用了外部作用域的變量x（x在外部作用域outer裏面，不是全局作用域），
則這個內部函數inner就是一個閉包。
再稍微講究一點的解釋是，閉包=函數塊+定義函數時的環境，inner就是函數塊，x就是環境，當然這個環境可以有很多，不止一個簡單的x。
1 | print(in_func.__closure__[0].cell_contents) |
用途省略
# 用途1：當閉包執行完後，仍然能夠保持住當前的運行環境。 # 比如說，如果你希望函數的每次執行結果，都是基於這個函數上次的運行結果。我以一個類似棋盤遊戲的例子 # 來說明。假設棋盤大小爲50*50，左上角爲座標系原點(0,0)，我需要一個函數，接收2個參數，分別爲方向 # (direction)，步長(step)，該函數控制棋子的運動。棋子運動的新的座標除了依賴於方向和步長以外， # 當然還要根據原來所處的座標點，用閉包就可以保持住這個棋子原來所處的座標。 origin = [0, 0] # 座標系統原點 legal_x = [0, 50] # x軸方向的合法座標 legal_y = [0, 50] # y軸方向的合法座標 def create(pos=origin): def player(direction,step): # 這裏應該首先判斷參數direction,step的合法性，比如direction不能斜着走，step不能爲負等 # 然後還要對新生成的x，y座標的合法性進行判斷處理，這裏主要是想介紹閉包，就不詳細寫了。 new_x = pos[0] + direction[0]*step new_y = pos[1] + direction[1]*step pos[0] = new_x pos[1] = new_y #注意！此處不能寫成 pos = [new_x, new_y]，原因在上文有說過 return pos return player player = create() # 創建棋子player，起點爲原點 print (player([1,0],10)) # 向x軸正方向移動10步 print (player([0,1],20)) # 向y軸正方向移動20步 print (player([-1,0],10)) # 向x軸負方向移動10步
# 用途2：閉包可以根據外部作用域的局部變量來得到不同的結果，這有點像一種類似配置功能的作用，我們可以 # 修改外部的變量，閉包根據這個變量展現出不同的功能。比如有時我們需要對某些文件的特殊行進行分析，先 # 要提取出這些特殊行。 def make_filter(keep): def the_filter(file_name): file = open(file_name) lines = file.readlines() file.close() filter_doc = [i for i in lines if keep in i] return filter_doc return the_filter # 如果我們需要取得文件"result.txt"中含有"pass"關鍵字的行，則可以這樣使用例子程序 filter = make_filter("pass") filter_result = filter("result.txt")
裝飾器概念
說了這麼多，終於到了我們的裝飾器了。
裝飾器本質上是一個函數，該函數用來處理其他函數，它可以讓其他函數在不需要修改代碼的前提下增加額外的功能，裝飾器的返回值也是一個函數對象。它經常用於有切面需求的場景，比如：插入日誌、性能測試、事務處理、緩存、權限校驗等應用場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函數功能本身無關的雷同代碼並繼續重用。概括的講，裝飾器的作用就是爲已經存在的對象添加額外的功能。
業務生產中大量調用的函數：
1 2 3 | def foo(): print('hello foo')foo() |
現在有一個新的需求，希望可以記錄下函數的執行時間，於是在代碼中添加日誌代碼：
1 2 3 4 5 6 7 8 9 | import timedef 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函數裏調用時間函數？這樣就造成大量雷同的代碼，爲了減少重複寫代碼，我們可以這樣做，重新定義一個函數：專門設定時間:
1 2 3 4 5 6 7 8 9 10 11 12 13 | import timedef 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()與裝飾函數時間計算，修改如下：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | 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)。
@符號是裝飾器的語法糖，在定義函數的時候使用，避免再一次賦值操作
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | 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是一個閉包函數。
key：
@show_time幫我們做的事情就是當我們執行業務邏輯foo()時，執行的代碼由粉框部分轉到藍框部分，僅此而已！
裝飾器在Python使用如此方便都要歸因於Python的函數能像普通的對象一樣能作爲參數傳遞給其他函數，可以被賦值給其他變量，可以作爲返回值，可以被定義在另外一個函數內。
帶參數的被裝飾函數
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | 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 time def 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 ret return wrapper @show_time #add=show_time(add) def add(a,b): time.sleep(1) return a+b print(add(2,5))
不定長參數
#***********************************不定長參數 import time 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)) return wrapper @show_time #add=show_time(add) def add(*args,**kwargs): time.sleep(1) sum=0 for i in args: sum+=i print(sum) add(2,4,8,9)
帶參數的裝飾器
裝飾器還有更大的靈活性，例如帶參數的裝飾器：在上面的裝飾器調用中，比如@show_time，該裝飾器唯一的參數就是執行業務的函數。裝飾器的語法允許我們在調用時，提供其它參數，比如@decorator(a)。這樣，就爲裝飾器的編寫和使用提供了更大的靈活性。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | 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 wrapper return show_time@time_logger(3)def add(*args,**kwargs): time.sleep(1) sum=0 for i in args: sum+=i print(sum)add(2,7,5) |
@time_logger(3) 做了兩件事：
（1）time_logger(3)：得到閉包函數show_time，裏面保存環境變量flag
（2）@show_time ：add＝show_time(add)
上面的time_logger是允許帶參數的裝飾器。它實際上是對原有裝飾器的一個函數封裝，並返回一個裝飾器(一個含有參數的閉包函數)。當我 們使用@time_logger(3)調用的時候，Python能夠發現這一層的封裝，並把參數傳遞到裝飾器的環境中。
多層裝飾器
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | def makebold(fn): def wrapper(): return "<b>" + fn() + "</b>" return wrapperdef makeitalic(fn): def wrapper(): return "<i>" + fn() + "</i>" return wrapper@makebold@makeitalicdef hello(): return "hello alvin"hello() |
過程：
類裝飾器
再來看看類裝飾器，相比函數裝飾器，類裝飾器具有靈活度大、高內聚、封裝性等優點。使用類裝飾器還可以依靠類內部的__call__方法，當使用 @ 形式將裝飾器附加到函數上時，就會調用此方法。
import time class Foo(object): def __init__(self, func): self._func = func def __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 * x print(cal.__name__) ######## # foo # wrapper
解釋：1 2 3 | @loggeddef f(x): return x + x * x |
等價於：
1 2 3 | def f(x): return x + x * xf = logged(f) |
不難發現，函數f被wrapper取代了，當然它的docstring，__name__就是變成了wrapper函數的信息了。1 2 | print f.__name__ # prints 'wrapper'print f.__doc__ # prints None |
這個問題就比較嚴重的，好在我們有functools.wraps，wraps本身也是一個裝飾器，它能把原函數的元信息拷貝到裝飾器函數中，這使得裝飾器函數也有和原函數一樣的元信息了。1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | from functools import wrapsdef logged(func): @wraps(func) def wrapper(*args, **kwargs): print (func.__name__ + " was called") return func(*args, **kwargs) return wrapper@loggeddef cal(x): return x + x * xprint(cal.__name__) #cal |
內置裝飾器
@staticmathod
@classmethod
@property
學習類的時候我們詳細介紹的...
補充
##----------------------------------------foo函數先加載到內存,然後foo變量指向新的引用,所以遞歸裏的foo是wrapper函數對象 # def show_time(func): # # def wrapper(n): # ret=func(n) # print("hello,world") # return ret # return wrapper # # @show_time# foo=show_time(foo) # def foo(n): # if n==1: # return 1 # return n*foo(n-1) # print(foo(6)) ######################## def show_time(func): def wrapper(n): ret=func(n) print("hello,world") return ret return wrapper @show_time# foo=show_time(foo) def foo(n): def _foo(n): if n==1: return 1 return n*_foo(n-1) return _foo(n) print(foo(6))