裝飾器基本概念
大家都知道裝飾器是一個很著名的設計模式,經常被用于 AOP (面向切面編程)的場景,較為經典的有插入日志,性能測試,事務處理,Web權限校驗, Cache等。
Python 語言本身提供了裝飾器語法(@),典型的裝飾器實現如下:
@function_wrapper def function(): pass
@實際上是 python2.4 才提出的語法糖,針對 python2.4 以前的版本有另一種等價的實現:
def function(): pass function = function_wrapper(function)
裝飾器的兩種實現
函數包裝器 - 經典實現
def function_wrapper(wrapped): def _wrapper(*args, **kwargs): return wrapped(*args, **kwargs) return _wrapper @function_wrapper def function(): pass
類包裝器 - 易于理解
class function_wrapper(object): def __init__(self, wrapped): self.wrapped = wrapped def __call__(self, *args, **kwargs): return self.wrapped(*args, **kwargs) @function_wrapper def function(): pass
函數(function)自省
當我們談到一個函數時,通常希望這個函數的屬性像其文檔上描述的那樣,是被明確定義的,例如__name__ 和__doc__ 。
針對某個函數應用裝飾器時,這個函數的屬性就會發生變化,但這并不是我們所期望的。
def function_wrapper(wrapped): def _wrapper(*args, **kwargs): return wrapped(*args, **kwargs) return _wrapper @function_wrapper def function(): pass >>> print(function.__name__) _wrapper
python 標準庫提供了functools.wraps(),來解決這個問題。
import functools def function_wrapper(wrapped): @functools.wraps(wrapped) def _wrapper(*args, **kwargs): return wrapped(*args, **kwargs) return _wrapper @function_wrapper def function(): pass >>> print(function.__name__) function
然而,當我們想要獲取被包裝函數的參數(argument)或源代碼(source code)時,同樣不能得到我們想要的結果。
import inspect def function_wrapper(wrapped): ... @function_wrapper def function(arg1, arg2): pass >>> print(inspect.getargspec(function)) ArgSpec(args=[], varargs='args', keywords='kwargs', defaults=None) >>> print(inspect.getsource(function)) @functools.wraps(wrapped) def _wrapper(*args, **kwargs): return wrapped(*args, **kwargs)
包裝類方法(@classmethod)
當包裝器(@function_wrapper)被應用于@classmethod時,將會拋出如下異常:
class Class(object): @function_wrapper @classmethod def cmethod(cls): pass Traceback (most recent call last): File "", line 1, in File " ", line 3, in Class File " ", line 2, in wrapper File ".../functools.py", line 33, in update_wrapper setattr(wrapper, attr, getattr(wrapped, attr)) AttributeError: 'classmethod' object has no attribute '__module__'
因為@classmethod在實現時,缺少functools.update_wrapper需要的某些屬性。這是functools.update_wrapper在 python2 中的 bug,3.2版本已被修復,參考 http://bugs.python.org/issue3445。
然而,在 python3 下執行,另一個問題出現了:
class Class(object): @function_wrapper @classmethod def cmethod(cls): pass >>> Class.cmethod() Traceback (most recent call last): File "classmethod.py", line 15, inClass.cmethod() File "classmethod.py", line 6, in _wrapper return wrapped(*args, **kwargs) TypeError: 'classmethod' object is not callable
這是因為包裝器認定被包裝的函數(@classmethod )是可以直接被調用的,但事實并不一定是這樣的。被包裝的函數實際上可能是描述符(descriptor ),意味著為了使其可調用,該函數(描述符)必須被正確地綁定到某個實例上。關于描述符的定義,可以參考 https://docs.python.org/2/howto/descriptor.html。
總結 - 簡單并不意味著正確
盡管大家實現裝飾器所用的方法通常都很簡單,但這并不意味著它們一定是正確的并且始終能正常工作。
如同上面我們所看到的,functools.wraps() 可以幫我們解決__name__ 和__doc__ 的問題,但對于獲取函數的參數(argument)或源代碼( source code )則束手無策。
更多文章、技術交流、商務合作、聯系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號聯系: 360901061
您的支持是博主寫作最大的動力,如果您喜歡我的文章,感覺我的文章對您有幫助,請用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點擊下面給點支持吧,站長非常感激您!手機微信長按不能支付解決辦法:請將微信支付二維碼保存到相冊,切換到微信,然后點擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對您有幫助就好】元
