Python 裝飾器使用詳解
裝飾器本質(zhì)上是一個(gè)Python函數(shù),它可以讓其他函數(shù)在不需要做任何代碼變動(dòng)的前提下增加額外功能,裝飾器的返回值也是一個(gè)函數(shù)對(duì)象.
經(jīng)常用于有切面需求的場(chǎng)景,比如:插入日志、性能測(cè)試、事務(wù)處理、緩存、權(quán)限校驗(yàn)等場(chǎng)景。裝飾器是解決這類問(wèn)題的絕佳設(shè)計(jì),有了裝飾器,我們就可以抽離出大量與函數(shù)功能本身無(wú)關(guān)的雷同代碼并繼續(xù)重用。
先來(lái)看一個(gè)簡(jiǎn)單例子:
def now():
print('2017_7_29')
現(xiàn)在有一個(gè)新的需求,希望可以記錄下函數(shù)的執(zhí)行日志,于是在代碼中添加日志代碼:
def now():
print('2017_7_29')
logging.warn("running")
假設(shè)有類似的多個(gè)需求,怎么做?再寫(xiě)一個(gè)logging在now函數(shù)里?這樣就造成大量雷同的代碼,為了減少重復(fù)寫(xiě)代碼,我們可以這樣做,重新定義一個(gè)函數(shù):專門(mén)處理日志 ,日志處理完之后再執(zhí)行真正的業(yè)務(wù)代碼.
def use_logging(func):
logging.warn("%s is running" % func.__name__)
func()
def now():
print('2017_7_29')
use_logging(now)
在實(shí)現(xiàn),邏輯上不難, 但是這樣的話,我們每次都要將一個(gè)函數(shù)作為參數(shù)傳遞給日志函數(shù)。而且這種方式已經(jīng)破壞了原有的代碼邏輯結(jié)構(gòu),之前執(zhí)行業(yè)務(wù)邏輯時(shí),執(zhí)行運(yùn)行now(),但是現(xiàn)在不得不改成use_logging(now)。那么有沒(méi)有更好的方式的呢?當(dāng)然有,答案就是裝飾器。
首先要明白函數(shù)也是一個(gè)對(duì)象,而且函數(shù)對(duì)象可以被賦值給變量,所以,通過(guò)變量也能調(diào)用該函數(shù)。例如:
def now():
print('2017_7_28')
f=now
f()
# 函數(shù)對(duì)象有一個(gè)__name__屬性,可以拿到函數(shù)的名字
print('now.__name__:',now.__name__)
print('f.__name__:',f.__name__)
簡(jiǎn)單裝飾器
本質(zhì)上,decorator就是一個(gè)返回函數(shù)的高階函數(shù)。所以,我們要定義一個(gè)能打印日志的decorator,可以定義如下:
def log(func):
def wrapper(*args,**kw):
print('call %s():'%func.__name__)
return func(*args,**kw)
return wrapper
# 由于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ù)。
上面的log,因?yàn)樗且粋€(gè)decorator,所以接受一個(gè)函數(shù)作為參數(shù),并返回一個(gè)函數(shù).現(xiàn)在執(zhí)行:
now = log(now) now()
輸出結(jié)果:
call now():
2017_7_28
函數(shù)log就是裝飾器,它把執(zhí)行真正業(yè)務(wù)方法的func包裹在函數(shù)里面,看起來(lái)像now被log裝飾了。在這個(gè)例子中,函數(shù)進(jìn)入時(shí) ,被稱為一個(gè)橫切面(Aspect),這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。
使用語(yǔ)法糖:
@log
def now():
print('2017_7_28')
@符號(hào)是裝飾器的語(yǔ)法糖,在定義函數(shù)的時(shí)候使用,避免再一次賦值操作
這樣我們就可以省去now = log(now)這一句了,直接調(diào)用now()即可得到想要的結(jié)果。如果我們有其他的類似函數(shù),我們可以繼續(xù)調(diào)用裝飾器來(lái)修飾函數(shù),而不用重復(fù)修改函數(shù)或者增加新的封裝。這樣,我們就提高了程序的可重復(fù)利用性,并增加了程序的可讀性。
裝飾器在Python使用如此方便都要?dú)w因于Python的函數(shù)能像普通的對(duì)象一樣能作為參數(shù)傳遞給其他函數(shù),可以被賦值給其他變量,可以作為返回值,可以被定義在另外一個(gè)函數(shù)內(nèi)。
帶參數(shù)的裝飾器:
如果decorator本身需要傳入?yún)?shù),那就需要編寫(xiě)一個(gè)返回decorator的高階函數(shù),寫(xiě)出來(lái)會(huì)復(fù)雜一點(diǎn)。比如,要自定義log的文本:
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用法如下:
@log('goal')
def now():
print('2017-7-28')
now()
等價(jià)于
now = log('goal')(now)
# 首先執(zhí)行l(wèi)og('execute'),返回的是decorator函數(shù),再調(diào)用返回的函數(shù),參數(shù)是now函數(shù),返回值最終是wrapper函數(shù)
now()
因?yàn)槲覀冎v了函數(shù)也是對(duì)象,它有__name__等屬性,但你去看經(jīng)過(guò)decorator裝飾之后的函數(shù),它們的__name__已經(jīng)從原來(lái)的'now'變成了'wrapper':
print(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ě)法如下:
import functools
def log(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
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
類裝飾器:
再來(lái)看看類裝飾器,相比函數(shù)裝飾器,類裝飾器具有靈活度大、高內(nèi)聚、封裝性等優(yōu)點(diǎn)。使用類裝飾器還可以依靠類內(nèi)部的__call__方法,當(dāng)使用 @ 形式將裝飾器附加到函數(shù)上時(shí),就會(huì)調(diào)用此方法
import time
class Foo(object):
def __init__(self, func):
self._func = func
def __call__(self):
print ('class decorator runing')
self._func()
print ('class decorator ending')
@Foo
def now():
print (time.strftime('%Y-%m-%d',time.localtime(time.time())))
now()
總結(jié):
概括的講,裝飾器的作用就是為已經(jīng)存在的對(duì)象添加額外的功能?! ?/p>
同時(shí)在面向?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)。
相關(guān)文章
Python的matplotlib繪圖如何修改背景顏色的實(shí)現(xiàn)
這篇文章主要介紹了Python的matplotlib繪圖如何修改背景顏色的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07
Python 語(yǔ)言實(shí)現(xiàn)六大查找算法
本文給大家分享Python 語(yǔ)言實(shí)現(xiàn)六大查找算法,針對(duì)每種算法通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友參考下吧2021-06-06
使用Pandas對(duì)數(shù)據(jù)進(jìn)行篩選和排序的實(shí)現(xiàn)
這篇文章主要介紹了使用Pandas對(duì)數(shù)據(jù)進(jìn)行篩選和排序的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07
利用Python制作動(dòng)態(tài)排名圖的實(shí)現(xiàn)代碼
這篇文章主要介紹了利用Python制作動(dòng)態(tài)排名圖的實(shí)現(xiàn)代碼,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-04-04
Keras中的多分類損失函數(shù)用法categorical_crossentropy
這篇文章主要介紹了Keras中的多分類損失函數(shù)用法categorical_crossentropy,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-06-06
python Pandas庫(kù)基礎(chǔ)分析之時(shí)間序列的處理詳解
這篇文章主要介紹了python Pandas庫(kù)基礎(chǔ)分析之時(shí)間序列的處理詳解,Pandas作為Python環(huán)境下的數(shù)據(jù)分析庫(kù),更是提供了強(qiáng)大的日期數(shù)據(jù)處理的功能,是處理時(shí)間序列的利器,需要的朋友可以參考下2019-07-07
Python中WebService客戶端接口調(diào)用及身份驗(yàn)證的問(wèn)題
這篇文章主要介紹了Python中WebService客戶端接口調(diào)用及身份驗(yàn)證的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-11-11

