python裝飾器原理源碼示例分析

Posted on by

前言

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

裝飾器就是python的一個攔路虎，你幹或者不幹它，它都在那裡。如果你想學會高級的python用法，裝飾器就是你這個武松必須打倒的一隻虎

本文的環境如下：

win10

python3.7

一、什麼是裝飾器

裝飾器是給現有的模塊增添新的小功能，可以對原函數進行功能擴展，而且還不需要修改原函數的內容，也不需要修改原函數的調用。

裝飾器的使用符合瞭面向對象編程的開放封閉原則。

開放封閉原則主要體現在兩個方面：

對擴展開放，意味著有新的需求或變化時，可以對現有代碼進行擴展，以適應新的情況。

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

二、為什麼要用裝飾器

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

函數也可以作為函數的參數進行傳遞的。

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

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

執行結果如下所示：

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

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

 

 上述的改寫已經實現瞭我需要的功能，但是，當我有另外一個新的函數【python_blog_list】，具體如下：

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

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

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

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

 

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

三、簡單的裝飾器

基於上面的函數執行時間的需求，我們就手寫一個簡單的裝飾器進行實現。

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

這裡的count_time是一個裝飾器，裝飾器函數裡面定義一個wrapper函數，把func這個函數當作參數傳入，函數實現的功能是把func包裹起來，並且返回wrapper函數。wrapper函數體就是要實現裝飾器的內容。

當然，這裡的wrapper函數名是可以自定義的，隻要你定義的函數名，跟你return的函數名是相同的就好瞭

四、裝飾器的語法糖

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

baiyu = count_time(baiyu)

這一句代碼，而直接調用baiyu()這個函數

換句話說，其實使用裝飾器的是，默認傳入的參數就是被裝飾的函數。

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

五、裝飾器傳參

當我們的被裝飾的函數是帶參數的，此時要怎麼寫裝飾器呢？

上面我們有定義瞭一個blog函數是帶參數的

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

此時我們的裝飾器函數要優化一下下，修改成為可以接受任意參數的裝飾器

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

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

這時我們就可以調用我們的裝飾器瞭。

import time
def count_time(func):
    def wrapper(*args, **kwargs):
        t1 = time.time()
        func(*args, **kwargs)
        print("執行時間為：", time.time() - t1)
     return wrapper
@count_time
def blog(name):
    print('進入blog函數')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')
  if __name__ == '__main__':
    # baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 返回的時函數對象 wrapper，這條語句相當於  baiyu = wrapper
    # baiyu()  # 執行baiyu()就相當於執行wrapper()
 
    # baiyu()  # 用語法糖之後，就可以直接調用該函數瞭
    blog(baiyu)

六、帶參數的裝飾器

前面咱們知道，裝飾器函數也是函數，既然是函數，那麼就可以進行參數傳遞，咱們怎麼寫一個帶參數的裝飾器呢？

前面咱們的裝飾器隻是實現瞭一個計數，那麼我想在使用該裝飾器的時候，傳入一些備註的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}]執行時間為：", 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函數外部再包一層用於接收參數的count_time_args，接收回來的參數就可以直接在內部的函數裡面調用瞭。上述代碼執行效果如下：

七、類裝飾器

上面咱們一起學習瞭怎麼寫裝飾器函數，在python中，其實也可以同類來實現裝飾器的功能，稱之為類裝飾器。類裝飾器的實現是調用瞭類裡面的__call__函數。類裝飾器的寫法比我們裝飾器函數的寫法更加簡單。

當我們將類作為一個裝飾器，工作流程：

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

八、帶參數的類裝飾器

當裝飾器有參數的時候，__init__() 函數就不能傳入func（func代表要裝飾的函數）瞭，而func是在__call__函數調用的時候傳入的。

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

建議各位同學好好比對一下這裡的代碼和不帶參數的裝飾器代碼的區別，加深理解。

九、裝飾器的順序

一個函數可以被多個裝飾器進行裝飾，那麼裝飾器的執行順序是怎麼樣的呢？咱們執行一下下面的代碼就清楚瞭

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()

由輸出結果可知，在裝飾器修飾完的函數，在執行的時候先執行原函數的功能，然後再由裡到外依次執行裝飾器的內容。

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

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

上述的代碼可以看作如下代碼，就能理解為何是由裡到外執行瞭

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

以上就是python裝飾器原理源碼示例分析的詳細內容，更多關於python裝飾器原理的資料請關註WalkonNet其它相關文章！

推薦閱讀：