用装饰器类装饰方法

时间:2019-09-09 15:10:55

标签: python

我正在尝试为方法创建包装。 装饰器本身被实现为覆盖__call__方法的类。

这适用于修饰函数,但是如果以这种方式修饰方法,则self不会绑定到修饰的函数。

以下是一个最小的示例:

import functools


class Wrapper:

    def __init__(self, func) -> None:
        super().__init__()
        self.__func = func
        functools.update_wrapper(self, func)

    def __call__(self, *args, **kwargs):
        print("PreBar")
        result = self.__func(*args, **kwargs)
        print("PostBar")
        return result


def MyDecorator(func):
    return Wrapper(func)


class Foo:
    baz = "Baz"

    @MyDecorator
    def bar(self):
        print(self.baz)
        return self.baz


if __name__ == '__main__':
    foo = Foo()
    print(foo.bar)
    print(f"Result of foo.bar(): {foo.bar()}")

    print(Foo.bar)
    print(f"Result of Foo.bar(foo): {Foo.bar(foo)}")

这会产生以下错误,这意味着self不会像普通方法那样自动传递给__call__调用:

Traceback (most recent call last):
  File "/mypath/test.py", line 35, in <module>
    print(f"Result of foo.bar(): {foo.bar()}")
  File "/mypath/test.py", line 14, in __call__
    result = self.__func(*args, **kwargs)
TypeError: bar() missing 1 required positional argument: 'self'

问题:如何将返回的可调用包装对象绑定到self? 将对象包装在函数中以让python进行绑定是一种选择,但是在我的情况下不是这样,因为需要实际的对象。

问题How can I decorate an instance method with a decorator class?与我要解决的问题类似。如果仅需要绑定,则此处提供的解决方案有效。我需要的是,访问属性时返回的对象实例的类型为Wrapper,而不是类型为functools.partial

second answer to that question也不起作用,因为__get__返回的实例的类型为method而不是Wrapper

1 个答案:

答案 0 :(得分:0)

以下文章通过简单地将对象包装在函数中来解决该问题,以便python可以将self与本机机制绑定:Decorating method (class methods overloading)

正如问题中提到的那样,这不是我的选择。该帖子还提到了另一种选择:为Wrapper类实现描述符协议。问题Decorating a method也解决了这个问题。 那里的问题是,那里使用的方法仅适用于该类的一个实例。

我想出了以下解决方案:

import functools


class Wrapper:

    def __init__(self, func, instance=None) -> None:
        super().__init__()
        self.__func = func
        self.__instance = instance
        self.__bindings = {}
        functools.update_wrapper(self, func)

    def __call__(self, *args, **kwargs):
        print("PreBar")
        if self.__instance is not None:
            args =(self.__instance, ) + args
        result = self.__func(*args, **kwargs)
        print("PostBar")
        return result

    def __get__(self, instance, owner):
        try:
            return self.__bindings[(instance, owner)]
        except KeyError:
            binding = self.__bindings[(instance, owner)] = Wrapper(self.__func, instance)
            return binding


def MyDecorator(func):
    return Wrapper(func)


class Foo:
    baz = "Baz"

    @MyDecorator
    def bar(self):
        print(self.baz)
        return self.baz


if __name__ == '__main__':
    foo = Foo()
    print(foo.bar)
    print(f"Result of foo.bar(): {foo.bar()}")

    print(Foo.bar)
    print(f"Result of Foo.bar(foo): {Foo.bar(foo)}")

区别在于,函数描述符的__get__方法为每个(实例,所有者)对创建一个新的Wrapper实例。 通过这种方式,包装程序始终始终仅绑定到一个实例,甚至是类本身。