Python中的裝飾器是什麼及怎麼使用

使用環境為: Python 3.6.8

#什麼是裝飾器

#要瞭解裝飾器之前，我們需要了解什麼是閉包函數。

閉包函數

我們簡單寫個demo，再解釋一下什麼是閉包函數。

def exterFunc(x):
  def innerFunc(y):
    return x * y
  
  return innerFunc

def main() -> None:
  f = exterFunc(6)
  result = f(5)

  print(result)

if __name__ == '__main__':
  main()

可以看到，上述程式碼所示，所謂的閉包函數是指: 閉包函數是指在函數中再定義函數，內部函數可以存取外部的變量，在外部函數中，將內部函數作為返回值返回。

可以看到上述例子中，我們定義了exterFunc的函數，它將接收一個形參x，在exterFunc函數中又中定義了innerFunc，它也接收一個形參y， 在innerFunc函數中，傳回x * y，沒錯，內部函數可以存取外部函數傳入的變量，最後將exterFunc作為返回值返回，這就是閉包函數。

最簡單的裝飾器

裝飾器是一種很特殊的函數，可以接收函數作為形參，且傳回一個新的函數，在我們上一篇介紹生成器的時候，還記得我們使用memory_profiler函式庫來列印函數的記憶體運行情況麼？這就是用的裝飾器。

我們可以寫個最簡單的例子，來闡述一下python裝飾器，即：

def foo(func):
    def wrapper():
        print("装饰器开始运行了")
        func()
        print("装饰器结束运行了")

    return wrapper

@foo
def sayHello():
    print("hello pdudo in juejin")

def main() -> None:
  sayHello()

if __name__ == '__main__':
  main()

上面程式碼，我們定義了一個裝飾器foo，foo需要傳入一個函數，foo內部有一個函數wrapper。這樣的函數中包函數，我們稱之為閉包函數，後面會介紹閉包函數。言歸正傳，在wrapper函數中，我們可以在執行func函數的時候，再執行前後語句。

需要呼叫裝飾器的時候，只需要@加上函數名稱即可。

為什麼需要裝飾器

要解釋這個問題，我們可以看來了解下，裝飾器解決了一些什麼問題：

• 解決程式碼重複性，對於經常需要實現類似的功能而言，可以將該功能抽離出來，作為裝飾器來調用，從而避免程式碼重複。

• 增強程式碼可讀性，在不修改原始程式碼的前提下，可以利用裝飾器在函數前後增加程式碼，例如處理異常、記錄日誌等等，可以利用裝飾器將附加功能和函數主要功能分開，增加程式碼可讀性。

說了這麼多，我們來列舉一個最簡單的例子，利用裝飾器列印一下函數的運行時間。

import time

def getExecTimers(func):
  def wrapper():
    startTimes = time.time()
    func()
    endTimes = time.time()
    print("函数运行时间: " , endTimes - startTimes ,"s")
  return wrapper

@getExecTimers
def testFunc():
  print("开始执行函数")
  time.sleep(5)
  print("函数执行结束")

def main() -> None:
  testFunc()
  
if __name__ == '__main__':
  main()

這個裝飾器，會記錄函數的運行時間。可以看到，我們為這個函數增加了一個附屬功能，但是又沒有修改到原始函數。

上述案例，應該可以證明為什麼需要使用裝飾器了。

裝飾器用法

上述我們討論了最簡單的裝飾器寫法，並且寫了一個小功能，即列印函數的運行時間。接下來，我們要看下裝飾器的其他寫法。

不是用語法糖呼叫

還記得上面我們呼叫裝飾器，是使用的@ 裝飾器名稱麼？其實這是python的語法糖，如果不是用語法糖的話，應該是這樣來使用的：

def foo(func):
    def wrapper():
        print("装饰器开始运行了")
        func()
        print("装饰器结束运行了")

    return wrapper


def sayHello():
    print("hello pdudo in juejin")

def main() -> None:
  f1 = sayHello
  f2 = foo(f1)

  f2()

if __name__ == '__main__':
  main()

完整的寫法應該如下程式碼所示，這是一個完整的閉包調用邏輯。

f1 = sayHello
f2 = foo(f1)

f2()

而在函數前加上@ 裝飾器名稱， 是一種python的語法糖

帶參數的裝飾器

這裡要做一個鋪墊，在python中，有2個特殊的變量，分別為*args和**kwargs，都是用來處理不定量參數的，分別代表的意義為:

• *args: 將會將參數打包為元組

• **kwargs: 將會打包字典傳遞給函數

def foo(func):
    def wrapper(*args,**kwargs):
        print("装饰器开始运行了")
        print("装饰器捕获到的参数: " ,args,**kwargs)
        func(*args,**kwargs)
        print("装饰器结束运行了")

    return wrapper

@foo
def sayHello(a,b,c,dicts):
    print("传入的参数: " , a,b,c)
    print("传入的参数: " , dicts)

def main() -> None:
  sayHello(1,2,3,{"name":"juejin"})

if __name__ == '__main__':
  main()

在裝飾器中，若我們要給函數傳遞參數，是需要先將參數傳遞給裝飾器，而在裝飾器中接收後再進行傳遞的，所以程式碼才會是這樣的：

def foo(func):
    def wrapper(*args,**kwargs):
        print("装饰器开始运行了")
        print("装饰器捕获到的参数: " ,args,**kwargs)
        func(*args,**kwargs)
        print("装饰器结束运行了")

首先，我們在做傳遞呼叫的時候，wrapper應該呼叫形參來接收，接收後，再進行傳遞給函數func。

以上是Python中的裝飾器是什麼及怎麼使用的詳細內容。更多資訊請關注PHP中文網其他相關文章！