Python筆記：Python裝飾器

裝飾器是通過裝飾器函數(shù)修改原函數(shù)的一些功能而不需要修改原函數(shù)，在很多場景可以用到它，比如① 執(zhí)行某個測試用例之前，判斷是否需要登錄或者執(zhí)行某些特定操作；② 統(tǒng)計某個函數(shù)的執(zhí)行時間；③ 判斷輸入合法性等。合理使用裝飾器可以極大地提高程序的可讀性以及運行效率。本文將介紹Python裝飾器的使用方法。

專注于為中小企業(yè)提供成都做網(wǎng)站、網(wǎng)站設(shè)計服務(wù),電腦端+手機端+微信端的三站合一,更高效的管理,為中小企業(yè)三明免費做網(wǎng)站提供優(yōu)質(zhì)的服務(wù)。我們立足成都，凝聚了一批互聯(lián)網(wǎng)行業(yè)人才，有力地推動了近1000家企業(yè)的穩(wěn)健成長，幫助中小企業(yè)通過網(wǎng)站建設(shè)實現(xiàn)規(guī)模擴充和轉(zhuǎn)變。

python裝飾器可以定義如下：

輸出：

python解釋器將test_decorator函數(shù)作為參數(shù)傳遞給my_decorator函數(shù)，并指向了內(nèi)部函數(shù) wrapper()，內(nèi)部函數(shù) wrapper() 又會調(diào)用原函數(shù) test_decorator()，所以decorator()的執(zhí)行會先打印'this is wrapper'，然后打印'hello world'， test_decorator()執(zhí)行完成后，打印 'bye' ，*args和**kwargs，表示接受任意數(shù)量和類型的參數(shù)。

裝飾器 my_decorator() 把真正需要執(zhí)行的函數(shù) test_decorator() 包裹在其中，并且改變了它的行為，但是原函數(shù) test_decorator() 不變。

一般使用如下形式使用裝飾器：

@my_decorator就相當(dāng)于 decorator = my_decorator(test_decorator) 語句。

內(nèi)置裝飾器@functools.wrap可用于保留原函數(shù)的元信息（將原函數(shù)的元信息，拷貝到對應(yīng)的裝飾器函數(shù)里）。先來看看沒有使用functools的情況：

輸出：

從上面的輸出可以看出test_decorator() 函數(shù)被裝飾以后元信息被wrapper() 函數(shù)取代了，可以使用@functools.wrap裝飾器保留原函數(shù)的元信息：

輸出：

裝飾器可以接受自定義參數(shù)。比如定義一個參數(shù)來設(shè)置裝飾器內(nèi)部函數(shù)的執(zhí)行次數(shù)：

輸出：

Python 支持多個裝飾器嵌套：

裝飾的過程：

順序從里到外：

test_decorator('hello world') 執(zhí)行順序和裝飾的過程相反。

輸出：

類也可以作為裝飾器，類裝飾器主要依賴__call__()方法，是python中所有能被調(diào)用的對象具有的內(nèi)置方法（python魔術(shù)方法），每當(dāng)調(diào)用一個類的實例時，__call__()就會被執(zhí)行一次。

下面的類裝飾器實現(xiàn)統(tǒng)計函數(shù)執(zhí)行次數(shù)：

輸出：

下面介紹兩種裝飾器使用場景

統(tǒng)計函數(shù)執(zhí)行所花費的時間

輸出：

在使用某些web服務(wù)時，需要先判斷用戶是否登錄，如果沒有登錄就跳轉(zhuǎn)到登錄頁面或者提示用戶登錄：

--THE END--

python裝飾器使用

裝飾器是從英文decorator翻譯過來的，從字面上來看就是對某個東西進行修飾，增強被修飾物的功能，下面我們對裝飾器做下簡單介紹。

一、怎么編寫裝飾器

裝飾器的實現(xiàn)很簡單，本質(zhì)是一個可調(diào)用對象，可以是函數(shù)、方法、對象等，它既可以裝飾函數(shù)也可以裝飾類和方法，為了簡單說明問題，我們實現(xiàn)一個函數(shù)裝飾器，如下代碼：

有了這個裝飾器，我們就可以打印出什么時候開始和結(jié)束調(diào)用函數(shù)，對于排查函數(shù)的調(diào)用鏈非常方便。

二、帶參數(shù)的裝飾器

上面的例子無論什么時候調(diào)用sum都會輸出信息，如果我們需要按需輸出信息怎么實現(xiàn)呢，這時就要用到帶參數(shù)的裝飾器了，如下代碼：

對sum使用裝飾器時沒有參數(shù)，這時debug為0，所以調(diào)用sum時不會輸出函數(shù)調(diào)用相關(guān)信息。

對multi使用裝飾器時有參數(shù)，這時debug為1，所以調(diào)用multi時會輸出函數(shù)調(diào)用相關(guān)信息。

三、函數(shù)名字問題

