python之裝飾器

1. 什么是裝飾器

知乎大佬如是說(shuō)：
內(nèi)褲可以用來(lái)遮羞，但是到了冬天它沒(méi)法為我們防風(fēng)御寒，聰明的人們發(fā)明了長(zhǎng)褲堤瘤，有了長(zhǎng)褲后寶寶再也不冷了，裝飾器就像我們這里說(shuō)的長(zhǎng)褲浆熔，在不影響內(nèi)褲作用的前提下本辐，給我們的身子提供了保暖的功效。
裝飾器本質(zhì)上是Python函數(shù)医增，可以為已存在的對(duì)象添加額外的功能慎皱，同時(shí)裝飾器還可以抽離出與函數(shù)無(wú)關(guān)的重用代碼。具體應(yīng)用場(chǎng)景如：插入日志叶骨、性能測(cè)試茫多、事務(wù)處理、緩存忽刽、權(quán)限校驗(yàn)等天揖。

換言之

裝飾器不能影響原函數(shù)的功能，裝飾器是獨(dú)立出來(lái)的函數(shù)跪帝。誰(shuí)調(diào)用它今膊，誰(shuí)就可以使用它的功能。

2.舉個(gè)栗子

add的功能是計(jì)算x和y的值伞剑，我們稱(chēng)作功能函數(shù)斑唬。
logger的作業(yè)是在執(zhí)行add函數(shù)的同時(shí)再打印了其他的信息，這部分的作為add的功能增強(qiáng)，我們稱(chēng)為裝飾恕刘。
在logger里我們可以加入其他類(lèi)似的功能函數(shù)缤谎，也能包裝它，可以進(jìn)行復(fù)用雪营。

1.引子

#功能函數(shù)
def add(x,y):
    return x+y

#裝飾函數(shù)
def logger(fn):
    print('frist')
    x = fn(4,5)
    print('second')
    return x 

print(logger(add))

#把函數(shù)add傳給logger  弓千，return x+y
#print('frist')
#print('secend')
#  x = fn(4,5)  ==> x = 4 y= 5  x= 4+5 = 9 
#return 9 


frist
second
9

2.提取參數(shù)

x,y的參數(shù)都放在logger函數(shù)內(nèi)部了，影響函數(shù)的靈活性献起，此處我們可以提取出來(lái)。

def add(x,y):
    return x + y
 
def logger(fn,*args,**kwargs):
    print('frist')
    x = fn(*args,**kwargs)
    print('second')
    return x

print(logger(add,1,y=11))

frist
second
12

3.柯里化

def add(x,y):
    return x + y
def logger(fn):
    def wrapper(*args,**kwargs):
        print('begin')
        x = fn(*args,**kwargs)
        print('end')
        return x
    return wrapper


print(logger(add)(5,y=11))

begin
end
16

懵逼ing

以下為個(gè)人理解镣陕，左邊為非柯里化函數(shù)谴餐，右邊是柯里化函數(shù)。

<img src="http://qiniu.mykernel.cn/klh.png" alt="柯里化函數(shù)"/>

前面說(shuō)過(guò)柯里化的定義呆抑，本來(lái)可以一次傳入兩個(gè)參數(shù)岂嗓，柯里化之后。只需要傳入一個(gè)函數(shù)了鹊碍。厌殉。
左邊傳入add 和 兩個(gè)參數(shù)。
右邊的logger(add)是一個(gè)函數(shù)侈咕，只需要傳入兩個(gè)參數(shù)公罕。logger(add)是個(gè)整體，結(jié)合成一個(gè)函數(shù)耀销。當(dāng)然這樣寫(xiě)楼眷，我們看函數(shù)主題的部分也是不一樣的。
函數(shù)的基礎(chǔ)中說(shuō)過(guò)熊尉，函數(shù)的傳參必須和函數(shù)參數(shù)的定義一致罐柳。重點(diǎn)分析右邊函數(shù)（柯里化）。
參數(shù)部分：參數(shù)傳入的方式狰住，logger函數(shù)需要傳入個(gè)fn张吉，fu的返回值是wrapper函數(shù)，wrapper函數(shù)的參數(shù)是(*args,**kwargs)所以此次就需要分兩次傳入?yún)?shù)催植。
第一次傳入fn肮蛹，再次傳入wrapper函數(shù)需要的參數(shù)。所以就出現(xiàn)了最下邊的調(diào)用方式查邢。
print(logger(add)(5,y=50))蔗崎。

