Python如何創(chuàng)建裝飾器時(shí)保留函數(shù)元信息
問題
你寫了一個(gè)裝飾器作用在某個(gè)函數(shù)上,但是這個(gè)函數(shù)的重要的元信息比如名字、文檔字符串、注解和參數(shù)簽名都丟失了。
解決方案
任何時(shí)候你定義裝飾器的時(shí)候,都應(yīng)該使用 functools 庫中的 @wraps 裝飾器來注解底層包裝函數(shù)。例如:
import time
from functools import wraps
def timethis(func):
'''
Decorator that reports the execution time.
'''
@wraps(func)
def wrapper(*args, **kwargs):
start = time.time()
result = func(*args, **kwargs)
end = time.time()
print(func.__name__, end-start)
return result
return wrapper
下面我們使用這個(gè)被包裝后的函數(shù)并檢查它的元信息:
>>> @timethis
... def countdown(n):
... '''
... Counts down
... '''
... while n > 0:
... n -= 1
...
>>> countdown(100000)
countdown 0.008917808532714844
>>> countdown.__name__
'countdown'
>>> countdown.__doc__
'\n\tCounts down\n\t'
>>> countdown.__annotations__
{'n': <class 'int'>}
>>>
討論
在編寫裝飾器的時(shí)候復(fù)制元信息是一個(gè)非常重要的部分。如果你忘記了使用 @wraps , 那么你會(huì)發(fā)現(xiàn)被裝飾函數(shù)丟失了所有有用的信息。比如如果忽略 @wraps 后的效果是下面這樣的:
>>> countdown.__name__
'wrapper'
>>> countdown.__doc__
>>> countdown.__annotations__
{}
>>>
@wraps 有一個(gè)重要特征是它能讓你通過屬性 __wrapped__ 直接訪問被包裝函數(shù)。例如:
>>> countdown.__wrapped__(100000) >>>
__wrapped__ 屬性還能讓被裝飾函數(shù)正確暴露底層的參數(shù)簽名信息。例如:
>>> from inspect import signature >>> print(signature(countdown)) (n:int) >>>
一個(gè)很普遍的問題是怎樣讓裝飾器去直接復(fù)制原始函數(shù)的參數(shù)簽名信息, 如果想自己手動(dòng)實(shí)現(xiàn)的話需要做大量的工作,最好就簡單的使用 @wraps 裝飾器。 通過底層的 __wrapped__ 屬性訪問到函數(shù)簽名信息。
以上就是Python如何創(chuàng)建裝飾器時(shí)保留函數(shù)元信息的詳細(xì)內(nèi)容,更多關(guān)于Python保留函數(shù)元信息的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Python腳本實(shí)現(xiàn)網(wǎng)卡流量監(jiān)控
這篇文章主要介紹了Python腳本實(shí)現(xiàn)網(wǎng)卡流量監(jiān)控,本文直接給出實(shí)現(xiàn)代碼,需要的朋友可以參考下2015-02-02
Python 實(shí)現(xiàn)一行輸入多個(gè)值的方法
下面小編就為大家分享一篇Python 實(shí)現(xiàn)一行輸入多個(gè)值的方法,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-04-04
python email smtplib模塊發(fā)送郵件代碼實(shí)例
本篇文章給大家分享了python email smtplib模塊發(fā)送郵件的相關(guān)代碼分享,有需要的朋友參考學(xué)習(xí)下。2018-04-04
Python實(shí)現(xiàn)按特定格式對文件進(jìn)行讀寫的方法示例
這篇文章主要介紹了Python實(shí)現(xiàn)按特定格式對文件進(jìn)行讀寫的方法,可實(shí)現(xiàn)文件按原有格式讀取與寫入的功能,涉及文件的讀取、遍歷、轉(zhuǎn)換、寫入等相關(guān)操作技巧,需要的朋友可以參考下2017-11-11
python實(shí)現(xiàn)隨機(jī)密碼字典生成器示例
這篇文章主要介紹了python實(shí)現(xiàn)隨機(jī)密碼字典生成器示例,需要的朋友可以參考下2014-04-04
封裝Detours用于Python中x64函數(shù)hook詳解
Detours是微軟發(fā)布的一個(gè)API hook框架,同時(shí)支持x86和x64,看文檔說也支持ARM和ARM64的Windows,這篇文章主要介紹了封裝Detours用于Python中x64函數(shù)hook,需要的朋友可以參考下2023-12-12

