Python無參裝飾器的實現方案及優化

一、什麼是裝飾器

定義一個函數,該函數可為其他函數添加額外的功能。

二、何時用裝飾器

需要在不修改被裝飾對象源代碼及其調用方式時,為被裝飾對象添加額外的功能。

三、如何寫一個裝飾器

現在我們有如下一個函數help(),time.sleep()來模擬函數執行時間,print打印傳入參數值,方便我們來進行分析。如果現在我們需要為help函數添加一個統計其運行時間的功能,我們可以怎麼做?

import time
 
def help(x, y):
    time.sleep(1)
    print(f'x={x} y={y}')
 
help(1, 2)

方案一:

在help函數開頭結束分別調用time.time(),兩者相減得運行時間。

import time
 
def help(x, y):
    start = time.time()
    time.sleep(1)
    print(f'x={x} y={y}')
    stop = time.time()
    print(stop - start)
 
help(1, 2)

運行結果:

方案一中我們在help中加瞭相關代碼,雖然沒有改變它的調用方式,但改變瞭它的源代碼。我們繼續想想如何兩者都不改變的情況下,完成我們的目標。

對,函數內不能動,我們可以動函數外呀,在help前後加上相關代碼,似乎就可以達到我們的目標瞭,這就是方案二,我們來試試。

方案二:

import time
 
def help(x, y):
    time.sleep(1)
    print(f'x={x} y={y}')
 
start = time.time()
help(1, 2)
stop = time.time()
print(stop - start)

運行結果:

顯而易見,似乎沒有問題,但是如果我們需要多次調用help函數的話,在它前後都得加上相同的代碼,這樣代碼就會顯得十分冗餘瞭。既然help函數前後代碼不會變的話,我們可以將它們封裝成另一個函數呀,說幹就幹。

方案三:

import time
 
def help(x, y):
    time.sleep(1)
    print(f'x={x} y={y}')
 
def wrapper():
    start = time.time()
    help(1, 2)
    stop = time.time()
    print(stop - start)
 
wrapper()

運行一下:

 

這樣我們就解決瞭多次調用的問題,但美中不足的是,help函數的調用方式改變瞭,而且help的參數固定,也隻能修飾help函數,我們來一步步試著優化。

優化一(參數優化,實現任意參數): 

對參數優化,我們可以將help的實參通過wrapper的傳入,而為瞭實現任意參數,我們首先想的便是*args,**kwargs來作為函數的參數,於是將方案三進行改進如下(為方便分析,為help多增加瞭一個參數):

import time
 
 
def help(x, y, z):
    time.sleep(1)
    print(f'x={x} y={y} z={z}')
 
 
def wrapper(*args, **kwargs):
    start = time.time()
    help(*args, **kwargs)
    stop = time.time()
    print(stop - start)
 
 
wrapper(1, 2, 3)

運行一下:

這樣我們便將help的參數變得更加靈活瞭,接著我們來優化。

優化二(實現裝飾其他對象):

需要裝飾其他對象,意味著我們在help位置的應該是一個可變參數,也就是用戶輸入的參數,即wapper函數內應變為:

def wrapper(*args, **kwargs):
    start = time.time()
    func(*args, **kwargs)
    stop = time.time()
    print(stop - start)

但是我們期望wrapper能和內部調用的func函數的參數一致,即wrapper的參數我們應該不去改變,那我們func的值從何處傳來呢?

沒錯,我們可以運用閉包函數來傳參,修改一下下:

def outter(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        func(*args, **kwargs)
        stop = time.time()
        print(stop - start)
 
    return wrapper

這樣我們為其他函數修飾時,隻需要將其函數名作為outter函數的參數傳入即可:

import time
 
def help(x, y, z):
    time.sleep(1)
    print(f'這是help的{x}{y}{z}')
 
def others(x, y, z):
    time.sleep(1)
    print(f'這是others的{x}{y}{z}')
 
def outter(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        func(*args, **kwargs)
        stop = time.time()
        print(stop - start)
 
    return wrapper
 
help = outter(help)
others = outter(others)
 
help(1, 2, 3)
others(4, 5, 6)

運行一下:

結果符合預期,而且在使用時由於outter內的func是在局部名稱空間,outter外的func是在全局名稱空間,調用時二者並不沖突,並且使用時可讀性較高,我們好像達成開始的目標,似乎能以假亂真瞭。但我們繼續思考一下,我們演示用到的函數十分簡單,甚至沒有返回值,如果加上返回值後,我們再對其修飾後,能得到原函數的返回值嗎?

優化三(得到相同返回值):

回到我們的wrapper中去,既然需要我們func函數的返回值,我們直接將其賦值給res,再return出res的值:

import time
 
def help(x, y, z):
    time.sleep(1)
    print(f'這是help的{x}{y}{z}')
    return 'help'
 
def others(x, y, z):
    time.sleep(1)
    print(f'這是others的{x}{y}{z}')
    return 'others'
 
def outter(func):
    def wrapper(*args, **kwargs):
        start = time.time()
        res=func(*args, **kwargs)
        stop = time.time()
        print(stop - start)
        return res
    return wrapper
 
help = outter(help)
others = outter(others)
 
res1=help(1, 2, 3)
res2=others(4, 5, 6)
print(res1,res2)

沒毛病,跑一下:

 總結: 

到這我們完成瞭一個簡單的無參裝飾器,裝飾後的func既沒有改變源代碼,也沒有改變調用方式。

但是代碼稍顯冗餘,python語法便規定:在被裝飾對象正上方單獨一行寫@裝飾器名字,等價於func=outter(func),簡化代碼。從中我們總結出無參裝飾器的一個模板:

def outter(func):
     def wrapper(*args,**kwargs):
         # 1、調用原函數
         # 2、增加的新功能
         res=func(*args,**kwargs)
         return res
     return wrapper
 
#使用時
@outter
def func:
    pass

到此這篇關於Python無參裝飾器的文章就介紹到這瞭,更多相關Python無參裝飾器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: