其他类方法的类装饰器[重复]

Posted

技术标签:

【中文标题】其他类方法的类装饰器[重复]【英文标题】：Class decorator for methods from other class [duplicate] 【发布时间】：2020-12-03 17:57:04 【问题描述】：

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

我打算写一个相当复杂的装饰器。因此，装饰器本身应该是一个自己的类。我知道这在 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")

现在，当我尝试将装饰器应用于方法 而不仅仅是一个函数时，我的问题就开始了——尤其是如果它是另一个类的方法。让我告诉你我的尝试：

 

1。试验一：身份丢失

下面的装饰器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() 失去了它原来的身份。这将我们带入下一个试验。

 

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

我尝试保留 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

有细微的差别，但我不知道为什么。

【问题讨论】：

因为在我的版本中，它返回一个方法对象，对于==，它的评估结果为真，但它创建了两个不同的对象......有点碍事：a = [1,2]; b = [1,2]，然后是@987654346 @ 但不是a is b 【参考方案1】：

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

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 已经隐含。

【讨论】：

太棒了！这就像一个魅力。非常感谢@Alex Hall！ 嗨，Alex，请在我的问题末尾查看我的 EDIT。我注意到您的解决方案与 @juanpa.arrivillaga 的解决方案之间存在细微差别。你知道为什么吗？【参考方案2】：

您可以实现描述符协议，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)

克里斯托夫的说明 会不会是你的意思：

return types.MethodType(self, obj) 本质上等价于

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

请注意，我将self.func(..) 替换为self(..)。我试过了，只有这样我才能确保# do stuff before和# do stuff after的语句真正运行。

【讨论】：

谢谢@juanpa，这也是解决问题的好方法:-) 您好 Juanpa，请在我的问题末尾查看我的 EDIT。我注意到您的解决方案与 @AlexHall 的解决方案之间存在细微差别。你知道为什么吗？ @K.Mulier 这不是细微的差别，我们采用了完全不同的方法。它们都起作用，但以不同的方式工作。另一个区别是，如果您在__call__ 中使用print(args)，则此解决方案将包括 FooBar 实例（foo 的 self 参数），而我的不会，因为它绑定在新的 self.method 内。 嗨，Alex，感谢您的回复，我仍然不完全清楚为什么它如此不同。这种差异也会影响从装饰器类中访问变量（请参阅***.com/questions/63416226/…） @K.Mulier 因为 Alex 的方法返回 MyDecoratorClass 实例，而我的方法返回 MethodType 实例（与常规方法相同）。

以上是关于其他类方法的类装饰器[重复]的主要内容，如果未能解决你的问题，请参考以下文章

python 装饰器调用其他类中的方法

避免角度中的类选择器重复

将参数传递给要装饰的类方法的装饰器

派生类的类/元类方法装饰器

带有自参数的类方法装饰器？

使用基类装饰器扩展组件装饰器