談一談Python中的裝飾器

来源:https://www.cnblogs.com/huageyiyangdewo/archive/2023/04/16/17322678.html
-Advertisement-
Play Games

說明 使用 VLD 記憶體泄漏檢測工具輔助開發時整理的學習筆記。同系列文章目錄可見 《記憶體泄漏檢測工具》目錄 1. 使用方式 在 VS 中使用 VLD 的方法可以查看另外一篇博客：在 VS 2015 中使用 VLD。 2. 輸出報告 在 VS 中使用 VLD 時的輸出報告，與在 QT 中使用時是一致的 ...


1、裝飾器基礎介紹

1.1 何為Python中的裝飾器？

Python中裝飾器的定義以及用途：

裝飾器是一種特殊的函數，它可以接受一個函數作為參數，並返回一個新的函數。裝飾器可以用來修改或增強函數的行為，而不需要修改函數本身的代碼。在Python中，裝飾器通常用於實現AOP（面向切麵編程），例如日誌記錄、性能分析、緩存等。裝飾器的語法使用@符號，將裝飾器函數放在被裝飾函數的定義之前

學過設計模式的朋友都知道，設計模式的結構型模式中也有一個叫裝飾器模式，那這個和Python中的裝飾器有什麼不同呢？

設計模式中的裝飾器的定義以及用途：

設計模式中的裝飾器是一種結構型模式，它可以在不改變原對象的情況下，為對象添加額外的功能。裝飾器模式通常用於在運行時動態地為對象添加功能，而不是在編譯時靜態地為對象添加功能。裝飾器模式通常涉及到多個對象之間的協作，而不是單個函數或對象。

因此，Python中的裝飾器和設計模式中的裝飾器雖然名稱相同，但是它們的實現方式和應用場景有很大的不同。

1.2 閉包

那Python種的裝飾器是怎麼實現的呢？先不用著急，我們先來一起學習學習Python中的閉包。

那什麼叫做閉包呢？

閉包是指一個函數和它所在的環境變數的組合，即在函數內部定義的函數可以訪問外部函數的變數和參數，即使外部函數已經返回。閉包可以用來實現函數式編程中的柯里化、惰性求值、函數組合等高級特性。

看著上面的文字，是不是感覺有點抽象。我說一說我對閉包的理解

閉包是由外部函數和內部函數，內部函數引用到了外部函數定義的變數，外部函數的返回值是內部函數的函數名。對於這樣的函數，我們就稱為閉包。

好像也有點抽象，我們來看一斷代碼，就能夠理解上面的話了。

def my_decorator():  # my_decorator 這個就叫做外部函數
    a = 1
    def inner():  # inner 這個叫做內部函數
        print(a)  # 內部函數引用到了外部函數中定義的變數
    return inner  # 外部函數的返回值是內部函數名

2、函數裝飾器的實現

上面講解了裝飾器的定義、用途，還有閉包，那怎麼去實現一個裝飾器呢？不急，接下來我們一起來學習如何實現裝飾器。

裝飾器不是說可以不改變一個函數源代碼的基礎上，給這個函數添加額外的功能嗎？那怎麼做呢？

接下來，我們就一起實現一個裝飾器，來計算函數的執行時間。Let‘s go!

2.1 不使用@實現裝飾器

首先，使用閉包定義一個統計函數執行時間的功能。

def process_time(func):
    def inner(*args, **kwargs):
        start_time = time.time()
        ret = func(*args, **kwargs)
        end_time = time.time()
        print("函數的執行時間為:%d" % (end_time-start_time))
        return ret
    return inner

接下來定義一個函數，使用比較來計算函數的執行時間。

import time


def process_time(func):
    def inner(*args, **kwargs):
        start_time = time.time()
        ret = func(*args, **kwargs)
        end_time = time.time()
        print("函數的執行時間為:%d" % (end_time-start_time))
        return ret
    return inner


def test(sleep_time):
    time.sleep(sleep_time)


t1 = process_time(test)
t1(1)
print("------------")
t1(2)

執行結果：

