Python裝飾器（一次搞清楚）

来源:https://www.cnblogs.com/clwsec/archive/2023/10/09/17753194.html
-Advertisement-
Play Games

Python裝飾器是一種語法糖，用於在不改變原有函數代碼的情況下，為函數添加額外的功能。裝飾器本質上是一個函數，它接收一個函數作為參數，並返回一個新的函數，通常使用@語法糖來應用裝飾器。 1.裝飾器本質是一個函數，可稱之為函數裝飾器； 2.裝飾器也是一個閉包，即在非全局範圍內定義的函數可以引用其外圍... ...


最重要的情緒管理是要明白，沒有一種情緒是不應該的

一、簡單裝飾器

Python裝飾器是一種語法糖，用於在不改變原有函數代碼的情況下，為函數添加額外的功能。裝飾器本質上是一個函數，它接收一個函數作為參數，並返回一個新的函數，通常使用@語法糖來應用裝飾器。
1.裝飾器本質是一個函數，可稱之為函數裝飾器；
2.裝飾器也是一個閉包，即在非全局範圍內定義的函數可以引用其外圍空間中的變數；
3.裝飾器以一個函數作為參數，並且返回值也是一個函數；
4.裝飾器不能修改被裝飾的函數代碼；不能修改被裝飾函數的調用方式；
下麵是一個簡單的裝飾器示例：

def my_decorator(func):
    def wrapper():
        print("Before the function is called.")
        res = func()
        print("After the function is called.")
        return res
    return wrapper

@my_decorator
def say_hello():
    print("Hello!")

# 調用被裝飾的函數
say_hello()

在這個示例中，my_decorator是一個裝飾器函數，它接收一個函數作為參數，並返回一個新的函數wrapper。wrapper函數包裹了原有的函數，它在調用原有函數之前和之後列印了額外的信息。@my_decorator語法糖將say_hello函數傳遞給my_decorator，並將其返回的新函數wrapper賦值給say_hello，這樣調用say_hello函數時，實際上是調用了wrapper函數。執行結果為：
image.png

二、裝飾器的運用場景

裝飾器的應用非常廣泛，可以用於實現各種功能，例如：

  1. 記錄函數執行時間：通過在裝飾器函數中記錄函數執行的開始和結束時間，可以計算函數的執行時間。
  2. 緩存函數結果：通過在裝飾器函數中維護一個緩存，可以避免重覆計算相同參數的函數結果，提高函數的執行效率。
  3. 實現許可權控制：通過在裝飾器函數中檢查用戶的許可權，可以控制用戶對某些函數的訪問許可權。
  4. 日誌記錄：通過在裝飾器函數中記錄函數的輸入參數和返回值，可以方便地進行調試和錯誤排除。
  5. 錯誤處理：通過在裝飾器函數中捕獲異常併進行處理，可以避免函數拋出異常導致程式崩潰。

Python裝飾器是一種非常強大的語法糖，可以幫助我們實現各種功能，提高代碼的復用性和可維護性。

三、運用案列

案列一：Python緩存cache實現

Python中的緩存（cache）機制可以通過裝飾器來實現，但並不是所有的緩存都是通過裝飾器實現的。裝飾器是一種常用的實現緩存的方式，但是Python中還有其他的緩存實現方式，例如使用字典、使用緩存庫等。
使用裝飾器實現緩存的原理是，在裝飾器函數中維護一個字典，將函數的輸入參數作為鍵，函數的返回值作為值，存儲在字典中。在每次調用函數之前，先檢查字典中是否已經存在相同輸入參數的緩存結果，如果存在，則直接返回緩存結果，否則調用原函數計算結果，並將計算結果緩存到字典中。
下麵是一個簡單的裝飾器緩存示例：

def cache(func):
    cached_results = {}
    def wrapper(*args):
        if args in cached_results:
            return cached_results[args]
        result = func(*args)
        cached_results[args] = result
        return result
    return wrapper

@cache
def fibonacci(n):
    if n <= 1:
        return n    
    return fibonacci(n-1) + fibonacci(n-2)

print(fibonacci(10))

1.在這個示例中，cache是一個裝飾器函數，它接收一個函數作為參數，並返回一個新的函數wrapper。wrapper函數維護了一個cached_results字典，用於存儲函數的緩存結果。在調用被裝飾的函數之前，wrapper函數先檢查輸入參數args是否已經存在於cached_results中，如果存在，則直接返回緩存結果，否則調用原函數計算結果，並將結果存儲到cached_results中。
2.這個裝飾器可以用於緩存計算複雜的函數，例如計算斐波那契數列的函數fibonacci。在第一次調用fibonacci(10)時，由於沒有緩存結果，需要進行計算，計算結果存儲到字典中。在後續的調用中，只需要從字典中獲取結果即可，避免了重覆計算，提高了程式的執行效率。
3.需要註意的是，裝飾器緩存的實現方式可能存在一些問題，例如緩存數據的過期問題、記憶體占用問題等。因此，在實際使用中需要根據具體情況進行選擇和調整，以確保程式的正確性和性能。

