什麼是Python裝飾器？

来源:https://www.cnblogs.com/xxpythonxx/archive/2023/02/14/17120050.html
-Advertisement-
Play Games

1.讓伺服器監聽客戶端的連接請求 1.1 代碼塊 #include <sys/socket.h> #include <netinet/in.h> #include <string.h> #include<stdio.h> #include<stdlib.h> #define BUFFER_LEN 1 ...


裝飾器是Python中非常重要的一個概念，如果你會Python的基本語法，你可以寫出能夠跑通的代碼，但是如果你想寫出高效、簡潔的代碼，我認為離不開這些高級用法，當然也包括本文要講解的裝飾器，就如同前面提到的代碼調試神器PySnooper一樣，它就是主要通過裝飾器調用的方式對Python代碼進行調試。

1.什麼是Python裝飾器？

顧名思義，從字面意思就可以理解，它是用來"裝飾"Python的工具，使得代碼更具有Python簡潔的風格。換句話說，它是一種函數的函數，因為裝飾器傳入的參數就是一個函數，然後通過實現各種功能來對這個函數的功能進行增強。

2.為什麼用裝飾器？

前面提到了，裝飾器是通過某種方式來增強函數的功能。當然，我們可以通過很多方式來增強函數的功能，只是裝飾器有一個無法替代的優勢--簡潔。

你只需要在每個函數上方加一個@就可以對這個函數進行增強。

3.在哪裡用裝飾器？

裝飾器最大的優勢是用於解決重覆性的操作，其主要使用的場景有如下幾個：

  • 計算函數運行時間
  • 給函數打日誌
  • 類型檢查

當然，如果遇到其他重覆操作的場景也可以類比使用裝飾器。

4.簡單示例

前面都是文字描述，不管說的怎麼天花爛墜，可能都無法體會到它的價值，下麵就以一個簡單的例子來看一下它的作用。

如果你要對多個函數進行統計運行時間，不使用裝飾器會是這樣的，

from time import time, sleep

def fun_one():
    start = time()
    sleep(1)
    end = time()
    cost_time = end - start
    print("func one run time {}".format(cost_time))
    
def fun_two():
    start = time()
    sleep(1)
    end = time()
    cost_time = end - start
    print("func two run time {}".format(cost_time))
    
def fun_three():
    start = time()
    sleep(1)
    end = time()
    cost_time = end - start
    print("func three run time {}".format(cost_time))

在每個函數里都需要獲取開始時間start、結束時間end、計算耗費時間cost_time、加上一個輸出語句。

使用裝飾器的方法是這樣的，

def run_time(func):
    def wrapper():
        start = time()
        func()                  # 函數在這裡運行
        end = time()
        cost_time = end - start
        print("func three run time {}".format(cost_time))
    return wrapper

@run_time
def fun_one():
    sleep(1)
    
@run_time
def fun_two():
    sleep(1)
    
@run_time
def fun_three():
    sleep(1)

通過編寫一個統計時間的裝飾器run_time，函數的作為裝飾器的參數，然後返回一個統計時間的函數wrapper，這就是裝飾器的寫法，用專業屬於來說這叫閉包，簡單來說就是函數內嵌套函數。然後再每個函數上面加上@run_time來調用這個裝飾器對不同的函數進行統計時間。

可見，統計時間這4行代碼是重覆的，一個函數需要4行，如果100個函數就需要400行，而使用裝飾器，只需要幾行代碼實現一個裝飾器，然後每個函數前面加一句命令即可，如果是100個函數，能少300行左右的代碼量。

5.帶參數的裝飾器

通過前面簡單的例子應該已經明白裝飾器的價值和它的簡單用法：通過閉包來實現裝飾器，函數作為外層函數的傳入參數，然後在內層函數中運行、附加功能，隨後把內層函數作為結果返回。

除了上述簡單的用法還有一些更高級的用法，比如用裝飾器進行類型檢查、添加帶參數的的裝飾器等。它們的用法大同小異，關於高級用法，這裡以帶參數的裝飾器為例進行介紹。

不要把問題想的太複雜，帶參數的裝飾器其實就是在上述基本的裝飾器的基礎上在外面套一層接收參數的函數，下麵通過一個例子說明一下。

以上述例子為基礎，前面的簡單示例輸出的信息是，

func three run time 1.0003271102905273
func three run time 1.0006263256072998
func three run time 1.000312328338623

現在我認為這樣的信息太單薄，需要它攜帶更多的信息，例如函數名稱、日誌等級等，這時候可以把函數名稱和日誌等級作為裝飾器的參數，下麵來時實現以下。