函數的執行時間為:1
------------
函數的執行時間為:2

通過上面的代碼，我們觀察到，我們並沒有修改test函數的源代碼，依舊給test函數添加上了統計函數執行時間的功能。

Python中實現上述功能，有更加優雅的方式。下麵，我們就一起來看看如何實現的。

2.2 Python中使用語法糖的裝飾器(推薦使用)

import time


def process_time(func):
    def inner(*args, **kwargs):
        start_time = time.time()
        ret = func(*args, **kwargs)
        end_time = time.time()
        print("函數的執行時間為:%d" % (end_time-start_time))
        return ret
    return inner


@process_time
def test(sleep_time):
    time.sleep(sleep_time)


test(1)
print("------------")
test(2)

執行結果：

函數的執行時間為:1
------------
函數的執行時間為:2

觀察上面的代碼變動，發現只有很少的部分修改了。

1、test函數上面添加了一行@process_time。

2、test函數的調用方式發生了改變。

其他的並沒有發生變化，整個代碼看起來也更加清爽了。

提示：

當使用@裝飾器時，會自動執行 閉包中的外部函數內容。這個可以自行驗證。

當使用@裝飾器時，Python解釋器為我們做了什麼？

當使用@裝飾器時，Python解釋器會將被裝飾的函數作為參數傳遞給裝飾器函數，並將其返回值作為新的函數對象替換原來的函數對象。這樣，每次調用被裝飾的函數時，實際上是調用了裝飾器函數返回的新函數對象。

Python 裝飾器 @ 實際上是一種語法糖，它可以讓我們在不改變原函數代碼的情況下，對函數進行擴展或修改。當我們使用 @ 裝飾器時，實際上是將被裝飾函數作為參數傳遞給裝飾器函數，然後將裝飾器函數的返回值賦值給原函數名。因此，@ 裝飾器並不會進行記憶體拷貝。

通過下麵的函數，可以得知，inner和test函數指向的是同一個記憶體地址。

import time


def process_time(func):

    print("func id --->", id(func))

    def inner(*args, **kwargs):
        start_time = time.time()
        ret = func(*args, **kwargs)
        end_time = time.time()
        print("函數的執行時間為:%d" % (end_time - start_time))
        return ret

    print("inner id --->", id(inner))
    return inner


@process_time
def test(sleep_time):
    print("test func id --->", id(test))
    time.sleep(sleep_time)


print("test id --->", id(test))

執行結果：

func id ---> 4312377952
inner id ---> 4313983008
test id ---> 4313983008

使用語法糖時，Python解釋器底層為我們做了這樣的處理。

2.3 多個裝飾器的執行順序

上面的兩個例子，都只有一個裝飾器，是不是Python只能寫一個裝飾器呢。其實不是的。主要是為了講解簡單。接下來，我們一起來看看，多個裝飾器的執行順序。

def outer_1(func):
    print("coming outer_1")

    def inner_1():
        print("coming inner_1")
        func()
    return inner_1


def outer_2(func):
    print("coming outer_2")

    def inner_2():
        print("coming inner_2")
        func()

    return inner_2


def outer_3(func):
    print("coming outer_3")

    def inner_3():
        print("coming inner_3")
        func()

    return inner_3


@outer_1
@outer_2
@outer_3
def test():
    print("coming test")


test()

執行結果：

coming outer_3
coming outer_2
coming outer_1
coming inner_1
coming inner_2
coming inner_3
coming test

outer_3 -> outer_2 -> outer_1 -> inner_1 -> inner_2 -> inner_3 -> 被裝飾函數

從上面的執行結果，可以得出如下結論：

使用多個裝飾器裝飾函數時，
外部函數的執行順序是從下到上的。
內部函數的執行順序是從下往上的。

多個裝飾器裝飾函數時，Python解釋器底層做了啥

通過下麵這段代碼驗證

def outer_1(func):
    print("coming outer_1, func id -->", id(func))

    def inner_1():
        print("coming inner_1")
        func()

    print("inner_1 id -->", id(inner_1))
    return inner_1


