其他类方法的类装饰器 1试验一:身份丢失 2试验二:保持身份,但崩溃

问题描述

注意:
在这里一个相关的问题: 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不(或不应)执行任何操作。这只是样板代码,准备在以后使用。类foo()中的方法Foobar打印在其上调用的对象:

import functools

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

    def __call__(self,**kwargs):
        # do stuff before
        retval = self.method(self,**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

现在您在这里观察到的是self方法中的foo()被交换了。它不再是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,**kwargs):
        # do stuff before
        retval = self.method(self.method.__self__,**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,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

一个细微的差别,但是我不确定为什么。

解决方法

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

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,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现在是绑定方法,则已经隐含self的{​​{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,**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,**kwargs)

克里斯托夫的笔记
可能是您的意思吗?

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

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

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