7.4 裝飾器
由于函數(shù)也是一個對象,而且函數(shù)對象可以被賦值給變量,所以,通過變量也能調用該函數(shù)。
函數(shù)對象有一個__name__
屬性,可以拿到函數(shù)的名字:
現(xiàn)在,假設我們要增強now()
函數(shù)的功能,比如,在函數(shù)調用前后自動打印日志,但又不希望修改now()
函數(shù)的定義,這種在代碼運行期間動態(tài)增加功能的方式,稱之為“裝飾器”(Decorator)。
本質上,decorator就是一個返回函數(shù)的高階函數(shù)。所以,我們要定義一個能打印日志的decorator,可以定義如下:
觀察上面的log
,因為它是一個decorator,所以接受一個函數(shù)作為參數(shù),并返回一個函數(shù)。我們要借助Python的@語法,把decorator置于函數(shù)的定義處:
調用now()
函數(shù),不僅會運行now()
函數(shù)本身,還會在運行now()
函數(shù)前打印一行日志:
把@log
放到now()
函數(shù)的定義處,相當于執(zhí)行了語句:
由于log()
是一個decorator,返回一個函數(shù),所以,原來的now()
函數(shù)仍然存在,只是現(xiàn)在同名的now
變量指向了新的函數(shù),于是調用now()
將執(zhí)行新函數(shù),即在log()
函數(shù)中返回的wrapper()
函數(shù)。
wrapper()
函數(shù)的參數(shù)定義是(*args, **kw)
,因此,wrapper()
函數(shù)可以接受任意參數(shù)的調用。在wrapper()
函數(shù)內,首先打印日志,再緊接著調用原始函數(shù)。
如果decorator本身需要傳入參數(shù),那就需要編寫一個返回decorator的高階函數(shù),寫出來會更復雜。比如,要自定義log的文本:
這個3層嵌套的decorator用法如下:
執(zhí)行結果如下:
和兩層嵌套的decorator相比,3層嵌套的效果是這樣的:
我們來剖析上面的語句,首先執(zhí)行log('execute')
,返回的是decorator
函數(shù),再調用返回的函數(shù),參數(shù)是now
函數(shù),返回值最終是wrapper
函數(shù)。
以上兩種decorator的定義都沒有問題,但還差最后一步。因為我們講了函數(shù)也是對象,它有__name__
等屬性,但你去看經過decorator裝飾之后的函數(shù),它們的__name__
已經從原來的'now'
變成了'wrapper'
:
因為返回的那個wrapper()
函數(shù)名字就是'wrapper'
,所以,需要把原始函數(shù)的__name__
等屬性復制到wrapper()
函數(shù)中,否則,有些依賴函數(shù)簽名的代碼執(zhí)行就會出錯。
不需要編寫wrapper.__name__ = func.__name__
這樣的代碼,Python內置的functools.wraps
就是干這個事的,所以,一個完整的decorator的寫法如下:
或者針對帶參數(shù)的decorator:
import functools
是導入functools
模塊。模塊的概念稍候講解?,F(xiàn)在,只需記住在定義wrapper()
的前面加上@functools.wraps(func)
即可。
小結
在面向對象(OOP)的設計模式中,decorator被稱為裝飾模式。OOP的裝飾模式需要通過繼承和組合來實現(xiàn),而Python除了能支持OOP的decorator外,直接從語法層次支持decorator。Python的decorator可以用函數(shù)實現(xiàn),也可以用類實現(xiàn)。
decorator可以增強函數(shù)的功能,定義起來雖然有點復雜,但使用起來非常靈活和方便。