def outer_2(func):
    print("coming outer_2, func id -->", id(func))

    def inner_2():
        print("coming inner_2")
        func()

    print("inner_2 id -->", id(inner_2))
    return inner_2


def outer_3(func):
    print("coming outer_3, func id -->", id(func))

    def inner_3():
        print("coming inner_3")
        func()

    print("inner_3 id -->", id(inner_3))
    return inner_3


@outer_1
@outer_2
@outer_3
def test():
    print("coming test")


test()

執行結果：

coming outer_3, func id --> 4389102784
inner_3 id --> 4389102928
coming outer_2, func id --> 4389102928
inner_2 id --> 4389103072
coming outer_1, func id --> 4389103072
inner_1 id --> 4389103216
coming inner_1
coming inner_2
coming inner_3
coming test

2.4 帶參數的裝飾器

該如何實現帶參數的裝飾器呢，其實原理一樣的，我們再定義一個外層函數，外層函數的返回值是記憶體函數的名稱，即引用。

下麵我們來看一個例子：

def is_process(flag):
    def outer_1(func):
        print("coming outer_1, func id -->", id(func))

        def inner_1():
            print("coming inner_1")
            if flag:
                func()

        print("inner_1 id -->", id(inner_1))
        return inner_1
    return outer_1


@is_process(True)
def test():
    print("coming test")


test()

註意：

  • 我們裝飾函數時，裝飾器的寫法不同了，變成了@is_process(True)，這裡是調用了is_process這個函數

3、函數裝飾器的註意點(wraps函數)

猜一猜下麵函數會輸出什麼？

def outer_1(func):
    def inner_1():
        print("inner_1, func __name__", func.__name__)
        print("inner_1, func __doc__", func.__doc__)
        func()

    return inner_1


@outer_1
def test():
    """this is test"""
    print("outer_1, func __name__", test.__name__)
    print("outer_1, func __doc__", test.__doc__)


test()

函數執行結果：

inner_1, func __name__ test
inner_1, func __doc__ this is test
test, test __name__ inner_1
test, test __doc__ None

註意到沒，在test函數體內列印函數的 __name__、__doc__ 屬性，居然變成內部函數的了。

這個是為什麼呢？

Python裝飾器在裝飾函數時，會將原函數的函數名、文檔字元串、參數列表等屬性複製到裝飾器函數中，但是裝飾器函數並不會複製原函數的所有屬性。例如，原函數的name屬性、doc屬性、module屬性等都不會被覆制到裝飾器函數中。

為了避免這種情況，可以使用functools庫中的wraps裝飾器來保留原來函數對象的屬性。wraps裝飾器可以將原來函數對象的屬性複製到新的函數對象中，從而避免屬性丟失的問題。

from functools import wraps


def outer_1(func):

    @wraps(func)
    def inner_1():
        print("inner_1, func __name__", func.__name__)
        print("inner_1, func __doc__", func.__doc__)
        func()

    return inner_1


@outer_1
def test():
    """this is test"""
    print("test, test __name__", test.__name__)
    print("test, test __doc__", test.__doc__)


test()

執行結果：

inner_1, func __name__ test
inner_1, func __doc__ this is test
test, test __name__ test
test, test __doc__ this is test

4、類裝飾器

上面我們都是使用的函數來實現裝飾器的功能，那可不可以用類來實現裝飾器的功能呢？我們知道函數實現裝飾器的原理是外部函數的參數是被裝飾的函數，外部函數返回內部函數的名稱。內部函數中去執行被裝飾的函數。

那麼其實類也是可以用來實現裝飾器的，因為當我們為 類 定義了 __call__方法時，這個類就成了可調用對象，實例化後可直接調用。

class ProcessTime:

    def __call__(self, *args, **kwargs):
        print("call")


p = ProcessTime()
p()

4.1 類裝飾器的實現

import time


class ProcessTime:

    def __init__(self, func):

        print("coming ProcessTime __init__")
        self.func = func

    def __call__(self, *args, **kwargs):
        start_time = time.time()
        print("coming ProcessTime __call__, id(self.func) -->", id(self.func))
        ret = self.func(*args, **kwargs)
        end_time = time.time()
        print("ProcessTime 函數的執行時間為:%d" % (end_time - start_time))
        return ret