def logger(msg=None):
    def run_time(func):
        def wrapper(*args, **kwargs):
            start = time()
            func()                  # 函數在這裡運行
            end = time()
            cost_time = end - start
            print("[{}] func three run time {}".format(msg, cost_time))
        return wrapper
    return run_time

@logger(msg="One")
def fun_one():
    sleep(1)
    
@logger(msg="Two")
def fun_two():
    sleep(1)
    
@logger(msg="Three")
def fun_three():
    sleep(1)
    
fun_one()
fun_two()
fun_three()

可以看出，我在示例基本用法里編寫的裝飾器外層又嵌套了一層函數用來接收參數msg，這樣的話在每個函數(func_one、func_two、func_three)前面調用時可以給裝飾器傳入參數，這樣的輸出結果是，

[One] func three run time 1.0013229846954346
[Two] func three run time 1.000720500946045
[Three] func three run time 1.0001459121704102

6.自定義屬性的裝飾器

上述介紹的幾種用法中其實有一個問題，就是裝飾器不夠靈活，我們預先定義了裝飾器run_time，它就會按照我們定義的流程去工作，只具備這固定的一種功能，當然，我們前面介紹的通過帶參數的裝飾器讓它具備了一定的靈活性，但是依然不夠靈活。其實，我們還可以對裝飾器添加一些屬性，就如同給一個類定義實現不同功能的方法那樣。

以輸出日誌為例，初學Python的同學都習慣用print列印輸出信息，其實這不是一個好習慣，當開發商業工程時，你很用意把一些信息暴露給用戶。在開發過程中，我更加鼓勵使用日誌進行輸出，通過定義WARNING、DEBUG、INFO等不同等級來控制信息的輸出，比如INFO是可以給用戶看到的，讓用戶直到當前程式跑到哪一個階段了。DEBUG是用於開發人員調試和定位問題時使用。WARING是用於告警和提示。

那麼問題來了，如果我們預先定義一個列印日誌的裝飾器，

def logger_info(func):
    logmsg = func.__name__
    def wrapper():
        func() 
        log.log(logging.INFO, "{} if over.".format(logmsg))
    return wrapper

http://logging.INFO是列印日誌的等級，如果我們僅僅寫一個基本的日誌裝飾器logger_info，那麼它的靈活度太差了，因為如果我們要輸出DEBUG、WARING等級的日誌，還需要重新寫一個裝飾器。

解決這個問題，有兩個解決方法：

  • 利用前面所講的帶參數裝飾器，把日誌等級傳入裝飾器
  • 利用自定義屬性來修改日誌等級

由於第一種已經以統計函數運行時間的方式進行講解，這裡主要講解第二種方法。

先看一下代碼，

import logging
from functools import partial

def wrapper_property(obj, func=None):
    if func is None:
        return partial(attach_wrapper, obj)
    setattr(obj, func.__name__, func)
    return func

def logger_info(level, name=None, message=None):
    def decorate(func):
        
        logmsg = message if message else func.__name__

        def wrapper(*args, **kwargs):
            log.log(level, logmsg)
            return func(*args, **kwargs)

        @wrapper_property(wrapper)
        def set_level(newlevel):
            nonlocal level
            level = newlevel

        @wrapper_property(wrapper)
        def set_message(newmsg):
            nonlocal logmsg
            logmsg = newmsg

        return wrapper

    return decorate


@logger_info(logging.WARNING)
def main(x, y):
    return x + y

這裡面最重要的是wrapper_property這個函數，它的功能是把一個函數func編程一個對象obj的屬性，然後通過調用wrapper_property，給裝飾器添加了兩個屬性set_message和set_level，分別用於改變輸出日誌的內容和改變輸出日誌的等級。

看一下輸出結果，

main(3, 3)

# 輸出
# WARNING:Test:main
# 6

來改改變一下輸出日誌等級，

main.set_level(logging.ERROR)
main(5, 5)

# 輸出
# ERROR:Test:main
# 10

輸出日誌等級改成了ERROR。

7.保留元信息的裝飾器

很多教程中都會介紹裝飾器，但是大多數都是千篇一律的圍繞基本用法在展開，少部分會講一下帶參數的裝飾器，但是有一個細節很少有教程提及，那就是保留元信息的裝飾器。

什麼是函數的元信息？

就是函數攜帶的一些基本信息，例如函數名、函數文檔等，我們可以通過func.name獲取函數名、可以通過func.doc獲取函數的文檔信息，用戶也可以通過註解等方式為函數添加元信息。

例如下麵代碼，

from time import time

def run_time(func):
    def wrapper(*args, **kwargs):
        start = time()
        func()                  # 函數在這裡運行
        end = time()
        cost_time = end - start
        print("func three run time {}".format(cost_time))
    return wrapper

