一文帶你探尋Python中的裝飾器

更新時間：2023年04月12日 09:56:34 作者：真的不能告訴你我的名字

這篇文章就來和大家詳細講一講Python中裝飾器的相關知識，文中的示例代碼講解詳細，對我們深入了解Python有一定的幫助，感興趣的可以了解一下

什么是裝飾器

要理解裝飾器之前，我們需要了解什么是閉包函數(shù)。

閉包函數(shù)

我們簡單寫個demo，再解釋一下什么是閉包函數(shù)。

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()

可以看到，上述代碼所示，所謂的閉包函數(shù)是指: 閉包函數(shù)是指在函數(shù)中再定義函數(shù)，內(nèi)部函數(shù)可以訪問外部的變量，在外部函數(shù)中，將內(nèi)部函數(shù)作為返回值返回。

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

最簡單的裝飾器

裝飾器是一種很特殊的函數(shù)，可以接收函數(shù)作為形參，且返回一個新的函數(shù)，在我們上一篇介紹生成器的時候，還記得我們使用memory_profiler庫來打印函數(shù)的內(nèi)存運行情況么？這就是用的裝飾器。

我們可以寫個最簡單的例子，來闡述一下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需要傳入一個函數(shù)， foo內(nèi)部有一個函數(shù)wrapper。這樣的函數(shù)中包函數(shù)，我們將其稱之為閉包函數(shù)，后面會介紹閉包函數(shù)。言歸正傳，在wrapper函數(shù)中，我們可以在運行func函數(shù)的時候，再其執(zhí)行前后語句。

需要調(diào)用裝飾器的時候，只需要@加上函數(shù)名稱即可。

為什么需要裝飾器

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

解決代碼重復性，對于經(jīng)常需要實現(xiàn)類似的功能而言，可以將該功能抽離出來，作為裝飾器來調(diào)用，從而避免代碼重復。
增強代碼可讀性，在不修改原始代碼的前提下，可以利用裝飾器在函數(shù)前后增加代碼，例如處理異常、記錄日志等等，可以利用裝飾器將附加功能和函數(shù)主要功能分開，增加代碼可讀性。

說了那么多，我們來列舉一個最簡單的例子，利用裝飾器打印一下函數(shù)的運行時間。

import time

def getExecTimers(func):
  def wrapper():
    startTimes = time.time()
    func()
    endTimes = time.time()
    print("函數(shù)運行時間: " , endTimes - startTimes ,"s")
  return wrapper

@getExecTimers
def testFunc():
  print("開始執(zhí)行函數(shù)")
  time.sleep(5)
  print("函數(shù)執(zhí)行結束")

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

這個裝飾器，會記錄函數(shù)的運行時間?？梢钥吹?，我們?yōu)檫@個函數(shù)增加了一個附屬功能，但是又沒有修改到原始函數(shù)。

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

裝飾器用法

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

不是用語法糖調(diào)用

還記得上面我們調(diào)用裝飾器，是使用的@+裝飾器名稱么？其實這是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()

完整的寫法應該如下代碼所示，這是一個完整的閉包調(diào)用邏輯。

f1 = sayHello
f2 = foo(f1)

f2()

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

帶參數(shù)的裝飾器

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

*args: 將會將參數(shù)打包為元組
**kwargs: 將會打包字典傳遞給函數(shù)

def foo(func):
    def wrapper(*args,**kwargs):
        print("裝飾器開始運行了")
        print("裝飾器捕獲到的參數(shù): " ,args,**kwargs)
        func(*args,**kwargs)
        print("裝飾器結束運行了")

    return wrapper

@foo
def sayHello(a,b,c,dicts):
    print("傳入的參數(shù): " , a,b,c)
    print("傳入的參數(shù): " , dicts)

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

if __name__ == '__main__':
  main()

在裝飾器中，若我們要給函數(shù)傳遞參數(shù)，是需要先將參數(shù)傳遞給裝飾器，而在裝飾器中接收后再進行傳遞的，所以代碼才會是這樣的：

def foo(func):
    def wrapper(*args,**kwargs):
        print("裝飾器開始運行了")
        print("裝飾器捕獲到的參數(shù): " ,args,**kwargs)
        func(*args,**kwargs)
        print("裝飾器結束運行了")

首先，我們在做傳遞調(diào)用的時候，wrapper應該調(diào)用形參來接收，接收后，再進行傳遞給函數(shù)func。