裝飾器是通過裝飾器函數(shù)修改原函數(shù)的一些功能而不需要修改原函數(shù),在很多場景可以用到它,比如① 執(zhí)行某個測試用例之前,判斷是否需要登錄或者執(zhí)行某些特定操作;② 統(tǒng)計某個函數(shù)的執(zhí)行時間;③ 判斷輸入合法性等。合理使用裝飾器可以極大地提高程序的可讀性以及運行效率。本文將介紹Python裝飾器的使用方法。
專業(yè)從事網(wǎng)站設(shè)計制作、成都網(wǎng)站建設(shè),高端網(wǎng)站制作設(shè)計,重慶小程序開發(fā),網(wǎng)站推廣的成都做網(wǎng)站的公司。優(yōu)秀技術(shù)團隊竭力真誠服務(wù),采用HTML5+CSS3前端渲染技術(shù),成都響應(yīng)式網(wǎng)站建設(shè)公司,讓網(wǎng)站在手機、平板、PC、微信下都能呈現(xià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--
裝飾器是從英文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 的一個重要部分
其功能是, 在不修改原函數(shù)(類)定義代碼的情況下,增加新的功能
為了理解和實現(xiàn)裝飾器,我們先引入2個核心操作:
在這個例子中,函數(shù)hi的形參name,默認為'world'
在函數(shù)內(nèi)部,又定義了另一個函數(shù) howdoyoudo,定義這個函數(shù)時,將形參name作為新函數(shù)的形參name2的默認值。
因此,在函數(shù)內(nèi)部調(diào)用howdoyoudo()時,將以調(diào)用hi時的實參為默認值,但也可以給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),為什么不用簡寫版的方法了
因為以上代碼會報錯?。?/p>
究其原因,雖然
等價于
但是,
并不等價于
這本身和@語法有關(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ù),來修改原函數(shù)的一些功能,使得原函數(shù)不需要修改。
這一句話理解起來可能沒那么輕松,那先來看一個"傻瓜"函數(shù)。
放心,絕對不是"Hello World"!
怎么樣,沒騙你吧? 哈哈,這個函數(shù)不用運行相信大家都知道輸出結(jié)果: "你好,裝飾器" 。
那如果我想讓 hello() 函數(shù)再實現(xiàn)個其他功能,比如多打印一句話。
那么,可以這樣"增強"一下:
運行結(jié)果:
很顯然,這個"增強"沒啥作用,但是可以幫助理解裝飾器。
當(dāng)運行最后的 hello() 函數(shù)時,調(diào)用過程是這樣的:
那上述代碼里的 my_decorator() 就是一個裝飾器。
它改變了 hello() 的行為,但是并沒有去真正的改變 hello()函數(shù) 的內(nèi)部實現(xiàn)。
但是,python一直以"優(yōu)雅"被人追捧,而上述的代碼顯然不夠優(yōu)雅。
所以,想讓上述裝飾器變得優(yōu)雅,可以這樣寫:
這里的 @my_decorator 就相當(dāng)于舊代碼的 hello = my_decorator(hello) , @ 符號稱為語法糖。
那如果還有其他函數(shù)也需要加上類似的裝飾,直接在函數(shù)的上方加上 @my_decorator 就可以,大大提高函數(shù)
的重復(fù)利用與可讀性。
輸出:
上面的只是一個非常簡單的裝飾器,但是實際場景中,很多函數(shù)都是要帶有參數(shù)的,比如hello(people_name)。
其實也很簡單,要什么我們就給什么唄,直接在對應(yīng)裝飾器的 wrapper() 上,加上對應(yīng)的參數(shù):
輸出:
但是還沒完,這樣雖然簡單,但是隨之而來另一個問題:因為并不是所有函數(shù)參數(shù)都是一樣的,
當(dāng)其他要使用裝飾器的函數(shù)參數(shù)不止這個一個腫么辦?比如:
沒關(guān)系,在python里, *args 和 **kwargs 表示接受任意數(shù)量和類型的參數(shù),所以我們可以這樣
寫裝飾器里的 wrapper() 函數(shù):
同時運行下 hello("老王") ,和 hello3("張三", "李四") ,看結(jié)果:
上面2種,裝飾器都是接收外來的參數(shù),其實裝飾器還可以接收自己的參數(shù)。
比如,我加個參數(shù)來控制下裝飾器中打印信息的次數(shù):
注意,這里 count 裝飾函數(shù)中的2個 return .
運行下,應(yīng)該會出現(xiàn)3次:
現(xiàn)在多做一步 探索 ,我們來打印下下面例子中的hello()函數(shù)的元信息:
輸出:
這說明了,它不再是以前的那個 hello() 函數(shù),而是被 wrapper() 函數(shù)取代了。
如果我們需要用到元函數(shù)信息,那怎么保留它呢?這時候可以用內(nèi)置裝飾器 @functools.wrap 。
運行下:
好記性不如爛筆頭,寫一下理解一下會好很多。
下面還分享類的裝飾器,以及裝飾器所用場景。
裝飾器(decorator)是Python中的高級語法。裝飾的意思就是動態(tài)擴展被裝飾對象的功能。裝飾器可以用于裝飾函數(shù)、方法和類。
一 嵌套函數(shù)
# 定義一個外層函數(shù)def foo(): # 定義了一個內(nèi)部函數(shù) def bar(): print("hello world")
函數(shù)bar是一個定義在foo函數(shù)內(nèi)部的函數(shù)。
Python中的函數(shù)是支持嵌套的,也就是可以在一個函數(shù)內(nèi)部再定義一個函數(shù)。
然后,我們還知道函數(shù)是可以當(dāng)作變量的,于是我們就可以在foo函數(shù)中把定義的這個bar函數(shù)返回。就像下面這樣:
# 定義一個外層函數(shù)def foo(): # 定義了一個內(nèi)層函數(shù) def bar(): print("hello world") return
barfunc = foo()func() # func -- bar,這里執(zhí)行func其實就相當(dāng)于執(zhí)行了在foo函數(shù)內(nèi)部定義的bar函數(shù)
二 閉包形態(tài)1
# 閉包形態(tài)1def foo(): name = "Andy" # 外部函數(shù)的局部變量 # 定義了一個內(nèi)部函數(shù) def bar():
print(name) # 雖然bar函數(shù)中沒有定義name變量,但是它可以訪問外部函數(shù)的局部變量name return barfunc =
foo()func() # func -- bar -- 除了是一個函數(shù),還包含一個值(它外層函數(shù)的局部變量)的引用
三 閉包形態(tài)2
# 閉包形態(tài)2def foo(name): # 給一個函數(shù)傳參也相當(dāng)于給函數(shù)定義了一個局部變量 # 定義了一個內(nèi)部函數(shù) def bar():
print(name) # 內(nèi)部函數(shù)同樣可以獲取到傳到外部函數(shù)的變量(參數(shù)) return barfunc = foo("Andy") #
把“Andy”當(dāng)成參數(shù)傳入foo函數(shù) -- 其內(nèi)部定義的bar函數(shù)也能拿到這個“Andy”func() # func -- bar --
除了是一個函數(shù),還包含一個值(它外層函數(shù)的參數(shù))的引用
四 裝飾器形態(tài)1
# 還是定義一個外層函數(shù)def foo(name): # 我接收的參數(shù)是一個函數(shù)名 # 定義了一個內(nèi)部函數(shù) def bar():
print("這是新功能。。。") # 新功能 name() # 函數(shù)名加()就相當(dāng)于執(zhí)行-- 我傳進來原函數(shù)的函數(shù)名,這里就相當(dāng)于執(zhí)行了原函數(shù)
return bar# 定義一個被裝飾的函數(shù)def f1(): print("hello world.") # 用foo函數(shù)裝飾f1函數(shù)f1 =
foo(f1)# 不改變f1的調(diào)用方式f1() # -- 此時函數(shù)已經(jīng)擴展了新功能
五 裝飾器形態(tài)2
# 還是定義一個外層函數(shù)def foo(name): # 接收的參數(shù)是一個函數(shù)名 # 定義了一個內(nèi)部函數(shù) def bar():
print("這是新功能。。。") # 新功能 name() # 函數(shù)名加()就相當(dāng)于執(zhí)行-- 傳進來原函數(shù)的函數(shù)名,這里就相當(dāng)于執(zhí)行了原函數(shù)
return bar# 定義一個被裝飾的函數(shù)# 用foo函數(shù)裝飾f1函數(shù)@foo # 使用f1 =
foo(f1)語法裝飾的話稍顯啰嗦,Python就提供了@語法,讓裝飾過程更簡便def f1(): print("hello world.") #
不改變f1的調(diào)用方式f1() # -- 此時函數(shù)已經(jīng)擴展了新功能。
1、 lru_cache
這個裝飾器來自functools模塊。該模塊包含在標(biāo)準(zhǔn)庫中,非常易于使用。它還包含比這個裝飾器更酷的功能,但這個裝飾器是非常受人喜歡的。此裝飾器可用于使用緩存加速函數(shù)的連續(xù)運行。當(dāng)然,這應(yīng)該在使用時記住一些關(guān)于緩存的注意事項,但在通用使用情況下,大多數(shù)時候這個裝飾器都是值得使用的。
2、JIT
JIT是即時編譯的縮寫。通常每當(dāng)我們在Python中運行一些代碼時,發(fā)生的第一件事就是編譯。這種編譯會產(chǎn)生一些開銷,因為類型被分配了內(nèi)存,并存儲為未分配但已命名的別名,使用即時編譯,我們在執(zhí)行時才進行編譯。
在很多方面,我們可以將其視為類似于并行計算的東西,其中Python解釋器同時處理兩件事以節(jié)省時間。Numba JTI編譯器因?qū)⑦@一概念提到Python中而聞名,可以非常輕松地調(diào)用此裝飾器,并立即提高代碼的性能。Numba包提供了JIT裝飾器,它使運行更密集的軟件變得更加容易,而不必進入C。
3、do_twice
do_twice裝飾器的功能與它的名字差不多。此裝飾器可用于通過一次調(diào)用運行兩次函數(shù),對調(diào)試特別有用。它可以用于測量兩個不同迭代的功能。
4、count_calls
count_calls裝飾器可用于提供有關(guān)函數(shù)在軟件中使用多少次的信息。與do_twice一樣,對調(diào)試也特別有用。
5、dataclass
為了節(jié)省編寫類的時間,推薦使用dataclass裝飾器。這個裝飾器可用于快速編寫類中常見的標(biāo)準(zhǔn)方法,這些方法通常會在我們編寫的類中找到。
6、singleton
singleton是一個單例裝飾器。通常,單例裝飾器是由用戶自己編寫的,實際上并不是導(dǎo)入的。
7、use_unit
在科學(xué)計算中經(jīng)常派上用場的一種裝飾器是use_unit裝飾器。此裝飾器可用于更改返回結(jié)果的表示單位。這對于那些不想在數(shù)據(jù)中添加度量單位但仍希望人們知道這些單位是什么的人很有用。這個裝飾器可不是在任何模塊中真正有用,但它是非常常見的,對科學(xué)應(yīng)用程序非常有用。