裝飾器基本概念
大家都知道裝飾器是一個很著名的設計模式,經常被用于 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 "<stdin>", line 1, in <module> File "<stdin>", line 3, in Class File "<stdin>", 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__'
新聞熱點
疑難解答