網(wǎng)上很多講解單個(gè)python 裝飾器的文章,基礎(chǔ)知識(shí)我們簡(jiǎn)單描述首量。
首先了解裝飾器是用來干什么的壮吩,裝飾器可以增加函數(shù)的功能,可以通過函數(shù)實(shí)現(xiàn)加缘,可以通過類實(shí)現(xiàn)鸭叙,分別介紹兩種的簡(jiǎn)單例子。
裝飾者模式(Decorator Pattern)生百,是在不必改變?cè)愇募褪褂美^承的情況下递雀,動(dòng)態(tài)的擴(kuò)展一個(gè)對(duì)象的功能。它是通過創(chuàng)建一個(gè)包裝對(duì)象蚀浆,也就是裝飾來包裹真實(shí)的對(duì)象缀程。
適用裝飾者模式場(chǎng)合:
1.當(dāng)我們需要為某個(gè)現(xiàn)有的對(duì)象,動(dòng)態(tài)的增加一個(gè)新的功能或職責(zé)時(shí)市俊,可以考慮使用裝飾模式杨凑。
2.當(dāng)某個(gè)對(duì)象的職責(zé)經(jīng)常發(fā)生變化或者經(jīng)常需要?jiǎng)討B(tài)的增加職責(zé),避免為了適應(yīng)這樣的變化摆昧,而增加繼承子類擴(kuò)展的方式撩满,因?yàn)檫@種方式會(huì)造成子類膨脹的速度過快,難以控制绅你。
函數(shù)的單個(gè)裝飾器
使用內(nèi)嵌包裝函數(shù)來確保每次新函數(shù)都被調(diào)用伺帘,內(nèi)嵌包裝函數(shù)的形參和返回值與原函數(shù)相同,裝飾函數(shù)返回內(nèi)嵌包裝函數(shù)對(duì)象忌锯。
def deco(func):
def _deco():
print("before myfunc() called.")
func()
print(" after myfunc() called.")
#不需要返回func伪嫁,實(shí)際上應(yīng)返回原函數(shù)的返回值
return _deco
@deco
def myfunc():
print(" myfunc() called.")
return 'ok'
myfunc()
myfunc()
打印結(jié)果為:
before myfunc() called.
myfunc() called.
after myfunc() called.
before myfunc() called.
myfunc() called.
after myfunc() called.
裝飾器帶類參數(shù)
裝飾器帶類參數(shù):
class locker:
def __init__(self):
print("locker.__init__() should be not called.")
@staticmethod
def acquire():
print("locker.acquire() called.(這是靜態(tài)方法)")
@staticmethod
def release():
print(" locker.release() called.(不需要對(duì)象實(shí)例)")
def deco(cls):
'''cls 必須實(shí)現(xiàn)acquire和release靜態(tài)方法'''
def _deco(func):
def __deco():
print("before %s called [%s]." % (func.__name__, cls))
cls.acquire()
try:
return func()
finally:
cls.release()
return __deco
return _deco
@deco(locker)
def myfunc():
print(" myfunc() called.")
myfunc()
myfunc()
輸出結(jié)果為:
before myfunc called [<class 'main.locker'>].
locker.acquire() called.(這是靜態(tài)方法)
myfunc() called.
locker.release() called.(不需要對(duì)象實(shí)例)
before myfunc called [<class 'main.locker'>].
locker.acquire() called.(這是靜態(tài)方法)
myfunc() called.
locker.release() called.(不需要對(duì)象實(shí)例)
對(duì)一個(gè)函數(shù)應(yīng)用多個(gè)裝飾器
def decorator_b(func):
print ('Get in decorator_b')
def inner_b(*args, **kwargs):
print("b %s called." % func.__name__)
print ('Get in inner_b')
return func(*args, **kwargs)
return inner_b
def decorator_a(func):
print ('Get in decorator_a')
def inner_a(*args, **kwargs):
print("a %s called." % func.__name__)
print ('Get in inner_a')
return func(*args, **kwargs)
return inner_a
@decorator_b
@decorator_a
def f(x):
print ('Get in f')
return x * 2
f(1)
輸出結(jié)果:
Get in decorator_a
Get in decorator_b
b inner_a called.
Get in inner_b
a f called.
Get in inner_a
Get in f
運(yùn)行順序:
根據(jù)自下而上的原則來判斷地話,先執(zhí)行 decorator_a 再執(zhí)行 decorator_b , 那么會(huì)先輸出 Get in decotator_a偶垮,Get in decorator_b张咳;
上述裝飾器實(shí)際等價(jià)于:
f =decorator_b(decorator_a(f))(1)
decorator_a 函數(shù)來說,它返回的是個(gè)函數(shù)對(duì)象 inner_a 似舵,這個(gè)函數(shù)對(duì)象是它內(nèi)部定義的脚猾,所以decorator_b執(zhí)行的是decorator_b(inner_a),那么就可以理解為何打印出來“ b inner_a called.”砚哗;
在decorator_b中的 return func(*args, **kwargs) 為inner_a(f)龙助,所以再執(zhí)行decorator_a 中的inner_a(f),打印出“a f called.”蛛芥;
最后執(zhí)行f(1)提鸟。
類中對(duì)一個(gè)函數(shù)應(yīng)用多個(gè)裝飾器
mylocker.py
class mylocker:
def __init__(self):
print("mylocker.__init__() called.")
@staticmethod
def acquire():
print("mylocker.acquire() called.")
@staticmethod
def unlock():
print(" mylocker.unlock() called.")
class lockerex(mylocker):
@staticmethod
def acquire():
print("lockerex.acquire() called.")
@staticmethod
def unlock():
print(" lockerex.unlock() called.")
def lockhelper(cls):
'''cls 必須實(shí)現(xiàn)acquire和release靜態(tài)方法'''
def _deco(func):
print("%s %s called." % (func.__name__,cls))
def __deco(*args, **kwargs):
print("before %s called." % func.__name__)
cls.acquire()
try:
return func(*args, **kwargs)
finally:
cls.unlock()
return __deco
return _deco
test.py
from mylocker import *
class example:
@lockhelper(mylocker)
def myfunc(self):
print(" myfunc() called.")
@lockhelper(mylocker)
@lockhelper(lockerex)
def myfunc2(self, a, b):
print(" myfunc2() called.")
return a + b
if __name__ == "__main__":
a = example()
#實(shí)例化過程:
# 第一步lockhelper(mylocker)(myfunc) 打印 myfunc <class '__main__.lockerex'> called. 返回方法__deco,
# 第二步lockhelper(lockerex)(myfunc2) 打印 myfunc2 <class '__main__.lockerex'> called. 返回方法__deco,
# 第三步lockhelper(mylocker)(__deco) __deco <class '__main__.mylocker'> called. 返回方法__deco脆淹。
a.myfunc()
print(a.myfunc())
print(a.myfunc2(1, 2))
#過程解析:
#等價(jià)于lockhelper(mylocker)(lockhelper(lockerex)(myfunc2))(1,2)
#第一步 等價(jià)于lockhelper(mylocker)(__deco)(1,2) 因?yàn)閘ockerex(myfunc2)返回的是__deco方法
#lockhelper(mylocker)(lockhelper(lockerex)(myfunc2))(1,2) 執(zhí)行后打印 before __deco called.
#傳入類為mylocker,執(zhí)行cls.acquire() 打印 mylocker.acquire() called.
#func(*args, **kwargs) 中func為lockhelper(lockerex)(myfunc2)
#執(zhí)行l(wèi)ockhelper(lockerex)(myfunc2) 打印 before myfunc2 called.
#傳入類為lockerex沽一,執(zhí)行cls.acquire() 打印 lockerex.acquire() called.
#傳入func(*args, **kwargs) 中func為myfunc2(1,2)
#執(zhí)行myfunc2(1,2) 打印 myfunc2() called. 返回 3
#返回 3 執(zhí)行l(wèi)ockerex的 cls.unlock() 打印 lockerex.unlock() called.
#返回 3 執(zhí)行mylocker的 cls.unlock() 打印 mylocker.unlock() called.
print(a.myfunc2(3, 4))