當(dāng)我們打印被裝飾后的函數(shù)名字時，不知道大家有沒發(fā)現(xiàn)輸出的不是函數(shù)本身的名字，如下代碼會輸出‘wrap’而不是‘sum’：

有時這種表現(xiàn)并不是我們想要的，我們希望被裝飾后的函數(shù)名字還是函數(shù)本身，那要怎么實現(xiàn)呢？很簡單，只需要引入functools.wraps即可，如下代碼就會輸出‘sum’了：

看完后是不是覺得python裝飾器很簡單，只要了解它的本質(zhì)，怎么寫都行，有好多種玩法呢。

「低門檻 手把手」python 裝飾器(Decorators)原理說明

本文目的是由淺入深地介紹python裝飾器原理

裝飾器(Decorators)是 Python 的一個重要部分

其功能是， 在不修改原函數(shù)(類)定義代碼的情況下，增加新的功能

為了理解和實現(xiàn)裝飾器，我們先引入2個核心操作：

在這個例子中，函數(shù)hi的形參name，默認(rèn)為'world'

在函數(shù)內(nèi)部，又定義了另一個函數(shù) howdoyoudo，定義這個函數(shù)時，將形參name作為新函數(shù)的形參name2的默認(rèn)值。

因此，在函數(shù)內(nèi)部調(diào)用howdoyoudo()時，將以調(diào)用hi時的實參為默認(rèn)值，但也可以給howdoyoudo輸入其他參數(shù)。

上面的例子運行后輸出結(jié)果為：

這里新定義的howdoyoudo可以稱作一個“閉包”。不少關(guān)于裝飾器的blog都提到了這個概念，但其實沒必要給它取一個多專業(yè)的名字。我們知道閉包是 函數(shù)內(nèi)的函數(shù) 就可以了

當(dāng)我們進行 def 的時候，我們在做什么？

這時，hi函數(shù)，打印一個字符串，同時返回一個字符串。

但hi函數(shù)本身也是一個對象，一個可以執(zhí)行的對象。執(zhí)行的方式是hi()。

這里hi和hi()有本質(zhì)區(qū)別，

hi 代表了這個函數(shù)對象本身

hi() 則是運行了函數(shù)，得到函數(shù)的返回值。

作為對比，可以想象以下代碼

此時也是b存在，可以正常使用。

我們定義2個函數(shù)，分別實現(xiàn)自加1， 自乘2，

再定義一個函數(shù)double_exec，內(nèi)容是將某個函數(shù)調(diào)用2次

在調(diào)用double_exec時，可以將函數(shù)作為輸入傳進來

輸出結(jié)果就是

7

27

同樣，也可以將函數(shù)作為輸出

輸出結(jié)果為

6

10

有了以上兩個核心操作，我們可以嘗試構(gòu)造裝飾器了。

裝飾器的目的： 在不修改原函數(shù)(類)定義代碼的情況下，增加新的功能

試想一下，現(xiàn)在有一個原函數(shù)

在不修改原函數(shù)定義代碼的情況下，如果想進行函數(shù)內(nèi)容的添加，可以將這個函數(shù)作為一個整體，添加到這樣的包裹中：

我們定義了一個my_decorator函數(shù)，這個函數(shù)進行了一種操作：

對傳入的f，添加操作(運行前后增加打印)，并把添加操作后的內(nèi)容連同運行原函數(shù)的內(nèi)容，一起傳出

這個my_decorator，定義了一種增加前后打印內(nèi)容的行為

調(diào)用my_decorator時，對這個行為進行了操作。

因此，new_function是一個在original_function上增加了前后打印行為的新函數(shù)

這個過程被可以被稱作裝飾。

這里已經(jīng)可以發(fā)現(xiàn)，裝飾器本身對于被裝飾的函數(shù)是什么，是不需要考慮的。裝飾器本身只定義了一種裝飾行為，這個行為是通過裝飾器內(nèi)部的閉包函數(shù)()進行定義的。

運行裝飾前后的函數(shù)，可以清晰看到裝飾的效果

我們復(fù)現(xiàn)一下實際要用裝飾器的情況，我們往往有一種裝飾器，想應(yīng)用于很多個函數(shù)，比如

此時，如果我們想給3個print函數(shù)都加上裝飾器，需要這么做

實際調(diào)用的時候，就需要調(diào)用添加裝飾器的函數(shù)名了

當(dāng)然，也可以賦值給原函數(shù)名

這樣至少不需要管理一系列裝飾前后的函數(shù)。

同時，在不需要進行裝飾的時候，需要把

全部刪掉。

事實上，這樣并不方便，尤其對于更復(fù)雜的裝飾器來說

為此，python提供了一種簡寫方式

這個定義print1函數(shù)前的@my_decorator，相當(dāng)于在定義完print1后，自動直接運行了

不論采用@my_decorator放在新函數(shù)前，還是顯示地重寫print1 = my_decorator(print1)，都會存在一個問題：

裝飾后的函數(shù)，名字改變了(其實不止名字，一系列的索引都改變了)

