Py西游攻關之裝飾器


     

 

閉包:

     攻克裝飾器之前,我們需要找到一些武器來幫助我們。

     

裝飾器:

 

概念

      裝飾器本質上是一個函數,該函數用來處理其他函數,它可以讓其他函數在不需要修改代碼的前提下增加額外的功能,裝飾器的返回值也是一個函數對象。它經常用於有切面需求的場景,比如:插入日志、性能測試、事務處理、緩存、權限校驗等應用場景。裝飾器是解決這類問題的絕佳設計,有了裝飾器,我們就可以抽離出大量與函數功能本身無關的雷同代碼並繼續重用。概括的講,裝飾器的作用就是為已經存在的對象添加額外的功能。

 

先來看一個簡單例子:

 

現在有一個新的需求,希望可以記錄下函數的執行前后的時間,於是在代碼中添加日志代碼:

 

bar()、bar2()也有類似的需求,怎么做?再在bar函數里調用時間函數?這樣就造成大量雷同的代碼,為了減少重復寫代碼,我們可以這樣做,重新定義一個函數:專門設定時間 

 

邏輯上不難理解,而且運行正常。 但是這樣的話,我們每次都要將一個函數作為參數傳遞給show_time函數。而且這種方式已經破壞了原有的代碼邏輯結構,之前執行業務邏輯時,執行運行bar(),但是現在不得不改成show_time(bar)。那么有沒有更好的方式的呢?當然有,答案就是裝飾器。

簡單裝飾器

   if  bar()==show_time(bar) :問題解決!  

   所以,我們需要show_time(bar)返回一個函數對象,而這個函數對象內則是核心業務函數:func()與裝飾函數:兩個時間函數,修改如下:


函數show_time就是裝飾器,它把真正的業務方法func包裹在函數里面,看起來像bar被上下時間函數裝飾了。在這個例子中,函數進入和退出時 ,被稱為一個橫切面(Aspect),這種編程方式被稱為面向切面的編程(Aspect-Oriented Programming)。

@符號是裝飾器的語法糖,在定義函數的時候使用,避免再一次賦值操作

 

如上所示,這樣我們就可以省去bar = show_time(bar)這一句了,直接調用bar()即可得到想要的結果。如果我們有其他的類似函數,我們可以繼續調用裝飾器來修飾函數,而不用重復修改函數或者增加新的封裝。這樣,我們就提高了程序的可重復利用性,並增加了程序的可讀性。

conclusion:

                   

 

@show_time幫我們做的事情就是當我們執行業務邏輯bar()時,執行的代碼由紅框部分轉到綠框部分

 

裝飾器在Python使用如此方便都要歸因於Python的函數能像普通的對象一樣能作為參數傳遞給其他函數,可以被賦值給其他變量,可以作為返回值,可以被定義在另外一個函數內。

帶參數的被裝飾函數

帶參數的裝飾器

裝飾器還有更大的靈活性,例如帶參數的裝飾器:在上面的裝飾器調用中,比如@show_time,該裝飾器唯一的參數就是執行業務的函數。裝飾器的語法允許我們在調用時,提供其它參數,比如@decorator(a)。這樣,就為裝飾器的編寫和使用提供了更大的靈活性。

def cal_time(flag):

    def show_time(func):

            def wrapper(*args,**kwargs):
                before_time=time.ctime()
                print("Begin:",before_time)
                func(*args,**kwargs)
                time.sleep(2)
                after_time=time.ctime()
                print("End:",after_time)
                if flag=="true":
                    print("expend_time:",time.mktime(time.strptime(after_time))-time.mktime(time.strptime(before_time)))
            return wrapper

    return show_time


@cal_time("true") #add = show_time(add)
def add(*args,**kwargs):
    sum=0
    for i in args:
        sum+=i
    print(sum)

add(2,7,9)

 

  上面的cal_time是允許帶參數的裝飾器。它實際上是對原有裝飾器的一個函數封裝,並返回一個裝飾器。我們可以將它理解為一個含有參數的閉包。當我 們使用@cal_time("true")調用的時候,Python能夠發現這一層的封裝,並把參數傳遞到裝飾器的環境中。

類裝飾器

再來看看類裝飾器,相比函數裝飾器,類裝飾器具有靈活度大、高內聚、封裝性等優點。使用類裝飾器還可以依靠類內部的__call__方法,當使用 @ 形式將裝飾器附加到函數上時,就會調用此方法。

class Foo(object):
def __init__(self, func):
self._func = func

def __call__(self):
print ('class decorator runing')
self._func()
print ('class decorator ending')

@Foo
def bar():
print ('bar')

bar() #bar=Foo(bar)()>>>>>>>active __call__方法


# class decorator runing
# bar
# class decorator ending

functools.wraps

使用裝飾器極大地復用了代碼,但是他有一個缺點就是原函數的元信息不見了,比如函數的docstring、__name__、參數列表,先看例子:

裝飾器

def sb():
    print("alex")

print(sb.__name__)


def logged(func):
    def with_logging(*args, **kwargs):
        print (func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging


@logged
def ft(x):
   return x + x * x


print(ft.__name__)
########
# sb
# with_logging

函數

@logged
def f(x):
   return x + x * x

該函數完成等價於:

def f(x):
    return x + x * x
f = logged(f)

不難發現,函數f被with_logging取代了,當然它的docstring,__name__就是變成了with_logging函數的信息了。

print f.__name__    # prints 'with_logging'
print f.__doc__     # prints None

這個問題就比較嚴重的,好在我們有functools.wraps,wraps本身也是一個裝飾器,它能把原函數的元信息拷貝到裝飾器函數中,這使得裝飾器函數也有和原函數一樣的元信息了。

from functools import wraps
def sb():
    print("alex")

print(sb.__name__)


def logged(func):

    @wraps(func)
    
    def with_logging(*args, **kwargs):
        print (func.__name__ + " was called")
        return func(*args, **kwargs)
    return with_logging

@logged
def ft(x):
   return x + x * x

print(ft.__name__)
########
# sb
# ft

 

內置裝飾器

@staticmathod、@classmethod、@property

裝飾器的順序

@a @b @c def f (): 

等效於

f = a(b(c(f)))


http://stackoverflow.com/questions/739654/how-can-i-make-a-chain-of-function-decorators-in-python/1594484#1594484









免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM