Python如何將裝飾器定義為類

問題

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

解決方案

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

import typesfrom functools import wrapsclass 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)

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

@Profileddef add(x, y): return x + yclass Spam: @Profiled def bar(self, x): print(self, x)

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

>>> add(2, 3)5>>> add(4, 5)9>>> add.ncalls2>>> 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.ncalls3

討論

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

首先，使用 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 typesfrom functools import wrapsdef 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@profileddef add(x, y): return x + y

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

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

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