python3 第二十二章 - 函數式編程之Decorator(裝飾器)

来源:https://www.cnblogs.com/mrbug/archive/2018/01/31/8326179.html
-Advertisement-
Play Games

前面我們說了,在python中,一切皆對象。函數也是一個對象,而且函數對象可以被賦值給變數,通過變數也能調用該函數。如: 以上代碼,輸出: 函數對象有一個__name__屬性,可以拿到函數的名字: 以上代碼,輸出: 你會發現,上例中的變數 f 也獲得了sayHello函數的功能,而且本質上它就是 s ...


前面我們說了,在python中,一切皆對象。函數也是一個對象,而且函數對象可以被賦值給變數,通過變數也能調用該函數。如:

def sayHello(name):
    print(name + ' hello')


fn = sayHello
fn('roy')

以上代碼,輸出:

roy hello

 

函數對象有一個__name__屬性,可以拿到函數的名字:

def sayHello(name):
    print(name + ' hello')


f =sayHello

print(f.__name__)
print(sayHello.__name__)

以上代碼,輸出:

sayHello
sayHello

你會發現,上例中的變數 f 也獲得了sayHello函數的功能,而且本質上它就是 sayHello 函數

 

如果,我想sayHello()這個函數在調用前先列印一句話,你可能會立刻想到,在函數的實現里再加一個print。這當然能達到效果,但是這也修改了函數的定義。

事實上,很多時候我們希望在不修改函數定義的情況下增強函數的功能,這種在代碼運行期間動態增加功能的方式,稱之為“裝飾器”(Decorator)。

 

裝飾器其實就是一個以函數作為參數並返回一個替換函數的可執行函數。讓我們先從簡單的開始:

def log(fn):
    def inner():
        print('調用 fn 之前')
        fn()

    return inner


def sayHello():
    print('say hello')


decorated = log(sayHello)
decorated()

以上代碼,輸出:

調用 fn 之前
say hello

 

我們可以說變數 decorated 是 sayHello 的裝飾版——即 sayHello加上一些東西。事實上,如果寫了一個實用的裝飾器,可能會想用裝飾版來代替 sayHello,這樣就總能得到“附帶其他東西”的 sayHello版本。用不著學習任何新的語法,通過將包含函數的變數重新賦值就能輕鬆做到這一點:

def log(fn):
    def inner():
        print('調用 fn 之前')
        fn()

    return inner


def sayHello():
    print('say hello')


sayHello = log(sayHello)
sayHello()

 以上代碼,輸出:

調用 fn 之前
say hello

現在任意調用 sayHello() 都不會得到原來的 sayHello,而是新的裝飾器版!明白了嗎?

 

現在這個sayHello函數是不帶參數的,那假如帶有參數的,又該怎麼寫呢?看實例:

def log(fn):
    def inner(name):
        print('調用 fn 之前')
        fn(name)

    return inner


def sayHello(name):
    print(name, 'say hello')


sayHello = log(sayHello)
sayHello('roy')

以上代碼,輸出:

調用 fn 之前
roy say hello

 

在上面代碼示例中,用了一個包裝的函數來替換包含函數的變數來實現了裝飾函數:

sayHello = log(sayHello)
sayHello('roy')

在Python3中通過在函數定義前添加一個裝飾器名和 @ 符號,來實現對函數的包裝,如:

def log(fn):
    def inner(name):
        print('調用 fn 之前')
        fn(name)

    return inner


@log
def sayHello(name):
    print(name, 'say hello')


sayHello('roy')

以上代碼,輸出:

調用 fn 之前
roy say hello

值得註意的是,這種方式和簡單的使用 log 函數的返回值來替換原始變數的做法沒有什麼不同—— Python 只是添加了一些語法糖來使之看起來更加明確。

 

上面我們寫了一個裝飾器,但它是硬編碼的,只適用於特定類型的函數——帶有1個參數的函數。內部函數 inner 接收1個參數,然後繼續將參數傳給閉包中的函數。如果我們想要一個能適用任何函數的裝飾器呢?這意味著這個裝飾器必須接收它所裝飾的任何函數的調用信息,並且在調用這些函數時將傳遞給該裝飾器的任何參數都傳遞給它們,所幸python提供這樣的語法,我們來寫一個通用的裝飾器:

def log(fn):
    """
    通用的裝飾器
    :param fn:
    :return:
    """
    def inner(*args, **kwargs):
        print('調用 %s 之前' % fn.__name__)
        fn(*args, **kwargs)

    return inner


@log
def sayHello(name):
    print(name, 'say hello')

@log
def sayGoodbye():
    print('say goodbye')


@log
def sayMessage(name, message):
    print(name, 'say', message)


sayHello('roy')
print()

sayGoodbye()
print()

sayMessage('roy', 'Hello World')

以上代碼,輸出:

調用 sayHello 之前
roy say hello

調用 sayGoodbye 之前
say goodbye

調用 sayMessage 之前
roy say Hello World