輸出結(jié)果為:

這個現(xiàn)象的原因是，裝飾行為本身，是通過構(gòu)造了一個新的函數(shù)（例子中是wrap_func函數(shù)）來實現(xiàn)裝飾這個行為的，然后把這個修改后的函數(shù)賦給了原函數(shù)名。

這樣，會導(dǎo)致我們預(yù)期的被裝飾函數(shù)的一些系統(tǒng)變量（比如__name__）發(fā)生了變化。

對此，python提供了解決方案：

經(jīng)過這個行為后，被裝飾函數(shù)的系統(tǒng)變量問題被解決了

輸出結(jié)果為

剛才的例子都比較簡單，被裝飾的函數(shù)是沒有參數(shù)的。如果被裝飾的函數(shù)有參數(shù)，只需要在定義裝飾行為時（事實上，這個才更通用），增加(*args, **kwargs)描述即可

之前的描述中可以感受到，對于例子中的裝飾行為(前后加打印)，函數(shù)被裝飾后，本質(zhì)上是調(diào)用了新的裝飾函數(shù)wrap_func。

因此，如果原函數(shù)需要有輸入?yún)?shù)傳遞，只需要在wrap_func（或其他任意名字的裝飾函數(shù)）定義時，也增加參數(shù)輸入(*args, **kwargs)，并將這些參數(shù)，原封不動地傳給待裝飾函數(shù)f。

這種定義裝飾行為的方式更具有普遍性，忘記之前的定義方式吧

我們試一下

輸出

這里需要注意的是，如果按照以下的方式定義裝飾器

那么以下語句將不會執(zhí)行

因為裝飾后實際的函數(shù)wrap_func(雖然名字被改成了原函數(shù)，系統(tǒng)參數(shù)也改成了原函數(shù))，運行到return f(*args, **kwargs) 的時候已經(jīng)結(jié)束了

因為裝飾器my_decorator本身也是可以輸入的，因此，只需要在定義裝飾器時，增加參數(shù)，并在后續(xù)函數(shù)中使用就可以了，比如

此時裝飾器已經(jīng)可以有輸入?yún)?shù)了

輸出

你可能發(fā)現(xiàn)，為什么不用簡寫版的方法了

因為以上代碼會報錯??！

究其原因，雖然

等價于

但是，

并不等價于

這本身和@語法有關(guān)，使用@my_decorator時，是系統(tǒng)在應(yīng)用一個以單個函數(shù)作為參數(shù)的閉包函數(shù)。即，@是不能帶參數(shù)的。

但是你應(yīng)該發(fā)現(xiàn)了，之前的@wraps(f)不是帶參數(shù)了嗎？請仔細觀察以下代碼

通過一層嵌套，my_decorator_with_parma本質(zhì)上是返回了一個參數(shù)僅為一個函數(shù)的函數(shù)(my_decorator)，但因為my_decorator對my_decorator_with_parma來說是一個閉包，my_decorator_with_parma是可以帶參數(shù)的。（這句話真繞）

通過以上的定義，我們再來看

可以這么理解，my_decorator_with_parma(msg='yusheng')的結(jié)果是原來的my_decorator函數(shù)，同時，因為my_decorator_with_parma可以傳參，參數(shù)實際上是參與了my_decorator的（因為my_decorator對my_decorator_with_parma是閉包）， my_decorator_with_parma(msg='yusheng') 全等于 一個有參數(shù)參加的my_decorator

因此，以上代碼等價于有參數(shù)msg傳遞的

比較繞，需要理解一下，或者干脆強記這種范式：

以上范式包含函數(shù)的輸入輸出、裝飾器的輸入，可以應(yīng)對大部分情況了。

實驗一下：

輸出

以上是一個log裝飾器，利用datetime統(tǒng)計了函數(shù)的耗時，

并且，裝飾器可以進行輸出文件操作，如果給出了文件路徑，則輸出文件，否則就打印。

利用這個裝飾器，可以靈活地進行耗時統(tǒng)計

不設(shè)置輸出文件地址，則打印。運行結(jié)果為：

也可以輸出到文件

輸出結(jié)果為

同時在當(dāng)前目錄生成了一個test.log 文件，內(nèi)容為：

以上的裝飾器都是以函數(shù)形式出現(xiàn)的，但我們可以稍做改寫，將裝飾器以類的形式實現(xiàn)。

這個裝飾器類Log 上個例子里的裝飾器函數(shù)log功能是一樣的，同時，這個裝飾器類還可以作為基類被其他繼承，進一步增加功能。

原文

新聞名稱：包含函數(shù)裝飾器python的詞條
轉(zhuǎn)載源于：http://www.rwnh.cn/article28/doggdcp.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站導(dǎo)航、網(wǎng)站內(nèi)鏈、靜態(tài)網(wǎng)站、微信公眾號、定制網(wǎng)站、域名注冊

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源： 創(chuàng)新互聯(lián)