什么是Python裝飾器,有什么作用?
今天小編和大家分享一下,什么是Python裝飾器,有什么作用!由于函數也是一個對象,而且函數對象可以被賦值給變量,所以,通過變量也能調用該函數。
def now():
print("2018年1月18日17:38:59")
f = now
f()
函數對象有一個__name__屬性,可以拿到函數的名字:
>>>now.__name__
'now'
>>>f.__name__
'now'
現在,假設我們要增強now()函數的功能,比如,在函數調用前后自動打印日志,但又不希望修改now()函數的定義,這種在代碼運行期間動態增加功能的方式,稱之為"裝飾器"(Decorator)。本質上,decorator就是一個返回函數的高階函數,所以,我們要定義一個能打印日志的decorator,可以定義如下:
def log(func):
def wrapper(*args, **kw):
print("call %s():"%func.__name__)
return func(*args, **kw)
return wrapper
觀察上面的log,因為它是一個decorator,所以接收一個函數作為函數,并返回一個函數。我們要借助Python的@語法,把decorator置于函數的定義處:
@log
def now():
print("2018年1月18日18:04:34")
調用now()函數,不僅會運行now()函數本身,還會在運行now()函數前打印一行日志:
>>>now()
call now():
2018年1月18日18:04:34
把@log放到now()函數的定義處,相當于執行了語句:
now = log(now)
由于log()是一個decorator,返回一個函數,所以,原來的now()函數仍然存在,只是現在同名的now變量指向了新的函數,于是調用了now()將執行新函數,即在log()函數中返回的wrapper()函數。
wrapper()函數的參數定義是(*args, **kw),因此,wrapper()函數可以接受任意參數的調用。在wrapper()函數內,首先打印日志,再緊接著調用原始函數。
如果decorator本身需要傳入參數,那就需要編寫一個返回decorator的高階函數,寫出來會更復雜。比如,要自定義log的文本:
def log(text):
def wrapper(func):
def decorator(*agrs, **kw):
print("%s %s():"%(text, func.__name__))
return func(*args, **kw)
return wrapper
return wrapp
這個3層嵌套的decorator用法如下:
@log('exceture')
def now():
print('2018年1月19日14:43:13')
執行結果如下:
>>>now()
executure now():
2018年1月19日14:43:13
和兩層嵌套的decorator相比,3層嵌套的效果是真有的:
>>>now = log('executre')(now)
我們來剖析上面的語句,首先執行log('execute'),返回的是decorator函數,再調用返回的函數,參數是now函數,返回值最終是wrapper函數。
以上兩種decorator的定義都沒有問題,但還差最后一步,因為我們講了函數也是對象,它有__name__等屬性,但你去看經過decorator裝飾之后的函數,它們的__name__已經從原來的now變成了wrapper:
>>>now.__name__
'wrapper'
因為返回的那個wrapper()函數的名字就是wrapper,所以,需要把原始函數的__name__等屬性復制到wrapper()函數中,否則,有些依賴函數簽名的代碼執行就會出錯。
不需要編寫wrapper.__name__ = func.__name__這樣的代碼,Python內置的functools.wraps就是干這個事的,一個完整的decorator的寫法如下:
import functools
def log(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('call %s():'%func.__name__)
return func(*args, **kw)
return wrapper
或者針對帶參數的decorator:
import functools
def log(text):
def decorator(func):
@functools.wraps(func):
def wrapper(*args, **kw):
print('%s %s():'%(text, func.__name__))
return func(*args, **kw)
return wrapper
return decorator
只需記住在定義wrapper()的前面加上@functools.wraps(func)即可。
好啦!今天的分享到這里就結束了,希望大家持續關注馬哥教育官網!每天都會有大量優質內容與大家分享。聲明:文章轉載于網絡,版權歸原作者所有!