来自其他类的方法的类装饰器

Question

注意：
我这里有一个相关的问题： How to access variables from a Class Decorator from within the method it's applied on?

---

我打算写一本相当复杂的装饰书。因此，decorator本身应该是它自己的一个类。我知道这在Python（Python 3.8）中是可能的：

import functools

class MyDecoratorClass:
    def __init__(self, func):
        functools.update_wrapper(self, func)
        self.func = func
    
    def __call__(self, *args, **kwargs):
        # do stuff before
        retval = self.func(*args, **kwargs)
        # do stuff after
        return retval

@MyDecoratorClass
def foo():
    print("foo")

现在，当我尝试将装饰器应用于方法而不仅仅是一个函数时，我的问题就开始了——特别是当它是另一个类的方法时。让我向您展示我的尝试：

一,。试验一：身份丧失

下面的装饰程序MyDecoratorClass没有（或不应该）做任何事情。这只是样板代码，可以稍后使用。类Foobar中的方法foo()打印调用它的对象：

import functools

class MyDecoratorClass:
    def __init__(self, method):
        functools.update_wrapper(self, method)
        self.method = method

    def __call__(self, *args, **kwargs):
        # do stuff before
        retval = self.method(self, *args, **kwargs)
        # do stuff after
        return retval

class Foobar:
    def __init__(self):
        # initialize stuff
        pass

    @MyDecoratorClass
    def foo(self):
        print(f"foo() called on object {self}")
        return

现在您在这里看到的是foo()方法中的self被交换。它不再是Foobar()实例，而是MyDecoratorClass()实例：

>>> foobar = Foobar()
>>> foobar.foo()
foo() called from object <__main__.MyDecoratorClass object at 0x000002DAE0B77A60>

换句话说，方法foo()失去了其原始身份。这就把我们带到了下一次审判

二,。试验二：保持身份，但崩溃

我试图保留foo()方法的原始标识：

import functools

class MyDecoratorClass:
    def __init__(self, method):
        functools.update_wrapper(self, method)
        self.method = method

    def __call__(self, *args, **kwargs):
        # do stuff before
        retval = self.method(self.method.__self__, *args, **kwargs)
        # do stuff after
        return retval

class Foobar:
    def __init__(self):
        # initialize stuff
        pass

    @MyDecoratorClass
    def foo(self):
        print(f"foo() called on object {self}")
        return

现在让我们测试一下：

>>> foobar = Foobar()
>>> foobar.foo()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 7, in __call__
AttributeError: 'function' object has no attribute '__self__'

哎呀

---

编辑
感谢@AlexHall和@juanpa.arrivillaga为您提供的解决方案。他们都工作。然而，它们之间有着微妙的区别

让我们先来看看这个：

def __get__(self, obj, objtype) -> object:
    temp = type(self)(self.method.__get__(obj, objtype))
    print(temp)
    return temp

我引入了一个临时变量，只是为了打印__get__()返回的内容。每次访问方法foo()，此__get__()函数都会返回一个新的MyDecoratorClass()实例：

>>> f = Foobar()
>>> func1 = f.foo
>>> func2 = f.foo
>>> print(func1 == func2)
>>> print(func1 is func2)
<__main__.MyDecoratorClass object at 0x000001B7E974D3A0>
<__main__.MyDecoratorClass object at 0x000001B7E96C5520>
False
False

第二种方法（来自@juanpa.arrivillaga）不同：

def __get__(self, obj, objtype) -> object:
    temp = types.MethodType(self, obj)
    print(temp)
    return temp

输出：

>>> f = Foobar()
>>> func1 = f.foo
>>> func2 = f.foo
>>> print(func1 == func2)
>>> print(func1 is func2)
<bound method Foobar.foo of <__main__.Foobar object at 0x000002824BBEF4C0>>
<bound method Foobar.foo of <__main__.Foobar object at 0x000002824BBEF4C0>>
True
False

有一个微妙的区别，但我不知道为什么

Answer 1

您可以实现描述符协议，在Descriptor HOWTO中提供了函数如何实现描述符协议的示例（但在纯python中），并将其转换为您的案例：

import functools
import types

class MyDecoratorClass:
    def __init__(self, func):
        functools.update_wrapper(self, func)
        self.func = func

    def __call__(self, *args, **kwargs):
        # do stuff before
        retval = self.func(*args, **kwargs)
        # do stuff after
        return retval

    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        return types.MethodType(self, obj)

注意，return types.MethodType(self, obj)本质上等同于

return lambda *args, **kwargs : self.func(obj, *args, **kwargs)

---

Note from Kristof
Could it be that you meant this:

return types.MethodType(self, obj) is essentially equivalent to

return lambda *args, **kwargs : self(obj, *args, **kwargs)

Note that I replaced self.func(..) with self(..). I tried, and only this way I can ensure that the statements at # do stuff before and # do stuff after actually run.

Answer 2

函数是描述符，这就是允许它们自动绑定自身的原因。处理这一问题的最简单方法是使用函数实现装饰器，以便为您处理这一问题。否则，您需要显式调用描述符。这里有一个方法：

import functools


class MyDecoratorClass:
    def __init__(self, method):
        functools.update_wrapper(self, method)
        self.method = method

    def __get__(self, instance, owner):
        return type(self)(self.method.__get__(instance, owner))

    def __call__(self, *args, **kwargs):
        # do stuff before
        retval = self.method(*args, **kwargs)
        # do stuff after
        return retval


class Foobar:
    def __init__(self):
        # initialize stuff
        pass

    @MyDecoratorClass
    def foo(self, x, y):
        print(f"{[self, x, y]=}")


@MyDecoratorClass
def bar(spam):
    print(f"{[spam]=}")


Foobar().foo(1, 2)
bar(3)

这里__get__方法使用绑定方法创建一个新的MyDecoratorClass实例（以前self.method只是一个函数，因为还没有实例存在）。还请注意__call__只调用self.method(*args, **kwargs)-如果self.method现在是绑定方法，那么FooBar的self已经隐含