通俗地講,裝飾器就是對函數(shù)的重定義(不嚴謹舰蟆,但有助于理解)趣惠。通常是將原函數(shù)包裝成一個新函數(shù)并賦給原函數(shù),以便在函數(shù)執(zhí)行時自動進行包裝添加的相應處理(如鑒權(quán)功能身害,運行時統(tǒng)計等)味悄。語法糖@簡化了賦值處理
talk is cheap, show me the code
一啸驯、函數(shù)裝飾器
下面主要實現(xiàn)三個裝飾器
- 純注冊用闷煤,不改變函數(shù)行為
- 普通裝飾霉囚,后續(xù)調(diào)用函數(shù)時會改變行為
- 帶參數(shù)的裝飾器硼啤,根據(jù)參數(shù)來生成不同的裝飾行為(不用定義多個裝飾器)
def once(func):
"""
當調(diào)用@once時相當于執(zhí)行了一次 func = once(func), 即對func重新賦值, 實際就是func = func, 后續(xù)調(diào)用還是調(diào)用func
因為賦值給func是func本身, 所以后續(xù)調(diào)用不會有任何附加作用
適用于初始化狀態(tài)(例如初始化時加載路由)
:param func: 可執(zhí)行函數(shù)
:return: func, 返回函數(shù)本身
"""
# 初始化操作, 可執(zhí)行任意操作
print('once init')
return func
def ever(func):
"""
當調(diào)用@ever時相當于執(zhí)行了一次 func = ever(func), 這里func賦值后, 實際是 func = wrapper, 后續(xù)調(diào)用實際調(diào)用的wrapper
:param func:
:return:
"""
# 初始化操作, 可執(zhí)行任意操作
print('ever init')
def wrapper1(*args):
print('before ever')
ret = func(*args)
print('after ever')
return ret
return wrapper1
def aka(key='key'):
"""
當調(diào)用@aka('key')時相當于執(zhí)行了一次 func = aka('key')(func)
aka('key')取到的是dec, 所以實際是 func = dec(func)
而dec(func)返回的是wrapper, 所以最終是 func = wrapper, 后續(xù)調(diào)用實際調(diào)用wrapper
注意這里的裝飾器調(diào)用是 @aka('key') 而不是裝飾器函數(shù)本身
:param key:
:return:
"""
# 這里可以進行初始化操作, 可執(zhí)行任意操作
print('aka init out dec -- key:', key)
def dec(func):
# 也可以在這里進行初始化操作, 可執(zhí)行任意操作
print('aka init in dec -- key:', key)
def wrapper2(*args):
print('before aka')
ret = func(*args)
print('after aka')
return ret
return wrapper2
return dec
print('初始化**********************************')
@once
def tes_once():
print('tes_once real:', tes_once.__name__)
@ever
def tes_ever():
print('tes_ever real:', tes_ever.__name__)
@once
@ever
@aka('key')
def tes_multi():
"""
相當于 tes_multi = once(ever(aka('key')(tes_multi))) 注意這里是有調(diào)用順序的
先由aka包裝成 wrapper2 函數(shù), 即 tes_multi = once(ever(wrapper2))
再由ever包裝成 wrapper1 函數(shù), 即 tes_multi = once(wrapper1)
再由once包裝
:return:
"""
print('tes_all real:', tes_multi.__name__)
print('調(diào)用************************************')
tes_once()
print('---------------')
tes_ever()
print('---------------')
tes_multi()
print('****************************************')
運行結(jié)果
運行結(jié)果如下:
初始化**********************************
once init
ever init
aka init out dec -- key: key
aka init in dec -- key: key
ever init
once init
調(diào)用************************************
tes_once real: tes_once
---------------
before ever
tes_ever real: wrapper1
after ever
---------------
before ever
before aka
tes_all real: wrapper1
after aka
after ever
****************************************
從上面的結(jié)果看到函數(shù)名__name__并沒有指向自身绞绒,而是指向了賦給他的包裝函數(shù)名(tes_ever real: wrapper1, tes_all real: wrapper1)瘫里。也就是說使用裝飾器時會丟失原函數(shù)的元數(shù)據(jù)沐兵。
那么要怎么保留原函數(shù)的元數(shù)據(jù)呢依沮?
functools模塊中的wraps裝飾函數(shù)提供了相應處理茧球,我們只需調(diào)用@wraps(func)
即可
from functools import wraps
def new_ever(func):
@wraps(func)
def wrapper1(*args):
print('before new_ever')
ret = func(*args)
print('after new_ever')
return ret
return wrapper1
def new_aka(key='key'):
def dec(func):
@wraps(func)
def wrapper2(*args):
print('before new_aka')
ret = func(*args)
print('after new_aka')
return ret
return wrapper2
return dec
@new_ever
def tes_new_ever():
print('tes_new_ever real:', tes_new_ever.__name__)
@new_aka('key')
def tes_new_aka():
print('tes_new_aka real:', tes_new_aka.__name__)
print('調(diào)用************************************')
tes_new_ever()
print('---------------')
tes_new_aka()
print('****************************************')
運行結(jié)果如下:
調(diào)用************************************
before new_ever
tes_new_ever real: tes_new_ever
after new_ever
---------------
before new_aka
tes_new_aka real: tes_new_aka
after new_aka
****************************************
我們可以看到函數(shù)名已經(jīng)正確指向自己
二庭瑰、類裝飾器
這個感覺還沒遇到過使用環(huán)境,不過有看到一個用來管理被裝飾函數(shù)運行次數(shù)的例子
class Decorator(object):
def __init__(self, max):
self.max = max
self.count = 0
# 這里讓對象能夠像函數(shù)一樣被調(diào)用
def __call__(self, func):
self.func = func
return self.call_func
def call_func(self, *args, **kwargs):
if self.count < self.max:
self.func(*args, **kwargs)
self.count += 1
else:
print('{} run more than {} times'.format(self.func.__name__, self.max))
@Decorator(5)
def do_some():
print('do some')
for i in range(10):
do_some()
運行結(jié)果:
do some
do some
do some
do some
do some
do_some run more than 5 times
do_some run more than 5 times
do_some run more than 5 times
do_some run more than 5 times
do_some run more than 5 times
這里可以看出抢埋,可以用類裝飾器對函數(shù)進行狀態(tài)管理
類裝飾器一下子搞不清楚適用哪方面怎么用弹灭,以后碰到再更新吧