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

标签 python python-3.x decorator python-decorators

<分区>

注意:
我在这里有一个相关的问题: 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。试验一:identity loss

下面的装饰器 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

有细微差别,但我不确定原因。

最佳答案

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

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__ 方法使用绑定(bind)方法创建了 MyDecoratorClass 的新实例(之前 self.method 只是一个函数,因为没有实例还存在)。另请注意,__call__ 仅调用 self.method(*args, **kwargs) - 如果 self.method 现在是绑定(bind)方法,则FooBarself 已经隐含了。

关于python - 来自其他类的方法的类装饰器,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/63402709/

相关文章:

python - python中存储对象的堆存在于哪里?

python - 日志记录:记录器不记录到文件,而是记录到控制台

python - 有没有办法解决 selenium 浏览器中的 cookie 和隐私弹出窗口?

python - 可以从 py2exe 可执行文件中恢复人类可读的源代码吗?

python - 如何创建 Pandas 列的所有可能组合?

python - 使用装饰器在 try/except 中包装类方法

python - 如何在 PyQt 上绘制合适的网格?

python - 受其他数组限制的 Numpy 随机数组

python - 这个 Python 装饰器内部发生了什么?

ruby-on-rails-3 - 通过 rake 运行 rspec 测试时在装饰器中获取未初始化的常量(NameError)