@ProcessTime
def test(sleep_time):
    time.sleep(sleep_time)
    return "tet"


test(1)

執行結果：

coming ProcessTime __init__
coming ProcessTime __call__, id(self.func) --> 4488922160
ProcessTime 函數的執行時間為:1

通過上面的執行結果，我們可以得到，@ProcessTime的作用是 test = ProcessTime(test)。又因為 ProcessTime定義了__call__方法，是可調用對象，所以可以像函數那樣直接調用實例化ProcessTime後的對象。

這裡可以驗證，通過註釋掉裝飾器，手動初始化ProcessTime類。得到的結果是一樣的。

# @ProcessTime
def test(sleep_time):
    time.sleep(sleep_time)
    return "tet"


test = ProcessTime(test)
test(1)

4.2 多個類裝飾器的執行順序

多個類裝飾器的執行順序是怎麼樣的呢，這裡我們也通過代碼來進行驗證。

import time


class ProcessTime:

    def __init__(self, func):

        print("coming ProcessTime __init__", id(self))
        self.func = func

    def __call__(self, *args, **kwargs):
        start_time = time.time()
        print("coming ProcessTime __call__, id(self.func) -->", id(self.func))
        ret = self.func(*args, **kwargs)
        end_time = time.time()
        print("ProcessTime 函數的執行時間為:%d" % (end_time - start_time))
        return ret


class ProcessTime2:

    def __init__(self, func):
        print("coming ProcessTime2 __init__", id(self))
        self.func = func

    def __call__(self, *args, **kwargs):
        start_time = time.time()
        print("coming ProcessTime2 __call__, id(self.func) -->", id(self.func))
        ret = self.func(*args, **kwargs)
        end_time = time.time()
        print("ProcessTime2 函數的執行時間為:%d" % (end_time - start_time))
        return ret


@ProcessTime
@ProcessTime2
def test(sleep_time):
    time.sleep(sleep_time)
    return "tet"


# test = ProcessTime2(test)
# test = ProcessTime(test)

t = test(1)

執行結果：

coming ProcessTime2 __init__ 4472235104
coming ProcessTime __init__ 4473162672
coming ProcessTime __call__, id(self.func) --> 4472235104
coming ProcessTime2 __call__, id(self.func) --> 4471735344
ProcessTime2 函數的執行時間為:1
ProcessTime 函數的執行時間為:1

從上面的結果，我們得到，執行順序是：

ProcessTime2 中的__init__ -> ProcessTime 中的__init__ -> ProcessTime 中的__call__ -> ProcessTime2 中的__call__

特別註意：

ProcessTime 中的__call__ 中的代碼並不會執行完後再去執行 ProcessTime2 中的__call__，而是在調用 ret = self.func(*args, **kwargs) 方法後，就回去執行 ProcessTime2 中的__call__的代碼。

4.3 類裝飾器存在的問題

其實，類裝飾器也存在和函數裝飾器一樣的問題。它會覆蓋原函數的元數據信息，例如函數名、文檔字元串、參數列表等。這可能會導致一些問題，例如調試時無法正確顯示函數名、文檔生成工具無法正確生成文檔等。

import time
from functools import wraps


class ProcessTime:

    def __init__(self, func):

        print("coming ProcessTime __init__", id(self))
        self.func = func

    def __call__(self, *args, **kwargs):
        start_time = time.time()
        print("coming ProcessTime __call__, id(self.func) -->", id(self.func))

        ret = self.func(*args, **kwargs)
        end_time = time.time()
        print("ProcessTime 函數的執行時間為:%d" % (end_time - start_time))
        return ret
        

@ProcessTime
def test(sleep_time):
    "tets"
    print("test.__doc__", test.__doc__)
    # print(test.__name__)  --> 報錯，AttributeError: 'ProcessTime' object has no attribute '__name__'
    time.sleep(sleep_time)
    return "tet"
  

