python裝飾器的原理和實例分析

這篇文章主要講解了“python裝飾器的原理和實例分析”，文中的講解內(nèi)容簡單清晰，易于學(xué)習(xí)與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學(xué)習(xí)“python裝飾器的原理和實例分析”吧！

目錄

• 前言

• 一、什么是裝飾器

• 二、為什么要用裝飾器

• 三、簡單的裝飾器

• 四、裝飾器的語法糖

• 五、裝飾器傳參

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

• 七、類裝飾器

• 八、帶參數(shù)的類裝飾器

• 九、裝飾器的順序

前言

最近有人問我裝飾器是什么，我就跟他說，其實就是裝飾器就是類似于女孩子的發(fā)卡。你喜歡的一個女孩子，她可以有很多個發(fā)卡，而當(dāng)她戴上不同的發(fā)卡，她的頭頂上就是裝飾了不同的發(fā)卡。但是你喜歡的女孩子還是你喜歡的女孩子。如果還覺得不理解的話，裝飾器就是咱們的手機(jī)殼，你盡管套上了手機(jī)殼，但并不影響你的手機(jī)功能，可你的手機(jī)還是該可以給你玩，該打電話打電話，該玩游戲玩游戲，該收藏攻城獅白玉的博客就收藏攻城獅白玉的博客。而你的手機(jī)就變成了帶手機(jī)殼的手機(jī)。

裝飾器就是python的一個攔路虎，你干或者不干它，它都在那里。如果你想學(xué)會高級的python用法，裝飾器就是你這個武松必須打倒的一只虎

本文的環(huán)境如下：

win10

python3.7

一、什么是裝飾器

裝飾器是給現(xiàn)有的模塊增添新的小功能，可以對原函數(shù)進(jìn)行功能擴(kuò)展，而且還不需要修改原函數(shù)的內(nèi)容，也不需要修改原函數(shù)的調(diào)用。

裝飾器的使用符合了面向?qū)ο缶幊痰拈_放封閉原則。

開放封閉原則主要體現(xiàn)在兩個方面：

對擴(kuò)展開放，意味著有新的需求或變化時，可以對現(xiàn)有代碼進(jìn)行擴(kuò)展，以適應(yīng)新的情況。

對修改封閉，意味著類一旦設(shè)計完成，就可以獨(dú)立其工作，而不要對類盡任何修改。

二、為什么要用裝飾器

使用裝飾器之前，我們要知道，其實python里是萬物皆對象，也就是萬物都可傳參。

函數(shù)也可以作為函數(shù)的參數(shù)進(jìn)行傳遞的。

通過下面這個簡單的例子可以更直觀知道函數(shù)名是如何直接作為參數(shù)進(jìn)行傳遞

def baiyu():
    print("我是攻城獅白玉") 
def blog(name):
    print('進(jìn)入blog函數(shù)')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017') 
if __name__ == '__main__':
    func = baiyu  # 這里是把baiyu這個函數(shù)名賦值給變量func
    func()  # 執(zhí)行func函數(shù)
    print('------------')
    blog(baiyu)  # 把baiyu這個函數(shù)作為參數(shù)傳遞給blog函數(shù)

執(zhí)行結(jié)果如下所示：

 接下來，我想知道這baiyu和blog兩個函數(shù)分別的執(zhí)行時間是多少，我就把代碼修改如下：

import time 
def baiyu():
    t1 = time.time()
    print("我是攻城獅白玉")
    time.sleep(2)
    print("執(zhí)行時間為：", time.time() - t1) 
def blog(name):
    t1 = time.time()
    print('進(jìn)入blog函數(shù)')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')
    print("執(zhí)行時間為：", time.time() - t1) 
if __name__ == '__main__':
    func = baiyu  # 這里是把baiyu這個函數(shù)名賦值給變量func
    func()  # 執(zhí)行func函數(shù)
    print('------------')
    blog(baiyu)  # 把baiyu這個函數(shù)作為參數(shù)傳遞給blog函數(shù)

 上述的改寫已經(jīng)實現(xiàn)了我需要的功能，但是，當(dāng)我有另外一個新的函數(shù)【python_blog_list】，具體如下：

