【Python】理解Python裝飾器(Decorator)

Python裝飾器看起來類似Java中的注解,然鵝和注解并不相同,不過同樣能夠?qū)崿F(xiàn)面向切面編程。
想要理解Python中的裝飾器,不得不先理解閉包(closure)這一概念。

1. 閉包

看看維基百科中的解釋:
在計算機(jī)科學(xué)中,閉包(英語:Closure),又稱詞法閉包(Lexical Closure)或函數(shù)閉包(function closures),是引用了自由變量的函數(shù)。這個被引用的自由變量將和這個函數(shù)一同存在,即使已經(jīng)離開了創(chuàng)造它的環(huán)境也不例外。

官方的解釋總是不說人話,but talk is cheap,show me the code:

def print_msg():
    msg = "I'm closure"

    # printer是嵌套函數(shù)
    def printer():
        print(msg)
    return printer
# 這里獲得的就是一個閉包
closure = print_msg()
# 輸出 I'm closure
closure()

msg是一個局部變量,在print_msg函數(shù)執(zhí)行之后應(yīng)該就不會存在了。但是嵌套函數(shù)引用了這個變量,將這個局部變量封閉在了嵌套函數(shù)中,這樣就形成了一個閉包。

結(jié)合這個例子再看維基百科的解釋,就清晰明了多了。閉包就是引用了自有變量的函數(shù),這個函數(shù)保存了執(zhí)行的上下文,可以脫離原本的作用域獨立存在。

下面來看看Python中的裝飾器。

2.裝飾器

一個普通的裝飾器一般是這樣:

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

這樣就定義了一個打印出方法名及其參數(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

裝飾器在使用時,用了@語法,讓人有些困擾。其實,裝飾器只是個方法,與下面的調(diào)用方式?jīng)]有區(qū)別:

def test(p):
    print(test.__name__ + " param: " + p)

wrapper = log(test)
wrapper("I'm a param")

@語法只是將函數(shù)傳入裝飾器函數(shù),并無神奇之處。

值得注意的是@functools.wraps(func),這是python提供的裝飾器。它能把原函數(shù)的元信息拷貝到裝飾器里面的 func 函數(shù)中。函數(shù)的元信息包括docstring、name、參數(shù)列表等等。可以嘗試去除@functools.wraps(func),你會發(fā)現(xiàn)test.name的輸出變成了wrapper。

3.帶參數(shù)的裝飾器

裝飾器允許傳入?yún)?shù),一個攜帶了參數(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__)

看到這個代碼是不是又有些疑問,內(nèi)層的decorator函數(shù)的參數(shù)func是怎么傳進(jìn)去的?和上面一般的裝飾器不大一樣啊。

其實道理是一樣的,將其@語法去除,恢復(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

至此,裝飾器這個有點費解的特性也沒什么神秘了。
裝飾器這一語法體現(xiàn)了Python中函數(shù)是第一公民,函數(shù)是對象、是變量,可以作為參數(shù)、可以是返回值,非常的靈活與強(qiáng)大。Python中引入了很多函數(shù)式編程的特性,需要好好學(xué)習(xí)與體會

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容