舉例講解Python裝飾器

在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日志,如果所有邏輯都需要日志記錄程序的運行狀況,那麼可以對這些邏輯(函數)加日志模塊裝飾器,就能達到相應目的。

以上就是舉例講解Python裝飾器的詳細內容,更多關於python裝飾器的資料請關註WalkonNet其它相關文章!

推薦閱讀: