問題

你想使用一個裝飾器去包裝函式，但是希望返回一個可呼叫的例項。 你需要讓你的裝飾器可以同時工作在類定義的內部和外部。

解決方案

為了將裝飾器定義成一個例項，你需要確保它實現了 __call__() 和 __get__() 方法。 例如，下面的程式碼定義了一個類，它在其他函式上放置一個簡單的記錄層：

import types
from functools import wraps

class Profiled:
  def __init__(self,func):
    wraps(func)(self)
    self.ncalls = 0

  def __call__(self,*args,**kwargs):
    self.ncalls += 1
    return self.__wrapped__(*args,**kwargs)

  def __get__(self,instance,cls):
    if instance is None:
      return self
    else:
      return types.MethodType(self,instance)

你可以將它當做一個普通的裝飾器來使用，在類裡面或外面都可以：

@Profiled
def add(x,y):
  return x + y

class Spam:
  @Profiled
  def bar(self,x):
    print(self,x)

在互動環境中的使用示例：

>>> add(2,3)
5
>>> add(4,5)
9
>>> add.ncalls
2
>>> s = Spam()
>>> s.bar(1)
<__main__.Spam object at 0x10069e9d0> 1
>>> s.bar(2)
<__main__.Spam object at 0x10069e9d0> 2
>>> s.bar(3)
<__main__.Spam object at 0x10069e9d0> 3
>>> Spam.bar.ncalls
3

討論

將裝飾器定義成類通常是很簡單的。但是這裡還是有一些細節需要解釋下，特別是當你想將它作用在例項方法上的時候。

首先，使用 functools.wraps() 函式的作用跟之前還是一樣，將被包裝函式的元資訊複製到可呼叫例項中去。

其次，通常很容易會忽視上面的 __get__() 方法。如果你忽略它，保持其他程式碼不變再次執行， 你會發現當你去呼叫被裝飾例項方法時出現很奇怪的問題。例如：

>>> s = Spam()
>>> s.bar(3)
Traceback (most recent call last):
...
TypeError: bar() missing 1 required positional argument: 'x'

出錯原因是當方法函式在一個類中被查詢時，它們的 __get__() 方法依據描述器協議被呼叫， 在8.9小節已經講述過描述器協議了。在這裡，__get__() 的目的是建立一個繫結方法物件 (最終會給這個方法傳遞self引數)。下面是一個例子來演示底層原理：

>>> s = Spam()
>>> def grok(self,x):
...   pass
...
>>> grok.__get__(s,Spam)
<bound method Spam.grok of <__main__.Spam object at 0x100671e90>>
>>>

__get__() 方法是為了確保繫結方法物件能被正確的建立。 type.MethodType() 手動建立一個繫結方法來使用。只有當例項被使用的時候繫結方法才會被建立。 如果這個方法是在類上面來訪問， 那麼 __get__() 中的instance引數會被設定成None並直接返回 Profiled 例項本身。 這樣的話我們就可以提取它的 ncalls 屬性了。

如果你想避免一些混亂，也可以考慮另外一個使用閉包和 nonlocal 變數實現的裝飾器，這個在9.5小節有講到。例如：

import types
from functools import wraps

def profiled(func):
  ncalls = 0
  @wraps(func)
  def wrapper(*args,**kwargs):
    nonlocal ncalls
    ncalls += 1
    return func(*args,**kwargs)
  wrapper.ncalls = lambda: ncalls
  return wrapper

# Example
@profiled
def add(x,y):
  return x + y

這個方式跟之前的效果幾乎一樣，除了對於 ncalls 的訪問現在是通過一個被繫結為屬性的函式來實現，例如：

>>> add(2,5)
9
>>> add.ncalls()
2
>>>

以上就是Python如何將裝飾器定義為類的詳細內容，更多關於Python將裝飾器定義為類的資料請關注我們其它相關文章！