使用装饰器在python中的类方法上设置类的属性

Question

我有一个ABC类，里面有一个功能someFunction 。

我不想弄乱someFunction的代码，因此用@MyDecorator包装它。 当我调用someFunction时，该MyDecorator如何修改ABC类的属性？

class ABC(object):
    def __init__(self):
        self.someProperty = "Initial value"

    @MyDecorator
    def someFunction(self):
        print "Hello world"


class MyDecorator(object):
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        # ...??? 
        return self.func(*args, **kwargs)

abc = ABC()
abc.someFunction()  #   When calling someFunction(), abc.someProperty would be updated

Answer 1

你可以试试：

class MyDecorator(object):
    def __init__(self, func):
        self.func = func
    def __call__(self, instance, *args, **kwargs):
        instance.someProperty = "New value"
        return self.func(instance, *args, **kwargs)
    def __get__(self, instance, owner):
        if instance is None:
            return self
        return self.__call__.__class__(self, instance)

class ABC(object):
    def __init__(self):
        self.someProperty = "Initial value"
    @MyDecorator
    def someFunction(self):
        print("Hello world")

MyDecorator现在是一个描述符，因为它实现了__get__ 。

通过某个类或该类的实例访问MyDecorator的任何实例的属性时，将调用__get__ 。

__get__将在参数instance接收该所有者对象的instance ，从那里我们可以返回一个新的instancemethod instancemethod ，该instance隐式接收该instance ：

>>> abc.someFunction.__class__
<type 'instancemethod'>
>>> abc.someFunction.__class__.__doc__
'instancemethod(function, instance, class)\n\nCreate an instance method object.'
>>>

它需要一个function ，基本上任何可调用的对象将工作，因为MyDecorator是一流的， __call__将修改自己的self 。

实际上：

>>> abc = ABC()
>>> abc.someProperty
'Initial value'
>>> abc.someFunction()
Hello world
>>> abc.someProperty
'New value'
>>>

请注意，在Python 2.X中， MyDecorator必须是继承object的新类，否则将不起作用。

Answer 2

您需要在文件中定义MyDecorator的位置早于使用它的位置，否则会收到“ NameError：未定义名称'MyDecorator'的信息”。

当我说“装饰器应该返回一个函数”时，我错了。 在我的示例中，这适用于用作装饰器的函数。 但是，当使用一个类时，它不必返回这样的函数。 它返回该类中的一个对象。 如果将“类MyDecorator”命名为“类MyModifiedFunction”，则可能会减少混淆，因为该类的元素用作修饰函数。

通常，装饰器返回的函数将调用原始函数。 你的不是。 如果您要完全替换someFunction而不是仅仅对其进行修改，则不必这样做。

您无需将MyDecorator设置为类。 您可以使其功能。 这是一个例子：

def MyDecorator(original_function):
    def replacement_function(*args, **kwargs):
        args[0].some_property = some_new_value
        return(original_function(*args, **kwargs))
    return(replacement_function)

在代码的前半部分之后定义ABC类。

请注意，当它说return(original_function(*args, **kwargs))它正在运行原始函数并返回原始函数返回的任何内容。 如果原始函数返回了一个对象，它将返回该对象。 但是，当它说return(replacement_function)它所做的事情却大不相同：当时它没有运行替换函数； 它只是将函数作为返回值返回。 装饰器必须返回一个函数。

（@dano：好点。我认为是固定的。）

这是上述建议的更完整形式：

def MyDecorator(original_function):
    def replacement_function(*args, **kwargs):
        args[0].some_property = 'Modified value'
        return(original_function(*args, **kwargs))
    return(replacement_function)

class ABC(object):
    def __init__(self):
        self.some_property = "Initial value"

    @MyDecorator
    def some_function(self):
        print "Hello world"

abc = ABC()
abc.some_function()  #   When calling some_function(), abc.some_property wou

ld更新

print "some property is", abc.some_property

我运行了它，它起作用了； 它打印

Hello world
some property is Modified value

因此，这可以验证它确实修改了abc中的some_property。 它以args[0].some_property的形式访问，因为调用修饰的函数（作为对象方法）时， self作为第一个参数传递。