Python裝飾器

在Python里面，函數(shù)可以作為參數(shù)傳入一個函數(shù)，函數(shù)也可以復(fù)制給變量，通過變量調(diào)用函數(shù)。裝飾器可以擴展一個函數(shù)的功能，為函數(shù)做一個裝飾器注解，可以把裝飾器里面定義的功能于所有函數(shù)提前執(zhí)行，提升代碼的復(fù)用程度。

現(xiàn)在有這么個場景。

打卡

互聯(lián)網(wǎng)公司里面有各種員工，程序員，前臺...，程序員在打開電腦前，需要打卡，前臺要早點來開門（我也不清楚，誰開門，這里假定，前臺開門），前臺開門前也需要打卡。也就是說，打卡是所有員工的最先的公共動作，那么可以把打卡這個功能抽出來作為公共邏輯。

普通函數(shù)調(diào)用方法

自然想到，可以實現(xiàn)如下。

def di(f):
    print('%s 打卡,滴...' % f.__name__)
    return f()

def boot():
    print('開機')

def open():
    print('開門')

if __name__ == '__main__':
    """
    程序員開機之前，前臺開門之前，都需要先在門外指紋機打卡。
    """
    di(boot)
    di(open)

定義了一個函數(shù)di(f)，可以打印f.__name__即f的函數(shù)名信息，同時返回f()的執(zhí)行結(jié)果。

注意：__name__如果作為模塊導(dǎo)入，module.__name__就是模塊自己的名字，如果模塊自己作為腳本執(zhí)行，返回__main__。

執(zhí)行結(jié)果：

boot 打卡,滴...
開機
open 打卡,滴...
開門

這樣設(shè)計，如果有很多函數(shù)都要調(diào)用，就很麻煩，那么裝飾器就排上了用場。

簡單裝飾器 與 @語法糖

裝飾器：在代碼運行期間動態(tài)增加功能的方式，稱之為“裝飾器”（Decorator）。

簡單裝飾器

定義一個di(f)方法，還是把要執(zhí)行的邏輯的函數(shù)作為參數(shù)傳入，里面定義一個wrapper函數(shù)，返回值是f的執(zhí)行結(jié)果。
在if __name__ == '__main__':里面，調(diào)用了這個裝飾器，不修改定義好了的函數(shù)，在運行期間動態(tài)添加功能"打卡"。

import functools

# 簡單裝飾器
def di(f):
    """
    程序員開機之前，前臺開門之前，都需要先在門外指紋機打卡。
    :param f: 傳入一個函數(shù)
    :return:
    """
    # 把原始函數(shù)的__name__等屬性復(fù)制到wrapper()
    @functools.wraps(f)
    def wrapper():
        print('%s 打卡,滴...' % f.__name__)
        return f()
    return wrapper

def boot():
    print('開機')

def open():
    print('開門')

if __name__ == '__main__':

    # 第一種，簡單裝飾器
    a = di(boot)
    a1 = di(open)
    print(a.__name__) # 結(jié)果wrapper 加@functools.wraps(f)后結(jié)果為 boot
    a()
    a1()

di(boot)的返回值a就是wrapper函數(shù)，通過a()就調(diào)用了wrapper函數(shù)，得到boot的返回值。同理，di(open)一樣。

結(jié)果

boot
boot 打卡,滴...
開機
open 打卡,滴...
開門

由于di(boot)的返回值a就是wrapper函數(shù)，那么print(a.__name__)的結(jié)果就理所當(dāng)然是是wrapper，我們希望是boot，怎么辦，functools.wraps(f)這個注解可以把原始函數(shù)boot的__name__等屬性復(fù)制到wrapper()，把這行代碼注釋也能運行，那么print(a.__name__)的結(jié)果就是wrapper。

第二種，@ 語法糖

通過@語法糖，也能將裝飾器應(yīng)用于函數(shù)上面，推薦。

import functools

def di(f):
    """
    程序員開機之前，前臺開門之前，都需要先在門外指紋機打卡。
    :param f: 傳入一個函數(shù)
    :return:
    """
    # 把原始函數(shù)的__name__等屬性復(fù)制到wrapper()
    @functools.wraps(f)
    def wrapper():
        print('%s 打卡,滴...' % f.__name__)
        return f()
    return wrapper

# @ 語法糖
@di
def boot2():
    print('開機')

@di
def open2():
    print('開門')