def python_blog_list():
    print('''【Python】爬蟲實戰(zhàn)，零基礎(chǔ)初試爬蟲下載圖片（附源碼和分析過程）
    https://blog.csdn.net/zhh763984017/article/details/119063252 ''')
    print('''【Python】除了多線程和多進(jìn)程，你還要會協(xié)程
    https://blog.csdn.net/zhh763984017/article/details/118958668 ''')
    print('''【Python】爬蟲提速小技巧，多線程與多進(jìn)程（附源碼示例）
    https://blog.csdn.net/zhh763984017/article/details/118773313 ''')
    print('''【Python】爬蟲解析利器Xpath，由淺入深快速掌握（附源碼例子）
    https://blog.csdn.net/zhh763984017/article/details/118634945 ''')

也需要計算函數(shù)執(zhí)行時間的，那按之前的邏輯，就是改寫如下：

def python_blog_list():
    t1 = time.time()
    print('''【Python】爬蟲實戰(zhàn)，零基礎(chǔ)初試爬蟲下載圖片（附源碼和分析過程）
    https://blog.csdn.net/zhh763984017/article/details/119063252 ''')
    print('''【Python】除了多線程和多進(jìn)程，你還要會協(xié)程
    https://blog.csdn.net/zhh763984017/article/details/118958668 ''')
    print('''【Python】爬蟲提速小技巧，多線程與多進(jìn)程（附源碼示例）
    https://blog.csdn.net/zhh763984017/article/details/118773313 ''')
    print('''【Python】爬蟲解析利器Xpath，由淺入深快速掌握（附源碼例子）
    https://blog.csdn.net/zhh763984017/article/details/118634945 ''')
    print("執(zhí)行時間為：", time.time() - t1)

如果也要這樣子寫的話，不就重復(fù)造輪子了嗎？雖說人類的本質(zhì)是鴿王和復(fù)讀機(jī)，但作為一個優(yōu)秀的cv攻城獅（ctrl+c和ctrl+v）肯定是要想辦法偷懶的呀

裝飾器，就是可以讓我們拓展一些原有函數(shù)沒有的功能。

三、簡單的裝飾器

基于上面的函數(shù)執(zhí)行時間的需求，我們就手寫一個簡單的裝飾器進(jìn)行實現(xiàn)。

import time 
def baiyu():
    print("我是攻城獅白玉")
    time.sleep(2) 
def count_time(func):
    def wrapper():
        t1 = time.time()
        func()
        print("執(zhí)行時間為：", time.time() - t1) 
    return wrapper 
if __name__ == '__main__':
    baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 返回的時函數(shù)對象 wrapper，這條語句相當(dāng)于  baiyu = wrapper
    baiyu()  # 執(zhí)行baiyu()就相當(dāng)于執(zhí)行wrapper()

這里的count_time是一個裝飾器，裝飾器函數(shù)里面定義一個wrapper函數(shù)，把func這個函數(shù)當(dāng)作參數(shù)傳入，函數(shù)實現(xiàn)的功能是把func包裹起來，并且返回wrapper函數(shù)。wrapper函數(shù)體就是要實現(xiàn)裝飾器的內(nèi)容。

當(dāng)然，這里的wrapper函數(shù)名是可以自定義的，只要你定義的函數(shù)名，跟你return的函數(shù)名是相同的就好了

四、裝飾器的語法糖

你如果看過其他python項目里面的代碼里，難免會看到@符號，這個@符號就是裝飾器的語法糖。因此上面簡單的裝飾器還是可以通過語法糖來實現(xiàn)的，這樣就可以省去

baiyu = count_time(baiyu)

這一句代碼，而直接調(diào)用baiyu()這個函數(shù)

換句話說，其實使用裝飾器的是，默認(rèn)傳入的參數(shù)就是被裝飾的函數(shù)。

import time
def count_time(func):
    def wrapper():
        t1 = time.time()
        func()
        print("執(zhí)行時間為：", time.time() - t1) 
    return wrapper  
@count_time
def baiyu():
    print("我是攻城獅白玉")
    time.sleep(2) 
if __name__ == '__main__':
    # baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 返回的時函數(shù)對象 wrapper，這條語句相當(dāng)于  baiyu = wrapper
    # baiyu()  # 執(zhí)行baiyu()就相當(dāng)于執(zhí)行wrapper()
     baiyu()  # 用語法糖之后，就可以直接調(diào)用該函數(shù)了