返回值部分：右側(cè)的logger函數(shù)是個(gè)嵌套函數(shù)，logger的返回值是wrapper扰藕，內(nèi)層的wrapper函數(shù)返回值是x缓苛，x = fn(*args,**kwargs)。fn函數(shù)是最后調(diào)用時(shí)候傳入的add函數(shù)。

懵逼 X 2未桥。笔刹。。冬耿。

def add(x,y):
    return x + y
  
def logger(fn,*args,**kwargs):        def logger(fn):  #參數(shù)剝離
                                           def newfunction(*args,**kwargs):  #新定義一個(gè)函數(shù)舌菜，logger函數(shù)返回也是這個(gè)函數(shù)名字
    print('frist')                           print('frist')
    x = fn(*args,**kwargs)  == >             x = fn(*args,**kwargs)
    print('second')                          print('second')
    return x                               return x
                                        return newfunction
                                                              
print(logger(add,1,y=11))           print(logger(add)(5,y=11)) #兩次傳入?yún)?shù)

效果如下：

def add(x,y):
    return x + y
  
def logger(fn):  #參數(shù)剝離
    def newfunction(*args,**kwargs):  #新定義一個(gè)函數(shù)，logger函數(shù)返回也是這個(gè)函數(shù)名字
   
        print('frist')
        x = fn(*args,**kwargs)
        print('second')
        return x
    
    return newfunction
                                                              
print(logger(add)(5,y=11)) #兩次傳入?yún)?shù)

frist
second
16

繼續(xù)懵逼的話就這樣用吧亦镶。日月。。用多了就悟道了缤骨。爱咬。

4.裝飾器語(yǔ)法糖

#再次變形。绊起。精拟。
def add(x,y):
    return x + y

def logger(fn):
    def wrapper(*args,**kwargs):
        print('begin')
        x = fn(*args,**kwargs)
        print('end')
        return x
    return wrapper

##調(diào)用方法1：
print(logger(add)(x=1111,y=1))

##調(diào)用方法2：
add = logger(add)
print(add(x=11,y=3))

##調(diào)用方法3： python給我們的語(yǔ)法糖 

@logger # 說(shuō)明下邊的函數(shù)，add 其實(shí)是 add = logger(add)
def add(x,y):
    return x + y


print(add(45,40))

begin
end
1112
begin
end
14
begin
end
85

3.復(fù)雜的栗子

import datetime
import time 

def logger(fn):
    def warp(*arges,**kwarges):
        print("arges={},kwarges={}".format(arges,kwarges))  #打印函數(shù)的兩個(gè)參數(shù)
        start = datetime.datetime.now()  #獲取函數(shù)運(yùn)行的開(kāi)始時(shí)間
        ret = fn(*arges,**kwarges)  #傳入兩個(gè)參數(shù)虱歪，調(diào)用add函數(shù)  此處有個(gè)return的值蜂绎，需要一層一層的返回出去
        
        duratime = datetime.datetime.now() - start  #獲得函數(shù)的運(yùn)行時(shí)間
        print("function {} took {}s".format(fn.__name__,duratime.total_seconds()))  #打印函數(shù)的運(yùn)行時(shí)間

        return ret   #返回fn的結(jié)果 ，fn = x+y ==> 返回x+y的值笋鄙。  x = 4 y= 11 ==> return 11
    return warp  #返回warp的 return ==> ret 的return ==> return 11 函數(shù)的最終結(jié)果為11  

@logger
def add(x,y):
    print("oooooook")
    time.sleep(1.5)
    return x+y

print(add(4,y=11))
   
#如果充分理解了每個(gè)小部件师枣，這個(gè)簡(jiǎn)單的完整版本也是很好理解的了。
#1局装，logger是個(gè)裝飾器坛吁，而且使用了柯里化技術(shù)
#2，add 傳參給logger的fn 形參铐尚，add(4,y=5)的兩個(gè)參數(shù)傳入給warp函數(shù)的兩個(gè)形參
#
#