註:當定義一個函數時,*args 可以表示在調用函數時從迭代器中取出位置參數, 也可以表示在定義函數時接收額外的位置參數。使用 **kwargs 來表示所有未捕獲的關鍵字參數將會被存儲在字典 kwargs 中。此前 args 和 kwargs 都不是 Python 中語法的一部分,但在函數定義時使用這兩個變數名是一種慣例。和 * 的使用一樣,可以在函數調用和定義時使用 **

 

但,還有個問題,由於log函數是一個Decorator(裝飾器),返回一個函數,所以,原來的 sayGoodbye 函數仍然存在,只是現在同名的sayGoodbye變數指向了新的函數,於是調用sayGoodbye()將執行新函數,即在log函數中返回的inner函數。但你去看經過log函數裝飾之後的函數,它們的__name__已經從原來的'sayGoodbye'變成了'inner'了:

def log(fn):
    """
    通用的裝飾器
    :param fn:
    :return:
    """
    def inner(*args, **kwargs):
        print('調用 %s 之前' % fn.__name__)
        fn(*args, **kwargs)

    return inner



@log
def sayGoodbye():
    print('say goodbye')


print(sayGoodbye.__name__)

以上代碼,輸出:

inner

因為log函數中返回的那個函數名字就是'inner',所以,需要把原始函數的__name__等屬性複製到inner函數中,否則,有些依賴函數簽名的代碼執行就會出錯。

不需要編寫inner.__name__ = fn.__name__這樣的代碼,Python內置的functools.wraps就是乾這個事的,所以,一個完整的decorator的寫法如下:

import functools

def log(fn): """ 通用的裝飾器 :param fn: :return: """ @functools.wraps(fn) def inner(*args, **kwargs): print('調用 %s 之前' % fn.__name__) fn(*args, **kwargs) return inner @log def sayGoodbye(): print('say goodbye') print(sayGoodbye.__name__)

以上代碼,輸出:

sayGoodbye

 

如果Decorator(裝飾器)本身需要傳入參數,那要怎麼做呢?那就需要編寫一個返回decorator的高階函數,寫出來會更複雜。比如,要自定義log的文本:

import functools


def log(msg):

    def decorator(fn):
        """
        通用的裝飾器
        :param fn:
        :return:
        """

        @functools.wraps(fn)
        def inner(*args, **kwargs):
            print('調用 %s 之前' % fn.__name__)
            print('msg:',msg)
            fn(*args, **kwargs)

        return inner

    return decorator


@log('這是一個自定義消息')
def sayGoodbye():
    print('say goodbye')


sayGoodbye()

以上代碼,輸出:

調用 sayGoodbye 之前
msg: 這是一個自定義消息
say goodbye

 


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

-Advertisement-
Play Games
更多相關文章
  • 服務發現是基於微服務架構的關鍵原則之一。嘗試配置每個客戶端或某種形式的約定可能非常困難,可以非常脆弱。Consul通過HTTP API和DNS提供服務發現服務。Spring Cloud Consul利用HTTP API進行服務註冊和發現。這不會阻止非Spring雲應用程式利用DNS界面。Consul ...
  • 一個插排引發的設計思想 (一) 觀察者模式 一個插排引發的設計思想 (二) 抽象類與介面 一個插排引發的設計思想 (三) 委托與事件 ...待續.... 不知道聊到設計模式, 經常給人兩種感覺: 1. 原來這個就是A設計模式呀, 我之前也經常這麼乾, 就是到現在才知道A設計模式指的就是這個. 2. ...
  • C3P0連接池: 配置文件:c3p0-config.xml 測試: 數據準備: CREATE DATABASE mybase; USE mybase; CREATE TABLE users( uid INT PRIMARY KEY AUTO_INCREMENT, username VARCHAR(6 ...
  • 淺析final關鍵字 final單詞字面意思是“最終的,不可更改的”。所以在java中final關鍵字表示終態,即最終的狀態,“這個東西不能被改變”。 final關鍵字可以用來修飾類、方法、數據(包括成員變數、局部變數與方法參數)。 (1)final類 final關鍵字修飾的類是不能被繼承的。在這裡 ...
  • 關於JSP中的文件上傳和下載操作 先分析一下上傳文件的流程 1-先通過前段頁面中的選擇文件選擇要上傳的圖片index.jsp 2-點擊提交按鈕,通過ajax的文件上傳訪問伺服器端 common.js 3-伺服器端響應保存或者下載保存上傳文件的FileUpload.java 下載文件的FileDown ...
  • Servlet詳解 1.servlet簡單介紹 servlet是javaweb三大組件之一,他與filter ,listener 共同組成了javaweb的三大組件,Servlet(Server Applet)是Java Servlet的簡稱,解釋為運行在伺服器端的java小程式, 作用:用來接收客 ...
  • 1:題目描述 Given an array of integers, return indices of the two numbers such that they add up to a specific target. You may assume that each input would ...
  • 首先自己實現一個簡單的連接池: 數據準備: CREATE DATABASE mybase; USE mybase; CREATE TABLE users( uid INT PRIMARY KEY AUTO_INCREMENT, username VARCHAR(64), upassword VARC ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...