深入理解 Python 中的裝飾器
裝飾器本質上也是函數,接收函數對象來作為參數,並在裝飾器的內部來調用接受的函數對象完成相關的函數調用,也可以這樣理解 ,為了方便在幾個不同函數調用之前或者完成相關的統一操作,註意是完成統一的操作,可以傳參數使得裝飾器不完全一樣,後面會講到,最重要的應用如工程應用上記錄相關的內部接口的流水日誌,不同的接口需要統一的樣式,所以可以用裝飾器來實現,先簡單看一下實例:
from time import ctime def deco(func): def decorator(*args, **kwargs): print(‘[%s] %s() is called‘% (ctime(), func.__name__)) return func(*arg, **kwargs) return decorator @deco def foo(): print(‘Holle Python‘) foo()
在如上實例中,定義了一個裝飾器,其中參數func 需要函數的對象,返回值是decorator函數,其中decorator函數的返回值正是func 的返回值,該裝飾器的功能就是在函數調用之前,打印了函數調用的時間和函數名。
裝飾器的使用過程很簡單,通過註解@符號標註一下即可,這本質上相當於 foo = deco(foo)的嵌套調用。
這裏面,你有遇到了 *args 和 **argkwargs,他們可以組合接收任意函數參數。
裝飾器也可以堆疊起來,即對某個函數使用多個裝飾器,比如:
from time import ctime def deco(func): def decorator1(*args, **kwargs); print(‘[%s] %s() is called:‘%(ctime(), func.__name__)) return func(*args, **kwargs) return decorator1 def deco2(func): def decorator2(*args, **kwargs): print("[%s] %s() is called" % (ctime(), func.__name__)) return func(*args, **kwargs) return decorator2 @deco2 @deco1 def foo(): print(‘Hello Python‘) foo()
運行一下,輸出如下:
[Fri Jul 21 15:15:53 2017] decorator1() is called
[Fri Jul 21 15:15:53 2017] foo() is called
Hello, Python
是否跟你想的一樣?在嵌套調用的過程中。foo = deco2(deco1(foo)),所以先返回deco1(foo)的函數名字即為 的從rator1, 後返回 foo 函數名。
裝飾器本身也可以傳入參數,使得在統一的過程中帶點奇特的色彩,如:
from time import ctime def deco(tag): def decorator(func); def wrapper(*args, **kwargs): print(‘[%s] %s() is called, Tag is %s‘ % (ctime(), func.__name__, tag)) return func(*args, **kw) return warpper return decorator @deco(‘Python‘) def foo(): print(‘Hello Python‘) @deco(‘java‘) def bar(): print(‘Hello Python‘) foo() bar()
讓我們簡單的分析一下這個裝飾器,deco函數接受的是一個str對象tag,當執行deco(‘Python’)後返回的是decotator函數,此函數需要接受一個函數對象,同時返回wrapper函數,而 wrapper 函數的結果就是func 函數返回的值,說的可能有點繞,但理一下會覺得非常簡單。
最後說一下的是,由於加入了裝飾器,函數的__name__ 和 __doc__ 等信息都發生了變化:
from time import ctime def deco(dunc): def decoraor(*args, **kwargs): print(‘[%s] %s() is called‘% (ctime(), func.__name__)) return func(*args, **kwargs) return decotator @deco def foo(): print(‘Hello Python‘) foo.__name__ foo.__doc__
from time import ctime
def deco(func):
def decorator(*args, **kwargs):
‘‘‘decorator for func‘‘‘
print(‘[%s] %s() is called‘ % (ctime(), func.__name__))
return func(*args, **kwargs)
return decorator
@deco
def foo():
‘‘‘function: foo‘‘‘
print(‘Hello, Python‘)
foo.__name__
foo.__doc__
由此可見,加入裝飾器改變了函數內部的相關屬性,如何避免此問題呢?Python中有專門的包來避免這種轉換:functools.wraps,實例如下:
from time imort ctime import functools def deco(func): @functools.wraps(func) def decorator(*args, **kwargs): print(‘[%s] %s() is called‘% (ctime(), func.__name__)) return func(*args, **kwargs) return decorator @deco def foo(): print(‘Hello Python‘) foo.__name__ foo.__doc__
運行結果如下:
foo
function: foo
這樣就保留了原先函數的屬性,小編在工作中一般也是加入此功能的。
深入理解 Python 中的裝飾器