arges=(4,),kwarges={'y': 11}
oooooook
function add took 1.5017s
15

再次翻譯

import datetime
import time 

#####################################裝飾開(kāi)始############################################
def logger(fn):  #拿到函數(shù)名稱(chēng)
    def warp(*arges,**kwarges):  #拿到函數(shù)帶過(guò)來(lái)的參數(shù)開(kāi)始裝飾
        print("arges={},kwarges={}".format(arges,kwarges))   #來(lái)試試打印兩個(gè)參數(shù)
        start = datetime.datetime.now()  #
        ret = fn(*arges,**kwarges)   # 此處調(diào)用add函數(shù)拨脉。開(kāi)始執(zhí)行函數(shù)，發(fā)現(xiàn)return語(yǔ)句宣增。玫膀。ret的結(jié)果就是return。 
        
        duratime = datetime.datetime.now() - start  #
        print("function {} took {}s".format(fn.__name__,duratime.total_seconds()))

        return ret   #加工完成開(kāi)始返回爹脾。warp的返回值是ret 帖旨，ret的返回值是 add函數(shù)的執(zhí)行結(jié)果（原函數(shù)的功能完整的保留了） 
    return warp  # logger的返回結(jié)果是warp，warp的返回值是ret 灵妨，ret的返回值是 add函數(shù)的執(zhí)行結(jié)果（原函數(shù)的功能完整的保留了） 

#####################################裝飾完成############################################

@logger  #裝飾工廠
######add是需要被裝飾的函數(shù)解阅，當(dāng)你有這個(gè)想法的事情，其實(shí)事情已經(jīng)開(kāi)始發(fā)生了泌霍。
def add(x,y): # 此時(shí)add = logger(add)  此處前面的@logger標(biāo)記就是想要讓logger裝飾器像一個(gè)工廠一樣對(duì)add函數(shù)進(jìn)行加工货抄。
    print("oooooook")
    time.sleep(1.5)
    return x+y

print(add(4,y=11))


arges=(4,),kwarges={'y': 11}
oooooook
function add took 1.501604s
15

4.帶參裝飾器

1. 文檔字符串

我們約定，在python函數(shù)的第一行需要對(duì)函數(shù)進(jìn)行說(shuō)明，使用三引號(hào)表示蟹地。
如果是英文說(shuō)明积暖，慣例首字母大寫(xiě)，第一行寫(xiě)概述怪与，空一行夺刑，第三行寫(xiě)詳細(xì)描述。
如果函數(shù)中有文檔字符串分别，默認(rèn)會(huì)放在函數(shù)的doc屬性中遍愿，可以直接訪問(wèn)。

def add(x,y):
    """This is a function of addition"""
    a = x+y
    return x + y

print("function name is {}\nfunction doc = {}\n\n".format(add.__name__, add.__doc__))
print(help(add))

function name is add
function doc = This is a function of addition


Help on function add in module __main__:

add(x, y)
    This is a function of addition

None

2. 前面裝飾器的副作用

前面裝飾器基本上已經(jīng)可以完成對(duì)函數(shù)進(jìn)行加強(qiáng)的功能了茎杂，但是還有些瑕疵错览。比如原來(lái)函數(shù)的原屬性已經(jīng)被替換為裝飾器的屬性了。如下：

def add(x,y):
    return x + y

def logger(fn):
    "This is logger doc"
    def wrapper(*args,**kwargs):
        "This is wrapper doc"
        print('begin')
        x = fn(*args,**kwargs)
        print('end')
        return x
    return wrapper


@logger # add = logger(add)
def add(x,y):
    "This is add doc "
    print("name = {}\ndoc = {}".format(add.__name__,add.__doc__))
    return x + y


print(add(45,40))

#可以看出來(lái)add被裝飾出來(lái)的函數(shù)（新的add）的屬性已經(jīng)全部改變了煌往。

begin
name = wrapper
doc = This is wrapper doc
end
85

3. 解決方案一

三個(gè)函數(shù)：

  1. copy原函數(shù)的屬性 copy_properties
  2. 裝飾器 logger
  3. 功能函數(shù) add