#學習中遇到問題沒人解答？小編創建了一個Python學習交流群：711312441
@run_time
def fun_one():
    '''
    func one doc.
    '''
    sleep(1)
    
fun_one()

print(fun_one.__name__)
print(fun_one.__doc__)

# 輸出
# wrapper
# None

可以看出，通過使用裝飾器，函數fun_one的元信息都丟失了，那怎麼樣才能保留裝飾器的元信息呢？

可以通過使用Python自帶模塊functools中的wraps來保留函數的元信息，

from time import time
from functools import wraps

def run_time(func):
    @wraps(func)                                # <- 這裡加 wraps(func) 即可
    def wrapper(*args, **kwargs):
        start = time()
        func()                  # 函數在這裡運行
        end = time()
        cost_time = end - start
        print("func three run time {}".format(cost_time))
    return wrapper

@run_time
def fun_one():
    '''
    func one doc.
    '''
    sleep(1)
    
fun_one()

print(fun_one.__name__)
print(fun_one.__doc__)

# 輸出
# fun_one   
# func one doc.

只需要在代碼中加入箭頭所指的一行即可保留函數的元信息。


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

-Advertisement-
Play Games
更多相關文章
  • day09-1-數據格式化
    數據格式化 1.基本介紹 說明：在我們提交數據(比如表單時)，SpringMVC 是怎樣對提交的數據進行轉換和處理的 基本數據類型可以和字元串之間自動進行轉換，比如：SpringMVC 上下文中內建了很多轉換器，可以完成大多數 java 類型的轉換工作。[相互轉換，這裡只列出部分] Conversi ...
  • Go基礎系列 01-Golang簡介
    1.什麼是Golang Go（又稱Golang）是Google開發的一種靜態強類型、編譯型、併發型，並具有垃圾回收功能的編程語言。Go支持面向對象，而且具有真正的閉包(closures)和反射 (reflection)等功能。 2.谷歌為什麼要創造Go語言 1.電腦硬體技術更新頻繁，性能提高很快。 ...
  • 《分散式技術原理與演算法解析》學習筆記Day11
    這篇文章繼續討論分散式架構中的調度演算法，為瞭解決單體調度面臨的問題，我們引入兩層調度。我們會討論兩層調度的工作原理，兩種使用了兩層調度的解決方案：Apache Mesos和Hadoop YARN。 ...
  • 「CSP-J2020」 直播獲獎 —— 桶排序例題
    ~~（oh!多麼美好的一天）~~ 看題！ 原題鏈接（洛谷） [CSP-J2020] 直播獲獎 題目描述 NOI2130 即將舉行。為了增加觀賞性，CCF 決定逐一評出每個選手的成績，並直播即時的獲獎分數線。本次競賽的獲獎率為 w%，即當前排名前 w% 的選手的最低成績就是即時的分數線。 更具體地，若 ...
  • 線程私有變數ThreadLocal詳解
    本文已收錄至Github，推薦閱讀 👉 Java隨想錄 微信公眾號：Java隨想錄 CSDN： 碼農BookSea 烈火試真金，逆境試強者。——塞內加 什麼是ThreadLocal 首先看下ThreadLocal的使用示例： public class ThreadLocalTest { priva ...
  • 轉換率優化教程_編程入門自學教程_菜鳥教程-免費教程分享
    教程簡介 轉換率優化定義 - 從定義，基礎知識，瞭解客戶，目標設置，誤區，優化計劃，用戶體驗和漏斗優化，目標網頁優化，降低退回和退出率，測試和優化，測量結果，學習轉換率優化優化技巧，結論。 教程目錄 轉換率優化 - 定義 轉換率優化 - 基礎知識 瞭解您的客戶 轉換率優化 - 目標設定 轉換率優化 ...
  • 下載某乎專欄文章並存為markdown
    前言 由於在2月13日，Autojs的作者發出公告將審查所有代碼，併在最新版刪除了無障礙截圖、通知監聽等功能，在打開所有版本都會提示強制更新，之前關註的公眾號都連夜刪除了教程文章，在搜索時，發現教程作者的文章在其它平臺還未刪除，為了保險起見，備份一下他的文章。由於他寫的文章很多，文章將通過爬蟲的方式 ...
  • LinQ教程_編程入門自學教程_菜鳥教程-免費教程分享
    教程簡介 LINQ初學者教程 - 從簡單和簡單的步驟學習LINQ（語言集成查詢），從基本到高級概念，包括概述，環境設置，標準查詢運算符，LINQ to SQL，LINQ對象，LINQ到數據集，LINQ到XML， LINQ to Entities，LINQ Lambda表達式，LINQ with AS ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類