本文目的是由淺入深地介紹python裝飾器原理
公司專注于為企業(yè)提供網(wǎng)站制作、成都做網(wǎng)站、微信公眾號(hào)開發(fā)、電子商務(wù)商城網(wǎng)站建設(shè)，微信小程序定制開發(fā)，軟件按需開發(fā)網(wǎng)站等一站式互聯(lián)網(wǎng)企業(yè)服務(wù)。憑借多年豐富的經(jīng)驗(yàn)，我們會(huì)仔細(xì)了解各客戶的需求而做出多方面的分析、設(shè)計(jì)、整合，為客戶設(shè)計(jì)出具風(fēng)格及創(chuàng)意性的商業(yè)解決方案，創(chuàng)新互聯(lián)公司更提供一系列網(wǎng)站制作和網(wǎng)站推廣的服務(wù)。
裝飾器(Decorators)是 Python 的一個(gè)重要部分
其功能是， 在不修改原函數(shù)(類)定義代碼的情況下，增加新的功能
為了理解和實(shí)現(xiàn)裝飾器，我們先引入2個(gè)核心操作：
在這個(gè)例子中，函數(shù)hi的形參name，默認(rèn)為'world'
在函數(shù)內(nèi)部，又定義了另一個(gè)函數(shù) howdoyoudo，定義這個(gè)函數(shù)時(shí)，將形參name作為新函數(shù)的形參name2的默認(rèn)值。
因此，在函數(shù)內(nèi)部調(diào)用howdoyoudo()時(shí)，將以調(diào)用hi時(shí)的實(shí)參為默認(rèn)值，但也可以給howdoyoudo輸入其他參數(shù)。
上面的例子運(yùn)行后輸出結(jié)果為：
這里新定義的howdoyoudo可以稱作一個(gè)“閉包”。不少關(guān)于裝飾器的blog都提到了這個(gè)概念，但其實(shí)沒必要給它取一個(gè)多專業(yè)的名字。我們知道閉包是 函數(shù)內(nèi)的函數(shù) 就可以了
當(dāng)我們進(jìn)行 def 的時(shí)候，我們?cè)谧鍪裁矗?/p>
這時(shí)，hi函數(shù)，打印一個(gè)字符串，同時(shí)返回一個(gè)字符串。
但hi函數(shù)本身也是一個(gè)對(duì)象，一個(gè)可以執(zhí)行的對(duì)象。執(zhí)行的方式是hi()。
這里hi和hi()有本質(zhì)區(qū)別，
hi 代表了這個(gè)函數(shù)對(duì)象本身
hi() 則是運(yùn)行了函數(shù)，得到函數(shù)的返回值。
作為對(duì)比，可以想象以下代碼
此時(shí)也是b存在，可以正常使用。
我們定義2個(gè)函數(shù)，分別實(shí)現(xiàn)自加1， 自乘2，
再定義一個(gè)函數(shù)double_exec，內(nèi)容是將某個(gè)函數(shù)調(diào)用2次
在調(diào)用double_exec時(shí)，可以將函數(shù)作為輸入傳進(jìn)來
輸出結(jié)果就是
7
27
同樣，也可以將函數(shù)作為輸出
輸出結(jié)果為
6
10
有了以上兩個(gè)核心操作，我們可以嘗試構(gòu)造裝飾器了。
裝飾器的目的： 在不修改原函數(shù)(類)定義代碼的情況下，增加新的功能
試想一下，現(xiàn)在有一個(gè)原函數(shù)
在不修改原函數(shù)定義代碼的情況下，如果想進(jìn)行函數(shù)內(nèi)容的添加，可以將這個(gè)函數(shù)作為一個(gè)整體，添加到這樣的包裹中：
我們定義了一個(gè)my_decorator函數(shù)，這個(gè)函數(shù)進(jìn)行了一種操作：
對(duì)傳入的f，添加操作(運(yùn)行前后增加打印)，并把添加操作后的內(nèi)容連同運(yùn)行原函數(shù)的內(nèi)容，一起傳出
這個(gè)my_decorator，定義了一種增加前后打印內(nèi)容的行為
調(diào)用my_decorator時(shí)，對(duì)這個(gè)行為進(jìn)行了操作。
因此，new_function是一個(gè)在original_function上增加了前后打印行為的新函數(shù)
這個(gè)過程被可以被稱作裝飾。
這里已經(jīng)可以發(fā)現(xiàn)，裝飾器本身對(duì)于被裝飾的函數(shù)是什么，是不需要考慮的。裝飾器本身只定義了一種裝飾行為，這個(gè)行為是通過裝飾器內(nèi)部的閉包函數(shù)()進(jìn)行定義的。
運(yùn)行裝飾前后的函數(shù)，可以清晰看到裝飾的效果
我們復(fù)現(xiàn)一下實(shí)際要用裝飾器的情況，我們往往有一種裝飾器，想應(yīng)用于很多個(gè)函數(shù)，比如
此時(shí)，如果我們想給3個(gè)print函數(shù)都加上裝飾器，需要這么做
實(shí)際調(diào)用的時(shí)候，就需要調(diào)用添加裝飾器的函數(shù)名了
當(dāng)然，也可以賦值給原函數(shù)名
這樣至少不需要管理一系列裝飾前后的函數(shù)。
同時(shí)，在不需要進(jìn)行裝飾的時(shí)候，需要把
全部刪掉。
事實(shí)上，這樣并不方便，尤其對(duì)于更復(fù)雜的裝飾器來說
為此，python提供了一種簡(jiǎn)寫方式
這個(gè)定義print1函數(shù)前的@my_decorator，相當(dāng)于在定義完print1后，自動(dòng)直接運(yùn)行了
不論采用@my_decorator放在新函數(shù)前，還是顯示地重寫print1 = my_decorator(print1)，都會(huì)存在一個(gè)問題：
裝飾后的函數(shù)，名字改變了(其實(shí)不止名字，一系列的索引都改變了)
輸出結(jié)果為:
這個(gè)現(xiàn)象的原因是，裝飾行為本身，是通過構(gòu)造了一個(gè)新的函數(shù)（例子中是wrap_func函數(shù)）來實(shí)現(xiàn)裝飾這個(gè)行為的，然后把這個(gè)修改后的函數(shù)賦給了原函數(shù)名。
這樣，會(huì)導(dǎo)致我們預(yù)期的被裝飾函數(shù)的一些系統(tǒng)變量（比如__name__）發(fā)生了變化。
對(duì)此，python提供了解決方案：
經(jīng)過這個(gè)行為后，被裝飾函數(shù)的系統(tǒng)變量問題被解決了
輸出結(jié)果為
剛才的例子都比較簡(jiǎn)單，被裝飾的函數(shù)是沒有參數(shù)的。如果被裝飾的函數(shù)有參數(shù)，只需要在定義裝飾行為時(shí)（事實(shí)上，這個(gè)才更通用），增加(*args, **kwargs)描述即可
之前的描述中可以感受到，對(duì)于例子中的裝飾行為(前后加打印)，函數(shù)被裝飾后，本質(zhì)上是調(diào)用了新的裝飾函數(shù)wrap_func。
因此，如果原函數(shù)需要有輸入?yún)?shù)傳遞，只需要在wrap_func（或其他任意名字的裝飾函數(shù)）定義時(shí)，也增加參數(shù)輸入(*args, **kwargs)，并將這些參數(shù)，原封不動(dòng)地傳給待裝飾函數(shù)f。
這種定義裝飾行為的方式更具有普遍性，忘記之前的定義方式吧
我們?cè)囈幌?/p>
輸出
這里需要注意的是，如果按照以下的方式定義裝飾器
那么以下語(yǔ)句將不會(huì)執(zhí)行
因?yàn)檠b飾后實(shí)際的函數(shù)wrap_func(雖然名字被改成了原函數(shù)，系統(tǒng)參數(shù)也改成了原函數(shù))，運(yùn)行到return f(*args, **kwargs) 的時(shí)候已經(jīng)結(jié)束了
因?yàn)檠b飾器my_decorator本身也是可以輸入的，因此，只需要在定義裝飾器時(shí)，增加參數(shù)，并在后續(xù)函數(shù)中使用就可以了，比如
此時(shí)裝飾器已經(jīng)可以有輸入?yún)?shù)了
輸出
你可能發(fā)現(xiàn)，為什么不用簡(jiǎn)寫版的方法了
因?yàn)橐陨洗a會(huì)報(bào)錯(cuò)?。?/p>
究其原因，雖然
等價(jià)于
但是，
并不等價(jià)于
這本身和@語(yǔ)法有關(guān)，使用@my_decorator時(shí)，是系統(tǒng)在應(yīng)用一個(gè)以單個(gè)函數(shù)作為參數(shù)的閉包函數(shù)。即，@是不能帶參數(shù)的。
但是你應(yīng)該發(fā)現(xiàn)了，之前的@wraps(f)不是帶參數(shù)了嗎？請(qǐng)仔細(xì)觀察以下代碼
通過一層嵌套，my_decorator_with_parma本質(zhì)上是返回了一個(gè)參數(shù)僅為一個(gè)函數(shù)的函數(shù)(my_decorator)，但因?yàn)閙y_decorator對(duì)my_decorator_with_parma來說是一個(gè)閉包，my_decorator_with_parma是可以帶參數(shù)的。（這句話真繞）
通過以上的定義，我們?cè)賮砜?/p>
可以這么理解，my_decorator_with_parma(msg='yusheng')的結(jié)果是原來的my_decorator函數(shù)，同時(shí)，因?yàn)閙y_decorator_with_parma可以傳參，參數(shù)實(shí)際上是參與了my_decorator的（因?yàn)閙y_decorator對(duì)my_decorator_with_parma是閉包）， my_decorator_with_parma(msg='yusheng') 全等于 一個(gè)有參數(shù)參加的my_decorator
因此，以上代碼等價(jià)于有參數(shù)msg傳遞的
比較繞，需要理解一下，或者干脆強(qiáng)記這種范式：
以上范式包含函數(shù)的輸入輸出、裝飾器的輸入，可以應(yīng)對(duì)大部分情況了。
實(shí)驗(yàn)一下：
輸出
以上是一個(gè)log裝飾器，利用datetime統(tǒng)計(jì)了函數(shù)的耗時(shí)，
并且，裝飾器可以進(jìn)行輸出文件操作，如果給出了文件路徑，則輸出文件，否則就打印。
利用這個(gè)裝飾器，可以靈活地進(jìn)行耗時(shí)統(tǒng)計(jì)
不設(shè)置輸出文件地址，則打印。運(yùn)行結(jié)果為：
也可以輸出到文件
輸出結(jié)果為
同時(shí)在當(dāng)前目錄生成了一個(gè)test.log 文件，內(nèi)容為：
以上的裝飾器都是以函數(shù)形式出現(xiàn)的，但我們可以稍做改寫，將裝飾器以類的形式實(shí)現(xiàn)。
這個(gè)裝飾器類Log 上個(gè)例子里的裝飾器函數(shù)log功能是一樣的，同時(shí)，這個(gè)裝飾器類還可以作為基類被其他繼承，進(jìn)一步增加功能。
原文
裝飾器是通過裝飾器函數(shù)修改原函數(shù)的一些功能而不需要修改原函數(shù)，在很多場(chǎng)景可以用到它，比如① 執(zhí)行某個(gè)測(cè)試用例之前，判斷是否需要登錄或者執(zhí)行某些特定操作；② 統(tǒng)計(jì)某個(gè)函數(shù)的執(zhí)行時(shí)間；③ 判斷輸入合法性等。合理使用裝飾器可以極大地提高程序的可讀性以及運(yùn)行效率。本文將介紹Python裝飾器的使用方法。
python裝飾器可以定義如下：
輸出：
python解釋器將test_decorator函數(shù)作為參數(shù)傳遞給my_decorator函數(shù)，并指向了內(nèi)部函數(shù) wrapper()，內(nèi)部函數(shù) wrapper() 又會(huì)調(diào)用原函數(shù) test_decorator()，所以decorator()的執(zhí)行會(huì)先打印'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) 語(yǔ)句。
內(nèi)置裝飾器@functools.wrap可用于保留原函數(shù)的元信息（將原函數(shù)的元信息，拷貝到對(duì)應(yīng)的裝飾器函數(shù)里）。先來看看沒有使用functools的情況：
輸出：
從上面的輸出可以看出test_decorator() 函數(shù)被裝飾以后元信息被wrapper() 函數(shù)取代了，可以使用@functools.wrap裝飾器保留原函數(shù)的元信息：
輸出：
裝飾器可以接受自定義參數(shù)。比如定義一個(gè)參數(shù)來設(shè)置裝飾器內(nèi)部函數(shù)的執(zhí)行次數(shù)：
輸出：
Python 支持多個(gè)裝飾器嵌套：
裝飾的過程：
順序從里到外：
test_decorator('hello world') 執(zhí)行順序和裝飾的過程相反。
輸出：
類也可以作為裝飾器，類裝飾器主要依賴__call__()方法，是python中所有能被調(diào)用的對(duì)象具有的內(nèi)置方法（python魔術(shù)方法），每當(dāng)調(diào)用一個(gè)類的實(shí)例時(shí)，__call__()就會(huì)被執(zhí)行一次。
下面的類裝飾器實(shí)現(xiàn)統(tǒng)計(jì)函數(shù)執(zhí)行次數(shù)：
輸出：
下面介紹兩種裝飾器使用場(chǎng)景
統(tǒng)計(jì)函數(shù)執(zhí)行所花費(fèi)的時(shí)間
輸出：
在使用某些web服務(wù)時(shí)，需要先判斷用戶是否登錄，如果沒有登錄就跳轉(zhuǎn)到登錄頁(yè)面或者提示用戶登錄：
--THE END--
裝飾器其實(shí)一直是我的一個(gè)"老大難"。這個(gè)知識(shí)點(diǎn)就放在那，但是拖延癥。。。
其實(shí)在平常寫寫腳本的過程中，這個(gè)知識(shí)點(diǎn)你可能用到不多
但在面試的時(shí)候，這可是一個(gè)高頻問題。
所謂的裝飾器，其實(shí)就是通過裝飾器函數(shù)，來修改原函數(shù)的一些功能，使得原函數(shù)不需要修改。
這一句話理解起來可能沒那么輕松，那先來看一個(gè)"傻瓜"函數(shù)。
放心，絕對(duì)不是"Hello World"！
怎么樣，沒騙你吧？ 哈哈，這個(gè)函數(shù)不用運(yùn)行相信大家都知道輸出結(jié)果： "你好，裝飾器" 。
那如果我想讓 hello() 函數(shù)再實(shí)現(xiàn)個(gè)其他功能，比如多打印一句話。
那么，可以這樣"增強(qiáng)"一下：
運(yùn)行結(jié)果：
很顯然，這個(gè)"增強(qiáng)"沒啥作用，但是可以幫助理解裝飾器。
當(dāng)運(yùn)行最后的 hello() 函數(shù)時(shí)，調(diào)用過程是這樣的：
那上述代碼里的 my_decorator() 就是一個(gè)裝飾器。
它改變了 hello() 的行為，但是并沒有去真正的改變 hello()函數(shù) 的內(nèi)部實(shí)現(xiàn)。
但是，python一直以"優(yōu)雅"被人追捧，而上述的代碼顯然不夠優(yōu)雅。
所以，想讓上述裝飾器變得優(yōu)雅，可以這樣寫：
這里的 @my_decorator 就相當(dāng)于舊代碼的 hello = my_decorator(hello) ， @ 符號(hào)稱為語(yǔ)法糖。
那如果還有其他函數(shù)也需要加上類似的裝飾，直接在函數(shù)的上方加上 @my_decorator 就可以，大大提高函數(shù)
的重復(fù)利用與可讀性。
輸出：
上面的只是一個(gè)非常簡(jiǎn)單的裝飾器，但是實(shí)際場(chǎng)景中，很多函數(shù)都是要帶有參數(shù)的，比如hello(people_name)。
其實(shí)也很簡(jiǎn)單，要什么我們就給什么唄，直接在對(duì)應(yīng)裝飾器的 wrapper() 上，加上對(duì)應(yīng)的參數(shù)：
輸出：
但是還沒完，這樣雖然簡(jiǎn)單，但是隨之而來另一個(gè)問題：因?yàn)椴⒉皇撬泻瘮?shù)參數(shù)都是一樣的，
當(dāng)其他要使用裝飾器的函數(shù)參數(shù)不止這個(gè)一個(gè)腫么辦？比如：
沒關(guān)系，在python里， *args 和 **kwargs 表示接受任意數(shù)量和類型的參數(shù)，所以我們可以這樣
寫裝飾器里的 wrapper() 函數(shù)：
同時(shí)運(yùn)行下 hello("老王") ，和 hello3("張三", "李四") ，看結(jié)果：
上面2種，裝飾器都是接收外來的參數(shù)，其實(shí)裝飾器還可以接收自己的參數(shù)。
比如，我加個(gè)參數(shù)來控制下裝飾器中打印信息的次數(shù)：
注意，這里 count 裝飾函數(shù)中的2個(gè) return .
運(yùn)行下，應(yīng)該會(huì)出現(xiàn)3次：
現(xiàn)在多做一步 探索 ，我們來打印下下面例子中的hello()函數(shù)的元信息：
輸出：
這說明了，它不再是以前的那個(gè) hello() 函數(shù)，而是被 wrapper() 函數(shù)取代了。
如果我們需要用到元函數(shù)信息，那怎么保留它呢？這時(shí)候可以用內(nèi)置裝飾器 @functools.wrap 。
運(yùn)行下：
好記性不如爛筆頭，寫一下理解一下會(huì)好很多。
下面還分享類的裝飾器，以及裝飾器所用場(chǎng)景。
裝飾器是從英文decorator翻譯過來的，從字面上來看就是對(duì)某個(gè)東西進(jìn)行修飾，增強(qiáng)被修飾物的功能，下面我們對(duì)裝飾器做下簡(jiǎn)單介紹。
一、怎么編寫裝飾器
裝飾器的實(shí)現(xiàn)很簡(jiǎn)單，本質(zhì)是一個(gè)可調(diào)用對(duì)象，可以是函數(shù)、方法、對(duì)象等，它既可以裝飾函數(shù)也可以裝飾類和方法，為了簡(jiǎn)單說明問題，我們實(shí)現(xiàn)一個(gè)函數(shù)裝飾器，如下代碼：
有了這個(gè)裝飾器，我們就可以打印出什么時(shí)候開始和結(jié)束調(diào)用函數(shù)，對(duì)于排查函數(shù)的調(diào)用鏈非常方便。
二、帶參數(shù)的裝飾器
上面的例子無論什么時(shí)候調(diào)用sum都會(huì)輸出信息，如果我們需要按需輸出信息怎么實(shí)現(xiàn)呢，這時(shí)就要用到帶參數(shù)的裝飾器了，如下代碼：
對(duì)sum使用裝飾器時(shí)沒有參數(shù)，這時(shí)debug為0，所以調(diào)用sum時(shí)不會(huì)輸出函數(shù)調(diào)用相關(guān)信息。
對(duì)multi使用裝飾器時(shí)有參數(shù)，這時(shí)debug為1，所以調(diào)用multi時(shí)會(huì)輸出函數(shù)調(diào)用相關(guān)信息。
三、函數(shù)名字問題
當(dāng)我們打印被裝飾后的函數(shù)名字時(shí)，不知道大家有沒發(fā)現(xiàn)輸出的不是函數(shù)本身的名字，如下代碼會(huì)輸出‘wrap’而不是‘sum’：
有時(shí)這種表現(xiàn)并不是我們想要的，我們希望被裝飾后的函數(shù)名字還是函數(shù)本身，那要怎么實(shí)現(xiàn)呢？很簡(jiǎn)單，只需要引入functools.wraps即可，如下代碼就會(huì)輸出‘sum’了：
看完后是不是覺得python裝飾器很簡(jiǎn)單，只要了解它的本質(zhì)，怎么寫都行，有好多種玩法呢。
重慶分公司
重慶分公司
