Python 裝飾器原理

来源:https://www.cnblogs.com/zikcheng/archive/2023/02/06/17093969.html
-Advertisement-
Play Games

裝飾器是 Python 編程中常用的一個功能,可以將通用的邏輯抽象成裝飾器,通過裝飾器語法應用到不同的目標上,達到增強或修改目標邏輯的目的。 先來看一個簡單的例子 # 列印耗時的裝飾器 def log(f): def inner(*args, **kw): start = time.perf_cou ...


裝飾器是 Python 編程中常用的一個功能,可以將通用的邏輯抽象成裝飾器,通過裝飾器語法應用到不同的目標上,達到增強或修改目標邏輯的目的。

先來看一個簡單的例子

# 列印耗時的裝飾器
def log(f):
    def inner(*args, **kw):
        start = time.perf_counter()
        result = f(*args, **kw)
        cost = time.perf_counter() - start
        print(f"cost {cost:.1} seconds")
        return result
    return inner

# 通過 @ 語法將裝飾器應用到目標對象上
@log
def download(url):
    requests.get(url)

download("https://www.baidu.com")
# 輸出如下
# cost 0.1 seconds

被裝飾的目標是 download 函數,用於下載文件,通過 @ 語法被列印耗時的裝飾器 log 修飾,download 在被調用的時候就會列印下載文件的耗時。那麼列印耗時的邏輯是怎麼嵌入到 download 函數中的呢,這裡的關鍵就是需要知道 Python 解釋器是怎麼處理 @ 語法的。不妨用 Python 提供的 dis 模塊反彙編一下 download 的定義

@log
def download(url):
    requests.get(url)

反彙編之後得到的位元組碼如下(不同 Python 版本反彙編的結果略有差異)

2           0 LOAD_NAME                0 (log)

3           2 LOAD_CONST               0 (<code object download at 0x7f7872e363a0, file "<dis>", line 2>)
            4 LOAD_CONST               1 ('download')
            6 MAKE_FUNCTION            0
            8 CALL_FUNCTION            1
           10 STORE_NAME               1 (download)
           12 LOAD_CONST               2 (None)
           14 RETURN_VALUE

# download 函數本來的函數體
Disassembly of <code object download at 0x7f7872e363a0, file "<dis>", line 2>:
4           0 LOAD_GLOBAL              0 (requests)
            2 LOAD_METHOD              1 (get)
            4 LOAD_FAST                0 (url)
            6 CALL_METHOD              1
            8 POP_TOP
           10 LOAD_CONST               0 (None)
           12 RETURN_VALUE

可以看到,一開始 MAKE_FUNCTION 指令通過編譯好的 download 函數體對應的 code 對象構造出一個新的函數對象存在 download 變數中,然後通過 CALL_FUNCTION 指令調用 log 函數(參數是 download 變數),最後再通過 STORE_NAME 指令將 log 函數的返回結果存到 download 變數中。所以從語義上說,logdownload 進行裝飾的效果等價於下麵的偽代碼

download = make_function(code) # 構造最初的 download 函數對象
download = log(download) # 調用 log 函數將返回值賦給 download 變數

log 函數的返回是 inner 函數,也就是說 download 在被修飾之後指向的是 inner 函數,而 inner 函數中的 f 變數又指向了 download 在被修飾之前所指向的函數對象,所以最後在調用 download 的時候除了有原來的下載功能之外,還列印了耗時。

裝飾前後 download 變數的變化如下圖所示

在上面的例子中我們稱 log 為裝飾器,因為 log@ 同一行且是 @ 後面的內容,這是 Python 語法規定的。log 是一個函數,且定義了一個參數。但是裝飾器本身不一定非得是函數,只要是值為可以通過傳遞一個位置參數進行調用的可調用對象的表達式即可。也就是說

  • 裝飾器就是一個表達式
  • 表達式的值是一個可調用對象
  • 這個可調用對象可以通過位置傳參的方式傳遞一個參數進行調用

簡單來說,裝飾器的本質是可以通過形如 A(f) 的方式進行調用的可調用對象(A@ 後面整個表達式的值)

可調用對象可以認為是像函數一樣可以在後面加括弧和參數進行調用的對象,函數本身就是一種可調用對象,還有類對象以及定義了 __call__ 函數的類實例對象等都是可調用對象。

下麵的函數 wrapper 就是一個滿足條件的裝飾器,hello 開始是個空函數,被 wrapper 裝飾之後就變成了字元串 "zikcheng"。當然這個裝飾器沒什麼用,只是為了說明定義一個滿足語法的裝飾器很簡單,不一定非要定義內部函數。

def wrapper(a=1, b="hello"):
    return "zikcheng"

@wrapper
def hello():
    pass

print(hello, type(hello))
# 輸出
# zikcheng <class 'str'>