五、裝飾器傳參

當(dāng)我們的被裝飾的函數(shù)是帶參數(shù)的，此時要怎么寫裝飾器呢？

上面我們有定義了一個blog函數(shù)是帶參數(shù)的

def blog(name):
    print('進(jìn)入blog函數(shù)')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')

此時我們的裝飾器函數(shù)要優(yōu)化一下下，修改成為可以接受任意參數(shù)的裝飾器

def count_time(func):
    def wrapper(*args,**kwargs):
        t1 = time.time()
        func(*args,**kwargs)
        print("執(zhí)行時間為：", time.time() - t1) 
    return wrapper

此處，我們的wrapper函數(shù)的參數(shù)為*args和**kwargs，表示可以接受任意參數(shù)

這時我們就可以調(diào)用我們的裝飾器了。

import time
def count_time(func):
    def wrapper(*args, **kwargs):
        t1 = time.time()
        func(*args, **kwargs)
        print("執(zhí)行時間為：", time.time() - t1)
     return wrapper
@count_time
def blog(name):
    print('進(jìn)入blog函數(shù)')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')
  if __name__ == '__main__':
    # baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 返回的時函數(shù)對象 wrapper，這條語句相當(dāng)于  baiyu = wrapper
    # baiyu()  # 執(zhí)行baiyu()就相當(dāng)于執(zhí)行wrapper()
 
    # baiyu()  # 用語法糖之后，就可以直接調(diào)用該函數(shù)了
    blog(baiyu)

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

前面咱們知道，裝飾器函數(shù)也是函數(shù)，既然是函數(shù)，那么就可以進(jìn)行參數(shù)傳遞，咱們怎么寫一個帶參數(shù)的裝飾器呢？

前面咱們的裝飾器只是實現(xiàn)了一個計數(shù)，那么我想在使用該裝飾器的時候，傳入一些備注的msg信息，怎么辦呢？咱們一起看一下下面的代碼

import time
def count_time_args(msg=None):
    def count_time(func):
        def wrapper(*args, **kwargs):
            t1 = time.time()
            func(*args, **kwargs)
            print(f"[{msg}]執(zhí)行時間為：", time.time() - t1)
         return wrapper 
    return count_time
@count_time_args(msg="baiyu")
def fun_one():
    time.sleep(1) 
@count_time_args(msg="zhh")
def fun_two():
    time.sleep(1)  
@count_time_args(msg="mylove")
def fun_three():
    time.sleep(1)  
if __name__ == '__main__':
    fun_one()
    fun_two()
    fun_three()

咱們基于原來的count_time函數(shù)外部再包一層用于接收參數(shù)的count_time_args，接收回來的參數(shù)就可以直接在內(nèi)部的函數(shù)里面調(diào)用了。上述代碼執(zhí)行效果如下：

七、類裝飾器

上面咱們一起學(xué)習(xí)了怎么寫裝飾器函數(shù)，在python中，其實也可以同類來實現(xiàn)裝飾器的功能，稱之為類裝飾器。類裝飾器的實現(xiàn)是調(diào)用了類里面的__call__函數(shù)。類裝飾器的寫法比我們裝飾器函數(shù)的寫法更加簡單。

當(dāng)我們將類作為一個裝飾器，工作流程：

• 通過__init__（）方法初始化類

• 通過__call__（）方法調(diào)用真正的裝飾方法

import time
class BaiyuDecorator:
    def __init__(self, func):
        self.func = func
        print("執(zhí)行類的__init__方法") 
    def __call__(self, *args, **kwargs):
        print('進(jìn)入__call__函數(shù)')
        t1 = time.time()
        self.func(*args, **kwargs)
        print("執(zhí)行時間為：", time.time() - t1)
@BaiyuDecorator
def baiyu():
    print("我是攻城獅白玉")
    time.sleep(2)  
