作为基类一部分的 Python 装饰器不能用于装饰继承类中的成员函数

Question

Python 装饰器使用起来很有趣，但由于参数传递给装饰器的方式，我似乎碰壁了。在这里，我将一个装饰器定义为基类的一部分（装饰器将访问类成员，因此它需要 self 参数）。

class SubSystem(object):
    def UpdateGUI(self, fun): #function decorator
        def wrapper(*args):
            self.updateGUIField(*args)
            return fun(*args)
        return wrapper

    def updateGUIField(self, name, value):
        if name in self.gui:
            if type(self.gui[name]) == System.Windows.Controls.CheckBox:
                self.gui[name].IsChecked = value #update checkbox on ui 
            elif type(self.gui[name]) == System.Windows.Controls.Slider:
                self.gui[name].Value = value # update slider on ui 

        ...

我省略了其余的实现。现在这个类是从它继承的各种子系统的基类——一些继承的类需要使用 UpdateGUI 装饰器。

class DO(SubSystem):
    def getport(self, port):
        """Returns the value of Digital Output port "port"."""
        pass

    @SubSystem.UpdateGUI
    def setport(self, port, value):
        """Sets the value of Digital Output port "port"."""
        pass

我再次省略了函数实现，因为它们不相关。

简而言之，问题是虽然我可以通过将继承类中定义的装饰器指定为 SubSystem.UpdateGUI 来访问基类中定义的装饰器，但在尝试使用它时最终会得到这个 TypeError：

unbound method UpdateGUI() must be called with SubSystem instance as first argument (got function instance instead)

这是因为我没有立即可识别的方式将self 参数传递给装饰器！

有没有办法做到这一点？还是我已经达到了 Python 中当前装饰器实现的极限？

Answer 1

您需要将UpdateGUI 设为@classmethod，并让您的wrapper 知道self。一个工作示例：

class X(object):
    @classmethod
    def foo(cls, fun):
        def wrapper(self, *args, **kwargs):
            self.write(*args, **kwargs)
            return fun(self, *args, **kwargs)
        return wrapper

    def write(self, *args, **kwargs):
        print(args, kwargs)

class Y(X):
    @X.foo
    def bar(self, x):
        print("x:", x)

Y().bar(3)
# prints:
#   (3,) {}
#   x: 3

Answer 2

将装饰器从 SubSytem 类中拉出来可能更容易： （请注意，我假设调用setport 的self 与您希望用来调用updateGUIField 的self 相同。）

def UpdateGUI(fun): #function decorator
    def wrapper(self,*args):
        self.updateGUIField(*args)
        return fun(self,*args)
    return wrapper

class SubSystem(object):
    def updateGUIField(self, name, value):
        # if name in self.gui:
        #     if type(self.gui[name]) == System.Windows.Controls.CheckBox:
        #         self.gui[name].IsChecked = value #update checkbox on ui 
        #     elif type(self.gui[name]) == System.Windows.Controls.Slider:
        #         self.gui[name].Value = value # update slider on ui 
        print(name,value)

class DO(SubSystem):
    @UpdateGUI
    def setport(self, port, value):
        """Sets the value of Digital Output port "port"."""
        pass

do=DO()
do.setport('p','v')
# ('p', 'v')

Answer 3

你已经回答了这个问题：如果你打电话给SubSystem.UpdateGUI，你希望self得到什么参数？没有明显的实例应该传递给装饰器。

您可以做几件事来解决这个问题。也许您已经有一个在其他地方实例化的subSystem？然后你可以使用它的装饰器：

subSystem = SubSystem()
subSystem.UpdateGUI(...)

但也许您一开始并不需要实例，只需要 类 SubSystem？在这种情况下，使用 classmethod 装饰器告诉 Python 这个函数应该接收它的类作为第一个参数而不是实例：

@classmethod
def UpdateGUI(cls,...):
    ...

最后，也许您不需要访问实例或类！在这种情况下，请使用staticmethod：

@staticmethod
def UpdateGUI(...):
    ...

哦，顺便说一句，Python 约定是为类保留 CamelCase 名称，并为该类上的方法使用混合大小写或 under_scored 名称。

Answer 4

您需要使用 SubSystem 的实例来进行装饰，或者按照 kenny 的建议使用 classmethod。

subsys = SubSystem()
class DO(SubSystem):
    def getport(self, port):
        """Returns the value of Digital Output port "port"."""
        pass

    @subsys.UpdateGUI
    def setport(self, port, value):
        """Sets the value of Digital Output port "port"."""
        pass

您可以通过决定是否希望所有子类实例共享相同的 GUI 界面或是否希望能够让不同的子类实例具有不同的界面来决定做什么。

如果它们都共享相同的 GUI 界面，请使用类方法并将装饰器访问的所有内容都设为类实例。

如果它们可以有不同的接口，您需要决定是否要通过继承来表示独特性（在这种情况下，您还可以使用 classmethod 并在 SubSystem 的子类上调用装饰器）或者是否是更好地表示为不同的实例。在这种情况下，为每个接口创建一个实例并在该实例上调用装饰器。