了解Python裝飾器(Decorator)
Python裝飾器看起來類似Java中的注解,然鵝和注解并不相同,不過同樣能夠實作面向切面程式設計。
想要了解Python中的裝飾器,不得不先了解閉包(closure)這一概念。
閉包
看看維基百科中的解釋:
在計算機科學中,閉包(英語:Closure),又稱詞法閉包(Lexical Closure)或函數閉包(function closures),是引用了自由變量的函數。這個被引用的自由變量将和這個函數一同存在,即使已經離開了創造它的環境也不例外。
官方的解釋總是不說人話,but--talk is cheap,show me the code:
# print_msg是外圍函數
def print_msg():
msg = "I'm closure"
# printer是嵌套函數
def printer():
print(msg)
return printer
# 這裡獲得的就是一個閉包
closure = print_msg()
# 輸出 I'm closure
closure()
msg是一個局部變量,在print_msg函數執行之後應該就不會存在了。但是嵌套函數引用了這個變量,将這個局部變量封閉在了嵌套函數中,這樣就形成了一個閉包。
結合這個例子再看維基百科的解釋,就清晰明了多了。閉包就是引用了自有變量的函數,這個函數儲存了執行的上下文,可以脫離原本的作用域獨立存在。
下面來看看Python中的裝飾器。
裝飾器
一個普通的裝飾器一般是這樣:
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
這樣就定義了一個列印出方法名及其參數的裝飾器。
調用之:
@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
裝飾器在使用時,用了@文法,讓人有些困擾。其實,裝飾器隻是個方法,與下面的調用方式沒有差別:
def test(p):
print(test.__name__ + " param: " + p)
wrapper = log(test)
wrapper("I'm a param")
@文法隻是将函數傳入裝飾器函數,并無神奇之處。
值得注意的是@functools.wraps(func),這是python提供的裝飾器。它能把原函數的元資訊拷貝到裝飾器裡面的 func 函數中。函數的元資訊包括docstring、name、參數清單等等。可以嘗試去除@functools.wraps(func),你會發現test.__name__的輸出變成了wrapper。
帶參數的裝飾器
裝飾器允許傳入參數,一個攜帶了參數的裝飾器将有三層函數,如下所示:
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__)
看到這個代碼是不是又有些疑問,内層的decorator函數的參數func是怎麼傳進去的?和上面一般的裝飾器不大一樣啊。
其實道理是一樣的,将其@文法去除,恢複函數調用的形式一看就明白了:
# 傳入裝飾器的參數,并接收傳回的decorator函數
decorator = log_with_param("param")
# 傳入test_with_param函數
wrapper = decorator(test_with_param)
# 調用裝飾器函數
wrapper("I'm a param")
輸出結果與正常使用裝飾器相同:
call test_with_param():
args = I'm a param
log_param = param
test_with_param
至此,裝飾器這個有點費解的特性也沒什麼神秘了。
裝飾器這一文法展現了Python中函數是第一公民,函數是對象、是變量,可以作為參數、可以是傳回值,非常的靈活與強大。
Python中引入了很多函數式程式設計的特性,需要好好學習與體會。