由于函數(shù)也是一個(gè)對(duì)象,而且函數(shù)對(duì)象可以被賦值給變量,所以,通過(guò)變量也能調(diào)用該函數(shù)。
1
2
3
4
5
6
|
>>> def now(): ... print '2013-12-25' ... >>> f = now >>> f() 2013 - 12 - 25 |
函數(shù)對(duì)象有一個(gè)__name__屬性,可以拿到函數(shù)的名字:
1
2
3
4
|
>>> now.__name__ 'now' >>> f.__name__ 'now' |
現(xiàn)在,假設(shè)我們要增強(qiáng)now()函數(shù)的功能,比如,在函數(shù)調(diào)用前后自動(dòng)打印日志,但又不希望修改now()函數(shù)的定義,這種在代碼運(yùn)行期間動(dòng)態(tài)增加功能的方式,稱之為“裝飾器”(Decorator)。
本質(zhì)上,decorator就是一個(gè)返回函數(shù)的高階函數(shù)。所以,我們要定義一個(gè)能打印日志的decorator,可以定義如下:
1
2
3
4
5
|
def log(func): def wrapper( * args, * * kw): print 'call %s():' % func.__name__ return func( * args, * * kw) return wrapper |
觀察上面的log,因?yàn)樗且粋€(gè)decorator,所以接受一個(gè)函數(shù)作為參數(shù),并返回一個(gè)函數(shù)。我們要借助Python的@語(yǔ)法,把decorator置于函數(shù)的定義處:
1
2
3
|
@log def now(): print '2013-12-25' |
調(diào)用now()函數(shù),不僅會(huì)運(yùn)行now()函數(shù)本身,還會(huì)在運(yùn)行now()函數(shù)前打印一行日志:
1
2
3
|
>>> now() call now(): 2013 - 12 - 25 |
把@log放到now()函數(shù)的定義處,相當(dāng)于執(zhí)行了語(yǔ)句:
1
|
now = log(now) |
由于log()是一個(gè)decorator,返回一個(gè)函數(shù),所以,原來(lái)的now()函數(shù)仍然存在,只是現(xiàn)在同名的now變量指向了新的函數(shù),于是調(diào)用now()將執(zhí)行新函數(shù),即在log()函數(shù)中返回的wrapper()函數(shù)。
wrapper()函數(shù)的參數(shù)定義是(*args, **kw),因此,wrapper()函數(shù)可以接受任意參數(shù)的調(diào)用。在wrapper()函數(shù)內(nèi),首先打印日志,再緊接著調(diào)用原始函數(shù)。
如果decorator本身需要傳入?yún)?shù),那就需要編寫(xiě)一個(gè)返回decorator的高階函數(shù),寫(xiě)出來(lái)會(huì)更復(fù)雜。比如,要自定義log的文本:
1
2
3
4
5
6
7
|
def log(text): def decorator(func): def wrapper( * args, * * kw): print '%s %s():' % (text, func.__name__) return func( * args, * * kw) return wrapper return decorator |
這個(gè)3層嵌套的decorator用法如下:
1
2
3
|
@log ( 'execute' ) def now(): print '2013-12-25' |
執(zhí)行結(jié)果如下:
1
2
3
|
>>> now() execute now(): 2013 - 12 - 25 |
和兩層嵌套的decorator相比,3層嵌套的效果是這樣的:
1
|
>>> now = log( 'execute' )(now) |
我們來(lái)剖析上面的語(yǔ)句,首先執(zhí)行l(wèi)og('execute'),返回的是decorator函數(shù),再調(diào)用返回的函數(shù),參數(shù)是now函數(shù),返回值最終是wrapper函數(shù)。
以上兩種decorator的定義都沒(méi)有問(wèn)題,但還差最后一步。因?yàn)槲覀冎v了函數(shù)也是對(duì)象,它有__name__等屬性,但你去看經(jīng)過(guò)decorator裝飾之后的函數(shù),它們的__name__已經(jīng)從原來(lái)的'now'變成了'wrapper':
1
2
|
>>> now.__name__ 'wrapper' |
因?yàn)榉祷氐哪莻€(gè)wrapper()函數(shù)名字就是'wrapper',所以,需要把原始函數(shù)的__name__等屬性復(fù)制到wrapper()函數(shù)中,否則,有些依賴函數(shù)簽名的代碼執(zhí)行就會(huì)出錯(cuò)。
不需要編寫(xiě)wrapper.__name__ = func.__name__這樣的代碼,Python內(nèi)置的functools.wraps就是干這個(gè)事的,所以,一個(gè)完整的decorator的寫(xiě)法如下:
1
2
3
4
5
6
7
8
|
import functools def log(func): @functools .wraps(func) def wrapper( * args, * * kw): print 'call %s():' % func.__name__ return func( * args, * * kw) return wrapper |
或者針對(duì)帶參數(shù)的decorator:
1
2
3
4
5
6
7
8
9
10
|
import functools def log(text): def decorator(func): @functools .wraps(func) def wrapper( * args, * * kw): print '%s %s():' % (text, func.__name__) return func( * args, * * kw) return wrapper return decorator |
import functools是導(dǎo)入functools模塊。模塊的概念稍候講解。現(xiàn)在,只需記住在定義wrapper()的前面加上@functools.wraps(func)即可。
小結(jié)
在面向?qū)ο螅∣OP)的設(shè)計(jì)模式中,decorator被稱為裝飾模式。OOP的裝飾模式需要通過(guò)繼承和組合來(lái)實(shí)現(xiàn),而Python除了能支持OOP的decorator外,直接從語(yǔ)法層次支持decorator。Python的decorator可以用函數(shù)實(shí)現(xiàn),也可以用類實(shí)現(xiàn)。
decorator可以增強(qiáng)函數(shù)的功能,定義起來(lái)雖然有點(diǎn)復(fù)雜,但使用起來(lái)非常靈活和方便。
請(qǐng)編寫(xiě)一個(gè)decorator,能在函數(shù)調(diào)用的前后打印出'begin call'和'end call'的日志。
再思考一下能否寫(xiě)出一個(gè)@log的decorator,使它既支持:
1
2
3
|
@log def f(): pass |
又支持:
1
2
3
|
@log ( 'execute' ) def f(): pass |