t = test(1)

那類裝飾器該如何解決呢？

我現在還不知道該如何處理，如果有知道的朋友，請不吝賜教，十分感謝！！

5、多個裝飾器的執行順序總結

其實，我覺得不用特別的去記多個裝飾器的執行順序是如何的，我們最重要的是理解到裝飾器的執行邏輯是如何的。函數裝飾器和類裝飾器的初始化順序都是一樣的：從靠近被裝飾的函數開始執行初始化操作。把這個核心原理理解到後，多個裝飾器的執行順序在使用的時候，就很容易得到了。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Apache httpd 入門實戰(2)--簡單使用
    本文主要介紹 Apache 的實際使用，文中所使用到的軟體版本：Centos 7.9.2009、Httpd 2.4.55。 1、反向代理 涉及到 Https 站點時，安裝 Apache 時需要啟用 ssl，可參考 Apache httpd 入門實戰(1)--概念及安裝。 1.1、被代理站點為 Htt ...
  • FFmpeg開發筆記（一）搭建Linux系統的開發環境
    Python簡介 Python 是一個高層次的結合瞭解釋性、編譯性、互動性和麵向對象的腳本語言。 Python 的設計具有很強的可讀性，相比其他語言經常使用英文關鍵字，其他語言的一些標點符號，它具有比其他語言更有特色語法結構。 Python 是一種解釋型語言：這意味著開發過程中沒有了編譯這個環節。類 ...
  • Redis分散式鎖這樣用，有坑？
    背景 在微服務項目中，大家都會去使用到分散式鎖，一般也是使用Redis去實現，使用RedisTemplate、Redisson、RedisLockRegistry都行，公司的項目中，使用的是Redisson，一般你會怎麼用？看看下麵的代碼，是不是就是你的寫法 String lockKey = "fo ...
  • 網路框架重構之路plain2.0(c++23 without module) 環境
    接下來本來就直接打算分享框架重構的具體環節，但重構的代碼其實並沒有完成太多，許多的實現細節在我心中還沒有形成一個定型。由於最近回歸崗位後，新的開發環境需要自己搭建，搭建的時間來說花了我整整一天的時間才勉強搞定。人們常說工欲善其事必先利其器，開發環境和工具是必不可少的，否則你會發現在接下來的過程中遇到 ...
  • 消息隊列常見的使用場景
    消息隊列中間件是分散式系統中重要的組件，主要解決應用耦合，非同步消息，流量削鋒等問題 實現高性能，高可用，可伸縮和最終一致性架構。最全面的Java面試網站 使用較多的消息隊列有 RocketMQ，RabbitMQ，Kafka，ZeroMQ，MetaMQ 以下介紹消息隊列在實際應用中常用的使用場景。 異 ...
  • 響應式編程初探
    原創：扣釘日記（微信公眾號ID：codelogs），歡迎分享，非公眾號轉載保留此聲明。 在之前的OOM問題復盤中，我們添加了jmap腳本來自動dump記憶體現場，方便排查OOM問題。 但當我反覆模擬OOM場景測試時，發現jmap有時可以dump成功，有時會報錯，如下： 經過網上一頓搜索，發現兩種原因可 ...
  • java多版本共存
    demo軟體園每日更新資源,請看到最後就能獲取你想要的: 1.多語言BNB鏈上智能合約區塊鏈 別人發的我沒啥用，還有前面發的和這個好像不一樣 自己需要的下載玩，這個本來就沒有後臺，別下載了找我說不完整。看著還是挺不錯的。 這玩意好像還有人改盜u 頁面效果: 1.數據挖掘與預測分析 數據挖掘與預測分析 ...
  • FreeSWITCH添加iLBC編碼及轉碼
    操作系統 ：CentOS 7.6_x64 FreeSWITCH版本 ：1.10.9 一、安裝ilbc庫 從第三方庫里下載指定版本: git clone https://freeswitch.org/stash/scm/sd/libilbc.git 如果下載過慢，可從如下途徑獲取： 關註微信公眾號（聊 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類