理解Python裝飾器(Decorator)

理解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中引入了很多函數式編程的特性，需要好好學習與體會。

菜鳥教程：https://www.runoob.com/w3cnote/python-func-decorators.html

作者：聰明叉
鏈接：https://www.jianshu.com/p/ee82b941772a
來源：簡書
著作權歸作者所有。商業轉載請聯繫作者獲得授權，非商業轉載請註明出處。