Python - 裝飾器使用過程當中的誤區

時間 2019-11-17

原文原文鏈接

曾靈敏 — APRIL 27, 2015html

裝飾器基本概念

你們都知道裝飾器是一個很著名的設計模式，常常被用於AOP(面向切面編程)的場景，較爲經典的有插入日誌，性能測試，事務處理，Web權限校驗， Cache等。python

Python語言自己提供了裝飾器語法（@），典型的裝飾器實現以下：git

@function_wrapper
    def function():
       pass

@其實是python2.4才提出的語法糖，針對python2.4之前的版本有另外一種等價的實現：github

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__ 。app

針對某個函數應用裝飾器時，這個函數的屬性就會發生變化，但這並非咱們所指望的。函數

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__'

由於@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, in <module>
        Class.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。