def copy_properties(src, dst): # 把src的相關(guān)屬性賦值給dst  (fn,wrap)
    dst.__name__ = src.__name__
    dst.__doc__ = src.__doc__

    
def logger(fn):
    """'This is a function of logger'"""
    def wrap(*arges,**kwarges): # 
        """'This is a function of wrap'"""
        print('<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>')
        x = fn(*arges,**kwarges)
        #print("name={}\ndoc={}".format(add.__name__,add.__doc__))
        print('<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>')   
        return x  
    copy_properties(fn,wrap)    #思考1：為什么放在這個(gè)位置調(diào)用
    return wrap

@logger
def add(x,y):
        """'This is a function of add'"""
        print("name={}\ndoc={}".format(add.__name__,add.__doc__))
        return x+y


print(add(4,6))

<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>
name=add
doc='This is a function of add'
<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>-<>
10

4. 解決方案二

但凡使用裝飾器都會(huì)出現(xiàn)屬性的這個(gè)問(wèn)題，為什么不把copy_properties也做成裝飾器呢轧邪？

三個(gè)函數(shù)：

  1. copy原函數(shù)的裝飾器 copy_properties1
  2. 裝飾器 logger
  3. 功能函數(shù) add
def copy_properties(src, dst): # 把src的相關(guān)屬性賦值給dst  (fn,wrap)
    dst.__name__ = src.__name__
    dst.__doc__ = src.__doc__
    
#利用前面的知識(shí)我們可以對(duì)copy_properties輕松進(jìn)行變形
def copy_properties1(src): #  把src的相關(guān)屬性賦值給dst  (fn,wrap)  
    def _copy(dst):
        dst.__name__ = src.__name__
        dst.__doc__ = src.__doc__
        return dst 
    return _copy

帶參裝飾器：

def logger(fn): 
    """'This is a function of logger'"""
    @copy_properties1(fn) #wrap = copy_properties(fn)(wrap)  
    #== > 柯里化 兩次傳入?yún)?shù) src = fn 刽脖， dst = wrap 新的wrap函數(shù)的屬性已經(jīng)替換為原函數(shù)的。
    
    def wrap(*arges,**kwarges): #wrap = copy_properties(fn)(wrap)(*arges,**kwarges)     
        """'This is a function of wrap'"""
        print('>->->->->->->->->->->->->->->->->->->->->->->->->->')
        x = fn(*arges,**kwarges)
        print('<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<')
        return x 

    return wrap

@logger  #add =logger(add)
def add(x,y):
        """'This is a function of add'"""
        print("name={}\ndoc={}".format(add.__name__,add.__doc__))
        return x+y



print(add(4,11))

>->->->->->->->->->->->->->->->->->->->->->->->->->
name=add
doc='This is a function of add'
<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<
15

