理解Python裝飾器

Python裝飾器

Python裝飾器看起來類似Java中的註解，然鵝和註解並不相同，不過同樣能夠實現面向切面編程。

一般的裝飾器

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

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