案列二：列印函數執行時間消耗

import time
# 註意：這個是帶參數的裝飾器
def calculate_execution_time(unit='s'):
    def decorator(func):
        def wrapper(*args, **kwargs):
            start_time = time.time()
            result = func(*args, **kwargs)
            end_time = time.time()
            execution_time = end_time - start_time
            if unit == 'ms':
                execution_time *= 1000
                print(f"函數 {func.__name__} 的執行時間為: {execution_time:.2f} 毫秒")
            else:
                print(f"函數 {func.__name__} 的執行時間為: {execution_time:.2f} 秒")
            return result
        return wrapper
    return decorator

@calculate_execution_time(unit='ms')
def my_function(a, b):
    # 假設這裡是一個耗時的操作
    time.sleep(1)
    # 被裝飾函數本身的功能
    print("{0} + {1} = ".format(a, b), a+b)

my_function(1, 2)

1.上述代碼定義了一個名為calculate_execution_time的裝飾器，它接受一個可選的參數unit，用於指定執行時間的單位，預設為秒。裝飾器內部定義了另一個函數decorator，它接受被裝飾的函數func作為參數。在wrapper函數中，我們首先記錄函數執行開始的時間戳start_time，然後調用被裝飾的函數並獲取其返回值result，最後計算函數執行所花費的時間，並根據unit參數選擇合適的單位進行列印。
2.執行結果：
image.png
3.帶參數的裝飾器詳見下文。

四、帶參數的裝飾器

Python裝飾器可以用於裝飾任何可調用對象，包括函數和類。當裝飾函數帶參數時，需要在裝飾器函數里再定義一層函數來接收參數，這樣才能將參數傳遞給被裝飾的函數。
下麵是一個簡單的裝飾器示例，演示瞭如何在裝飾器函數中處理帶參數的函數：

from functools import wraps
def repeat(num):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            for i in range(num):
                print(f"Running function {func.__name__} for the {i+1} time")
                func(*args, **kwargs)
        return wrapper
    return decorator

@repeat(3)
def greet(name):
    print(f"Hello, {name}!")

greet("John")

1.在這個示例中，repeat是一個裝飾器函數，它接收一個參數num，用於指定函數重覆執行的次數。decorator是repeat的內部函數，它接收一個函數func作為參數，並返回一個新的函數wrapper。wrapper函數實現了函數的重覆執行功能，它在迴圈中調用被裝飾的函數func，並列印執行次數的信息。
另外，@wraps(func)用於保存函數的元信息，例如函數名、參數、註釋等，可以使用functools模塊中的wraps裝飾器來保存被裝飾函數的原信息。
2.wraps裝飾器實際上是一個裝飾器工廠函數，它接收一個函數作為參數，並返回一個新的裝飾器函數。這個新的裝飾器函數會將被裝飾的函數替換為自己，並使用functools模塊中的update_wrapper函數來將被裝飾函數的元信息複製到新的裝飾器函數中。
3.如果不使用wraps裝飾器來保存被裝飾函數的元信息，那麼被裝飾函數的元信息會被覆蓋，例如函數名會變成wrapper，函數註釋會變成裝飾器函數的註釋。
4.在應用裝飾器時，使用@語法糖將裝飾器函數repeat(3)應用到函數greet上，例如：

@repeat(3)
def greet(name):
    print(f"Hello, {name}!")

這樣，每次調用greet函數時，都會執行3次，列印出執行的次數和函數的輸出結果。
5.需要註意的是，在裝飾器函數中定義的參數，需要在裝飾器的每一層函數中進行傳遞和處理。在這個示例中，num參數在repeat函數中定義，被傳遞給decorator函數，最終在wrapper函數中使用。被裝飾的函數的參數，需要在wrapper函數中定義為*args和**kwargs，以支持任意數量和類型的參數，併在調用被裝飾的函數時傳遞給它。
6.執行結果：
image.png

五、裝飾器執行過程