更多歡迎訪問(wèn)：http://www.mykernel.cn/

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 人面猴
    序言：七十年代末忌愚，一起剝皮案震驚了整個(gè)濱河市曲管，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌硕糊，老刑警劉巖院水，帶你破解...
    沈念sama閱讀 212,222評(píng)論 6贊 493
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場(chǎng)離奇詭異简十，居然都是意外死亡檬某，警方通過(guò)查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,455評(píng)論 3贊 385
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門(mén)螟蝙，熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)恢恼，“玉大人，你說(shuō)我怎么就攤上這事胰默〕“撸” “怎么了？”我有些...
    開(kāi)封第一講書(shū)人閱讀 157,720評(píng)論 0贊 348
  • 道士緝兇錄：失蹤的賣(mài)姜人
    文/不壞的土叔 我叫張陵牵署，是天一觀的道長(zhǎng)漏隐。 經(jīng)常有香客問(wèn)我，道長(zhǎng)奴迅，這世上最難降的妖魔是什么青责？ 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,568評(píng)論 1贊 284
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮，結(jié)果婚禮上爽柒，老公的妹妹穿的比我還像新娘吴菠。我一直安慰自己，他們只是感情好浩村，可當(dāng)我...
    茶點(diǎn)故事閱讀 65,696評(píng)論 6贊 386
  • 惡毒庶女頂嫁案：這布局不是一般人想出來(lái)的
    文/花漫 我一把揭開(kāi)白布做葵。 她就那樣靜靜地躺著，像睡著了一般心墅。 火紅的嫁衣襯著肌膚如雪酿矢。 梳的紋絲不亂的頭發(fā)上，一...
    開(kāi)封第一講書(shū)人閱讀 49,879評(píng)論 1贊 290
  • 城市分裂傳說(shuō)
    那天怎燥，我揣著相機(jī)與錄音瘫筐，去河邊找鬼。 笑死铐姚，一個(gè)胖子當(dāng)著我的面吹牛策肝，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播隐绵，決...
    沈念sama閱讀 39,028評(píng)論 3贊 409
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開(kāi)眼之众，長(zhǎng)吁一口氣：“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來(lái)了依许？” 一聲冷哼從身側(cè)響起棺禾，我...
    開(kāi)封第一講書(shū)人閱讀 37,773評(píng)論 0贊 268
  • 萬(wàn)榮殺人案實(shí)錄
    序言：老撾萬(wàn)榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎峭跳，沒(méi)想到半個(gè)月后膘婶，有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 44,220評(píng)論 1贊 303
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡蛀醉，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,550評(píng)論 2贊 327
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年悬襟，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片滞欠。...
    茶點(diǎn)故事閱讀 38,697評(píng)論 1贊 341
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡古胆，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出筛璧，到底是詐尸還是另有隱情逸绎，我是刑警寧澤，帶...
    沈念sama閱讀 34,360評(píng)論 4贊 332
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布夭谤，位于F島的核電站棺牧，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏朗儒。R本人自食惡果不足惜颊乘，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,002評(píng)論 3贊 315
  • 男人毒藥：我在死后第九天來(lái)索命
    文/蒙蒙 一参淹、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧乏悄，春花似錦浙值、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,782評(píng)論 0贊 21
  • 一樁弒父案开呐，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)钱床。三九已至熟掂，卻和暖如春继效，著一層夾襖步出監(jiān)牢的瞬間华望，已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,010評(píng)論 1贊 266
  • 情欲美人皮
    我被黑心中介騙來(lái)泰國(guó)打工玖像， 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留匪燕，地道東北人摸吠。 一個(gè)月前我還...
    沈念sama閱讀 46,433評(píng)論 2贊 360
  • 代替公主和親
    正文 我出身青樓丛塌，卻偏偏與公主長(zhǎng)得像较解，于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子赴邻，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,587評(píng)論 2贊 350

推薦閱讀更多精彩內(nèi)容

  • 1.認(rèn)識(shí)裝飾器 在python中哨坪，對(duì)于一個(gè)函數(shù)，若想在其運(yùn)行前后做點(diǎn)什么乍楚，那么裝飾器是再好不過(guò)的選擇，話不多說(shuō)届慈，上...
    howie6879閱讀 1,415評(píng)論 4贊 20
  • Python之裝飾器 裝飾器本質(zhì)上是一個(gè)Python函數(shù)徒溪，它可以讓其他函數(shù)在不需要做任何代碼變動(dòng)的前提下增加額外功...
    ikaroskun閱讀 356評(píng)論 0贊 0
  • 裝飾器的作用： 裝飾模式有很多經(jīng)典的使用場(chǎng)景，例如插入日志金顿、性能測(cè)試臊泌、事務(wù)處理等等，有了裝飾器揍拆，就可以提取大量函數(shù)...
    冰西瓜大郎閱讀 224評(píng)論 0贊 0
  • 我不是藝術(shù)家 我畫(huà)出的蒙娜麗莎的微笑不如你 奏出貝多芬的樂(lè)章沒(méi)有你絢麗 在這幕靜默的愛(ài)你的舞臺(tái)劇里 快要干涸的感性...
    芍藥煮魚(yú)閱讀 255評(píng)論 0贊 0
  • 還記得我第一次寫(xiě)讀后感的時(shí)候是在小學(xué)渠概，是老師布置的一次家庭作業(yè)，那時(shí)候我皮的很嫂拴，作業(yè)從來(lái)不想做播揪，偏偏又怕老師怕的跟...
    亂玉閱讀 169評(píng)論 0贊 0