def python_blog_list():
    time.sleep(5)
    print('''【Python】爬蟲實戰(zhàn)，零基礎(chǔ)初試爬蟲下載圖片（附源碼和分析過程）
    https://blog.csdn.net/zhh763984017/article/details/119063252 ''')
    print('''【Python】除了多線程和多進(jìn)程，你還要會協(xié)程
    https://blog.csdn.net/zhh763984017/article/details/118958668 ''')
    print('''【Python】爬蟲提速小技巧，多線程與多進(jìn)程（附源碼示例）
    https://blog.csdn.net/zhh763984017/article/details/118773313 ''')
    print('''【Python】爬蟲解析利器Xpath，由淺入深快速掌握（附源碼例子）
    https://blog.csdn.net/zhh763984017/article/details/118634945 ''') 
@BaiyuDecorator
def blog(name):
    print('進(jìn)入blog函數(shù)')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017') 
if __name__ == '__main__':
    baiyu()
    print('--------------')
    blog(python_blog_list)

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

當(dāng)裝飾器有參數(shù)的時候，__init__() 函數(shù)就不能傳入func（func代表要裝飾的函數(shù)）了，而func是在__call__函數(shù)調(diào)用的時候傳入的。

class BaiyuDecorator:
    def __init__(self, arg1, arg2):  # init()方法里面的參數(shù)都是裝飾器的參數(shù)
        print('執(zhí)行類Decorator的__init__()方法')
        self.arg1 = arg1
        self.arg2 = arg2
     def __call__(self, func):  # 因為裝飾器帶了參數(shù)，所以接收傳入函數(shù)變量的位置是這里
        print('執(zhí)行類Decorator的__call__()方法') 
        def baiyu_warp(*args):  # 這里裝飾器的函數(shù)名字可以隨便命名，只要跟return的函數(shù)名相同即可
            print('執(zhí)行wrap()')
            print('裝飾器參數(shù)：', self.arg1, self.arg2)
            print('執(zhí)行' + func.__name__ + '()')
            func(*args)
            print(func.__name__ + '()執(zhí)行完畢') 
        return baiyu_warp 
@BaiyuDecorator('Hello', 'Baiyu')
def example(a1, a2, a3):
    print('傳入example()的參數(shù)：', a1, a2, a3) 
if __name__ == '__main__':
    print('準(zhǔn)備調(diào)用example()')
    example('Baiyu', 'Happy', 'Coder')
    print('測試代碼執(zhí)行完畢')

建議各位同學(xué)好好比對一下這里的代碼和不帶參數(shù)的裝飾器代碼的區(qū)別，加深理解。

九、裝飾器的順序

一個函數(shù)可以被多個裝飾器進(jìn)行裝飾，那么裝飾器的執(zhí)行順序是怎么樣的呢？咱們執(zhí)行一下下面的代碼就清楚了

def BaiyuDecorator_1(func):
    def wrapper(*args, **kwargs):
        func(*args, **kwargs)
        print('我是裝飾器1') 
    return wrapper 
def BaiyuDecorator_2(func):
    def wrapper(*args, **kwargs):
        func(*args, **kwargs)
        print('我是裝飾器2')
     return wrapper 
def BaiyuDecorator_3(func):
    def wrapper(*args, **kwargs):
        func(*args, **kwargs)
        print('我是裝飾器3') 
    return wrapper 
@BaiyuDecorator_1
@BaiyuDecorator_2
@BaiyuDecorator_3
def baiyu():
    print("我是攻城獅白玉") 
if __name__ == '__main__':
    baiyu()

由輸出結(jié)果可知，在裝飾器修飾完的函數(shù)，在執(zhí)行的時候先執(zhí)行原函數(shù)的功能，然后再由里到外依次執(zhí)行裝飾器的內(nèi)容。

我們帶三個裝飾器的函數(shù)的代碼如下：

@BaiyuDecorator_1
@BaiyuDecorator_2
@BaiyuDecorator_3
def baiyu():
    print("我是攻城獅白玉")

上述的代碼可以看作如下代碼，就能理解為何是由里到外執(zhí)行了

baiyu = BaiyuDecorator_1 (BaiyuDecorator_2 (BaiyuDecorator_3(baiyu)))

感謝各位的閱讀，以上就是“python裝飾器的原理和實例分析”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對python裝飾器的原理和實例分析這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關(guān)知識點(diǎn)的文章，歡迎關(guān)注！