Python裝飾器詳解

柯廣的部落格發表於2020-12-02

在Python裡面,函式可以作為引數傳入一個函式,函式也可以複製給變數,通過變數呼叫函式。裝飾器可以擴充套件一個函式的功能,為函式做一個裝飾器註解,可以把裝飾器裡面定義的功能於所有函式提前執行,提升程式碼的複用程度。

現在有這麼個場景。

打卡

網際網路公司裡面有各種員工,程式設計師,前臺...,程式設計師在開啟電腦前,需要打卡,前臺要早點來開門(我也不清楚,誰開門,這裡假定,前臺開門),前臺開門前也需要打卡。也就是說,打卡是所有員工的最先的公共動作,那麼可以把打卡這個功能抽出來作為公共邏輯。

普通函式呼叫方法

自然想到,可以實現如下。

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


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


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


if __name__ == '__main__':
    """
    程式設計師開機之前,前臺開門之前,都需要先在門外指紋機打卡。
    """
    di(boot)
    di(open)

定義了一個函式di(f),可以列印f.__name__f的函式名資訊,同時返回f()的執行結果。

注意:__name__如果作為模組匯入,module.__name__就是模組自己的名字,如果模組自己作為指令碼執行,返回__main__

執行結果:

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

這樣設計,如果有很多函式都要呼叫,就很麻煩,那麼裝飾器就排上了用場。

簡單裝飾器 與 @語法糖

裝飾器:在程式碼執行期間動態增加功能的方式,稱之為“裝飾器”(Decorator)。

簡單裝飾器

定義一個di(f)方法,還是把要執行的邏輯的函式作為引數傳入,裡面定義一個wrapper函式,返回值是f的執行結果。
if __name__ == '__main__':裡面,呼叫了這個裝飾器,不修改定義好了的函式,在執行期間動態新增功能"打卡"。

import functools

# 簡單裝飾器
def di(f):
    """
    程式設計師開機之前,前臺開門之前,都需要先在門外指紋機打卡。
    :param f: 傳入一個函式
    :return:
    """
    # 把原始函式的__name__等屬性複製到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__) # 結果wrapper 加@functools.wraps(f)後結果為 boot
    a()
    a1()

di(boot)的返回值a就是wrapper函式,通過a()就呼叫了wrapper函式,得到boot的返回值。同理,di(open)一樣。

結果

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

由於di(boot)的返回值a就是wrapper函式,那麼print(a.__name__)的結果就理所當然是是wrapper,我們希望是boot,怎麼辦,functools.wraps(f)這個註解可以把原始函式boot__name__等屬性複製到wrapper(),把這行程式碼註釋也能執行,那麼print(a.__name__)的結果就是wrapper

第二種,@ 語法糖

通過@語法糖,也能將裝飾器應用於函式上面,推薦。

import functools

def di(f):
    """
    程式設計師開機之前,前臺開門之前,都需要先在門外指紋機打卡。
    :param f: 傳入一個函式
    :return:
    """
    # 把原始函式的__name__等屬性複製到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標記相當於,a2 = di(boot2) a2()。不用這麼麻煩,因為加了@符號標記,直接用boot2()呼叫裝飾器即可。

結果

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

業務邏輯函式需要引數

業務邏輯函式可能需要引數,比如:

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

那麼,只需要將前面的裝飾器修改為:

import functools

# 業務邏輯函式需要引數
def di(f):
    """
    程式設計師開機之前,前臺開門之前,都需要先在門外指紋機打卡。
    :param f: 傳入一個函式
    :return:
    """
    # 把原始函式的__name__等屬性複製到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')

結果:

boot 打卡,滴...
keguang 開機

wrapper也加上*args, **kwargs引數,在boot裡面直接呼叫f(*args, **kwargs)即可。順便提一下:

  • *args:可以傳入一個陣列引數
  • **kwargs:可以傳入一個k-v對引數

先後順序對應,陣列引數在前。舉例:

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

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

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

帶引數的裝飾器

如果裝飾器也帶引數,比如現在如果某個員工早晨上班來得早< 9:00,我們可以做個表揚,那麼相當於只需要在前面的di()外面套一層函式,di_args即可,在wrapper裡面。使用這個引數

import functools

# 帶引數的裝飾器
def di_args(time):
    def di(f):
        """
        程式設計師開機之前,前臺開門之前,都需要先在門外指紋機打卡。
        :param f: 傳入一個函式
        :return:
        """
        # 把原始函式的__name__等屬性複製到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')

引數在@di_args('8:00')傳入即可,有點像java裡面的註解。最後還是通過boot('keguang')呼叫即可,結果:

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

類裝飾器

類裝飾器主要依靠類的__call__方法,當使用 @ 形式將裝飾器附加到函式上時,就會呼叫此方法。

# 類裝飾器
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裝飾器標識,會用boot去例項化di類,然後執行__call__函式,object表示這個類可以傳入任何型別引數。
執行結果

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

裝飾器有一個典型的應用場景就是打log日誌,如果所有邏輯都需要日誌記錄程式的執行狀況,那麼可以對這些邏輯(函式)加日誌模組裝飾器,就能達到相應目的。

相關文章