理解Python裝飾器(Decorator)
Python裝飾器看起來(lái)類似Java中的注解丐膝,然鵝和注解并不相同,不過(guò)同樣能夠?qū)崿F(xiàn)面向切面編程踢京。
想要理解Python中的裝飾器跨算,不得不先理解閉包(closure)這一概念轻要。
閉包
看看維基百科中的解釋:
在計(jì)算機(jī)科學(xué)中,閉包(英語(yǔ):Closure)旱爆,又稱詞法閉包(Lexical Closure)或函數(shù)閉包(function closures)舀射,是引用了自由變量的函數(shù)。這個(gè)被引用的自由變量將和這個(gè)函數(shù)一同存在怀伦,即使已經(jīng)離開了創(chuàng)造它的環(huán)境也不例外脆烟。
官方的解釋總是不說(shuō)人話,but--talk is cheap房待,show me the code:
# print_msg是外圍函數(shù)
def print_msg():
msg = "I'm closure"
# printer是嵌套函數(shù)
def printer():
print(msg)
return printer
# 這里獲得的就是一個(gè)閉包
closure = print_msg()
# 輸出 I'm closure
closure()
msg
是一個(gè)局部變量邢羔,在print_msg
函數(shù)執(zhí)行之后應(yīng)該就不會(huì)存在了。但是嵌套函數(shù)引用了這個(gè)變量桑孩,將這個(gè)局部變量封閉在了嵌套函數(shù)中拜鹤,這樣就形成了一個(gè)閉包。
結(jié)合這個(gè)例子再看維基百科的解釋流椒,就清晰明了多了敏簿。閉包就是引用了自有變量的函數(shù),這個(gè)函數(shù)保存了執(zhí)行的上下文,可以脫離原本的作用域獨(dú)立存在惯裕。
下面來(lái)看看Python中的裝飾器温数。
裝飾器
一個(gè)普通的裝飾器一般是這樣:
import functools
def log(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('call %s():' % func.__name__)
print('args = {}'.format(*args))
return func(*args, **kwargs)
return wrapper
這樣就定義了一個(gè)打印出方法名及其參數(shù)的裝飾器。
調(diào)用之:
@log
def test(p):
print(test.__name__ + " param: " + p)
test("I'm a param")
輸出:
call test():
args = I'm a param
test param: I'm a param
裝飾器在使用時(shí)蜻势,用了@
語(yǔ)法撑刺,讓人有些困擾。其實(shí)握玛,裝飾器只是個(gè)方法够傍,與下面的調(diào)用方式?jīng)]有區(qū)別:
def test(p):
print(test.__name__ + " param: " + p)
wrapper = log(test)
wrapper("I'm a param")
@
語(yǔ)法只是將函數(shù)傳入裝飾器函數(shù),并無(wú)神奇之處败许。
值得注意的是@functools.wraps(func)
王带,這是python提供的裝飾器。它能把原函數(shù)的元信息拷貝到裝飾器里面的 func 函數(shù)中市殷。函數(shù)的元信息包括docstring愕撰、name、參數(shù)列表等等醋寝「阏酰可以嘗試去除@functools.wraps(func)
,你會(huì)發(fā)現(xiàn)test.__name__
的輸出變成了wrapper音羞。
帶參數(shù)的裝飾器
裝飾器允許傳入?yún)?shù)囱桨,一個(gè)攜帶了參數(shù)的裝飾器將有三層函數(shù),如下所示:
import functools
def log_with_param(text):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('call %s():' % func.__name__)
print('args = {}'.format(*args))
print('log_param = {}'.format(text))
return func(*args, **kwargs)
return wrapper
return decorator
@log_with_param("param")
def test_with_param(p):
print(test_with_param.__name__)
看到這個(gè)代碼是不是又有些疑問(wèn)嗅绰,內(nèi)層的decorator函數(shù)的參數(shù)func是怎么傳進(jìn)去的舍肠?和上面一般的裝飾器不大一樣啊。
其實(shí)道理是一樣的窘面,將其@
語(yǔ)法去除翠语,恢復(fù)函數(shù)調(diào)用的形式一看就明白了:
# 傳入裝飾器的參數(shù),并接收返回的decorator函數(shù)
decorator = log_with_param("param")
# 傳入test_with_param函數(shù)
wrapper = decorator(test_with_param)
# 調(diào)用裝飾器函數(shù)
wrapper("I'm a param")
輸出結(jié)果與正常使用裝飾器相同:
call test_with_param():
args = I'm a param
log_param = param
test_with_param
至此财边,裝飾器這個(gè)有點(diǎn)費(fèi)解的特性也沒(méi)什么神秘了肌括。
裝飾器這一語(yǔ)法體現(xiàn)了Python中函數(shù)是第一公民,函數(shù)是對(duì)象酣难、是變量谍夭,可以作為參數(shù)、可以是返回值憨募,非常的靈活與強(qiáng)大紧索。
Python中引入了很多函數(shù)式編程的特性,需要好好學(xué)習(xí)與體會(huì)馋嗜。