再回到 logdownload 的例子,如果我們想在列印耗時的同時列印負載類型(比如這裡是 IO,對於計算密集型的負載類型是 CPU),可以做如下修改

def log_outer(load_type):
    def log(f):
        def inner(*args, **kw):
            start = time.perf_counter()
            result = f(*args, **kw)
            cost = time.perf_counter() - start
            print(f"{load_type} cost {cost:.1} seconds")
            return result
        return inner
    return log

@log_outer("IO")
def download(url):
    requests.get(url)

download("https://www.baidu.com")
# 輸出如下
# IO cost 0.1 seconds

這個例子中的裝飾器表達式為 log_outer("IO"),因為 @ 符號後面的內容是 log_outer("IO") 整體,而不是 log_outerlog_outer("IO") 的返回值為 log 函數,因此修飾 download 的裝飾器還是 log 函數,只不過這次 log 函數是一個閉包,引用了外部函數的 load_type 變數用於列印負載類型。本質上還是 download = log_outer("IO")(download)

如果要列印負載類型,除了上面這種方式,還可以通過定義一個類來實現

class LoadLog:
    def __init__(self, load_type):
        self.load_type = load_type

    def __call__(self, f):
        def inner(*args, **kw):
            start = time.perf_counter()
            result = f(*args, **kw)
            cost = time.perf_counter() - start
            print(f"{self.load_type} cost {cost:.1} seconds")
            return result
        return inner

@LoadLog("IO")
def download(url):
    requests.get(url)

download("https://www.baidu.com")
# 輸出如下
# IO cost 0.1 seconds

同理,download = LoadLog("IO")(download),裝飾器是 LoadLog("IO"),值為 LoadLog 類實例,是一個可調用對象,最終 download 指向 __call__ 的返回值也就是 inner 函數,效果跟之前一樣。

只要我們明白裝飾器的本質是值為可調用對象的表達式,那麼無論怎麼變形,是三層嵌套函數還是類就都很好理解了。

上面例子中被裝飾的對象都是函數,實際上類也是可以被裝飾的,這裡就不展開了。

本文先通過一個簡單的示例引入裝飾器概念,然後分析其反彙編的位元組碼揭示了裝飾器的本質,最後通過無嵌套函數、三層嵌套函數和類分別作為裝飾器來加強對裝飾器本質的理解,希望文章能對你有所幫助。


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

-Advertisement-
Play Games
更多相關文章
  • 本文主要介紹在Node.js應用中, 如何用全鏈路信息存儲技術把全鏈路追蹤數據存儲起來,併進行相應的展示,最終實現基於業界通用 OpenTracing 標準的 Zipkin 的 Node.js 方案。 ...
  • 這篇文章主要描述分散式互斥方法,包括什麼是分散式互斥,分散式互斥地三種方法:集中式方法、分散式方法和令牌環方法。 ...
  • 模型數據 1.數據放入request 說明:開發中,控制器/處理器中獲取的數據如何放入request域,然後在前端(vue/jsp/...)取出顯示? 先來看一個例子 應用實例需求:表單提交信息,後端獲取信息,並通過request轉發到另一個頁面,顯示信息。 需要知道的是:前端提交的數據,sprin ...
  • 實踐環境 Odoo 14.0-20221212 (Community Edition) 代碼實現 方案1 通過研究發現,點擊odoo form表單按鈕時,會調用odoo14\odoo\addons\web\static\src\js\views\form\form_controller.js文件中的 ...
  • 1 簡介 在Spring MVC中,我們有時需要記錄一下請求和返回的內容,方便出現問題時排查。比較Header、Request Body等。這些在Controller也可以記錄,但在Filter中會更方便。而我們使用的是OncePerRequestFilter。 2 記錄請求 2.1 流重覆讀的問題 ...
  • 實現動態SQL的四種方式: 1、XML配置 使用XML配置動態SQL,細節不表,詳參:《MyBatis快速上手與知識點總結》 - 5.4 多條件查詢 - 動態查詢 2、腳本SQL 使用註解實現,將XML文件的內容轉換為註釋即可 當然,這種方式可讀性差,且難以維護 @Select("<script>s ...
  • 一、前言 我們在JavaWeb開發中必不可少的就是jar包管理-maven,在沒有maven之前,都是自己手動下載jar包導入到項目中,非常的繁瑣。 maven出現之後,又迎來新的問題,對於倉庫裡人家發佈的都可以引用下載,但是公司自己內部寫的jar包,不想讓外人看到,自己公司來回粘貼複製,非常的繁瑣 ...
  • 摘要:JVM參數分為三類:標準參數、非標準參數(-X參數)和高級選項(-XX參數)。本文主要為大家講解-X參數和-XX參數。 本文分享自華為雲社區《JVM運行參數之-X和-XX參數》,作者:共飲一杯無 。 JVM參數分為三類:標準參數、非標準參數(-X參數)和高級選項(-XX參數)。本文主要為大家講 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 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 ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...