if __name__ == '__main__':

    # 第二種，@ 語法糖
    boot2()
    open2()

@di標(biāo)記相當(dāng)于，a2 = di(boot2) a2()。不用這么麻煩，因為加了@符號標(biāo)記，直接用boot2()調(diào)用裝飾器即可。

結(jié)果

boot2 打卡,滴...
開機
open2 打卡,滴...
開門

業(yè)務(wù)邏輯函數(shù)需要參數(shù)

業(yè)務(wù)邏輯函數(shù)可能需要參數(shù)，比如：

def boot(name):
    print('%s 開機' % name)

那么，只需要將前面的裝飾器修改為：

import functools

# 業(yè)務(wù)邏輯函數(shù)需要參數(shù)
def di(f):
    """
    程序員開機之前，前臺開門之前，都需要先在門外指紋機打卡。
    :param f: 傳入一個函數(shù)
    :return:
    """
    # 把原始函數(shù)的__name__等屬性復(fù)制到wrapper()
    @functools.wraps(f)
    def wrapper(*args, **kwargs):
        print('%s 打卡,滴...' % f.__name__)
        return f(*args, **kwargs)
    return wrapper

@di
def boot(name):
    print('%s 開機' % name)

if __name__ == '__main__':
    boot('keguang')

結(jié)果：

boot 打卡,滴...
keguang 開機

給wrapper也加上*args, **kwargs參數(shù)，在boot里面直接調(diào)用f(*args, **kwargs)即可。順便提一下：

  • *args：可以傳入一個數(shù)組參數(shù)
  • **kwargs：可以傳入一個k-v對參數(shù)

先后順序?qū)?yīng)，數(shù)組參數(shù)在前。舉例：

def f(*args, **kwargs):
    print('args=', args)
    print('kwargs=', kwargs)

print(f(1, 2, 3, a = 'a', b = 'b'))

# 結(jié)果
# args= (1, 2, 3)
# kwargs= {'a': 'a', 'b': 'b'}

帶參數(shù)的裝飾器

如果裝飾器也帶參數(shù)，比如現(xiàn)在如果某個員工早晨上班來得早< 9:00，咱可以做個表揚，那么相當(dāng)于只需要在前面的di()外面套一層函數(shù),di_args即可，在wrapper里面。使用這個參數(shù)

import functools

# 帶參數(shù)的裝飾器
def di_args(time):
    def di(f):
        """
        程序員開機之前，前臺開門之前，都需要先在門外指紋機打卡。
        :param f: 傳入一個函數(shù)
        :return:
        """
        # 把原始函數(shù)的__name__等屬性復(fù)制到wrapper()
        @functools.wraps(f)
        def wrapper(*args, **kwargs):
            if time < '9:00':
                print('來的真早，很棒。。。')

            print('%s 打卡,滴...' % f.__name__)
            return f(*args, **kwargs)
        return wrapper
    return di

@di_args('8:00')
def boot(name):
    print('%s 開機' % name)

if __name__ == '__main__':
    boot('keguang')

參數(shù)在@di_args('8:00')傳入即可，有點像java里面的注解。最后還是通過boot('keguang')調(diào)用即可，結(jié)果：

來的真早，很棒。。。
boot 打卡,滴...
keguang 開機

類裝飾器

類裝飾器主要依靠類的__call__方法，當(dāng)使用 @ 形式將裝飾器附加到函數(shù)上時，就會調(diào)用此方法。

# 類裝飾器
class di(object):
    def __init__(self, f):
        self._f = f

    def __call__(self, *args, **kwargs):
        print('decorator start...')
        self._f()
        print('decorator end...')

@di
def boot():
    print('開機')

if __name__ == '__main__':
    boot()

加上@di裝飾器標(biāo)識，會用boot去實例化di類，然后執(zhí)行__call__函數(shù)，object表示這個類可以傳入任何類型參數(shù)。
運行結(jié)果

decorator start...
開機
decorator end...

裝飾器有一個典型的應(yīng)用場景就是打log日志，如果所有邏輯都需要日志記錄程序的運行狀況，那么可以對這些邏輯(函數(shù))加日志模塊裝飾器，就能達到相應(yīng)目的。

作者：柯廣的網(wǎng)絡(luò)日志 ? Python裝飾器


微信公眾號：Java大數(shù)據(jù)與數(shù)據(jù)倉庫