像上面的函數，在代碼執行時，會首先將**@cache**載入（函數定義時），執行cache中的內容，不執行wrapper的內容（函數調用時）。後續fibonacci函數執行時，會先執行對應的wrapper的內容，再執行函數本身，即cache中的cached_results類似於wrapper的全局變數
image.png
後續的多次調用中，cache中僅wrapper的內容在執行
image.png

六、裝飾器的執行順序

說法一：裝飾順序按由下到上，調用時由上到下，執行順序和裝飾順序相反。（簡單記成正常的代碼順序即可）
說法二：裝飾器由下到上依次立馬執行，之後我們調用的f已經是被裝飾器執行了之後的f了，此時是由上到下返回去依次調用。整個過程有點像先上樓梯（裝飾過程），再下樓梯（調用函數）

def decorator_a(func):
    print('Get in decorator_a')
    def inner_a(*args, **kwargs):
        print('Get in inner_a')
        return func(*args, **kwargs)
    return inner_a

def decorator_b(func):
    print('Get in decorator_b')
    def inner_b(*args, **kwargs):
        print('Get in inner_b')
        return func(*args, **kwargs)
    return inner_b

@decorator_b
@decorator_a
def f(x):
    print('Get in f')
    return x * 2

f(1)

執行結果：
image.png
關於執行順序可參考：https://segmentfault.com/a/1190000007837364

感謝閱讀，如有問題，請批評指正，謝謝。
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Vue模板應用
    目錄Vue模板應用{{}} 變數插值v-once 只會插值一次v-html 對HTML代碼插值v-bindHTML標簽屬性的插值在外部傳遞數值類型的數據到組件內部時, 必須使用v-bind指令的方式進行傳遞, 直接使用HTML屬性設置的方式傳遞會將傳遞的數據作為字元串傳遞v-on 監聽、綁定事件v- ...
  • 記錄--前端換膚方案 - element+less無感換膚（無需頁面刷新）
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 前端換膚方案 - element+less無感換膚（無需頁面刷新） 前言 前不久在改造一個迭代了一年多的項目時，增加了一個換膚功能。通過自己的探索，總結出了一套比較合適的改造方案供大家參考，如有更好的方案歡迎評論區踴躍評論😄 先上效果： ...
  • 如何使用webgl(three.js)實現煤礦隧道、井下人員定位、掘進面、縱採面可視化解決方案——第十九課（一）
    three.js、webgl、3D煤礦隧道、三維井下人員定位、掘進面三維可視化、縱採面可視化、採集面可視化展示、設備檢測、數字孿生、物聯網3D、3d建築、3d庫房,bim管理系統 ...
  • VTable——不只是高性能的多維數據分析表格
    導讀 VTable: 不只是高性能的多維數據分析表格，更是行列間創作的方格藝術家！ VTable是位元組跳動開源可視化解決方案 VisActor 的組件之一。 在現代應用程式中，表格組件是不可或缺的一部分，它們能夠快速展示大量數據，並提供良好的可視化效果和交互體驗。VTable是一款基於可視化渲染引擎 ...
  • 學習筆記-設計模式-創建型模式-單例模式
    單例模式 一個類只有一個實例，並提供一個全局訪問此實例的點，哪怕多線程同時訪問。 單例模式主要解決了一個全局使用的類被頻繁的創建和消費的問題。 單例模式的案例場景 資料庫的連接池不會反覆創建 spring中一個單例模式bean的生成和使用 在我們平常的代碼中需要設置全局的一些屬性保存 七種單例模式的 ...
  • 全場景流量驗證系統
    本文介紹了一種基於線上流量實現對重構系統進行功能和性能驗證的實踐方案。針對線上流量如何攔截、如何錄製、如何存儲、如何回放以及如何發壓均作了詳細說明，為具有類似需求的讀者提供了一種可供參考的思路。 ...
  • 一文搞懂業務架構、技術架構、數據架構、運維架構、物理架構理清不同視角的架構
    一起學習下架構的視角。 架構的視角 在筆者的知識體系中，實際上將架構分為業務架構、應用架構、雲基礎架構這幾大類，業務架構主要著眼於控制業務的複雜性，基礎架構著眼於解決分散式系統中存在的一系列問題。無論何種架構，都希望能實現系統的可變的同時保障業務的高可用。 很多時候架構的視角/分類沒有明顯的邊界，通 ...
  • 入門篇-其之五-Java運算符（上）
    一、項目地址 https://github.com/LinFeng-BingYi/DailyAccountBook 二、新增 1. 在表格中設置選項列表，讓用戶更快地編輯動賬記錄 1.1 功能詳述 為表格中以下欄位設置選項列表： 1. 需求強度（由"基本需求"更名） 溫飽：基本維持生存且不鋪張浪費的 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類