函数装饰器引发位置参数错误？

Question

我正在尝试编写一个函数装饰器来测试 x、y 的边界

#this is my bound test function
def boundtest(func):
    def onDecorator(self, x, y, *args, **kwargs):
        print(x, y, *args, **kwargs)
        assert x in range(self.width) and y in range(self.height)
        return func(x, y, *args, **kwargs)

    return onDecorator

class Game:
    #these are the functions that need bound checking

    @boundtest
    def at(self, x: int, y: int) -> int:
        return self.map[x, y]

    @boundtest
    def set(self, x: int, y: int, data):
        self.map[x, y] = data.value

当我执行game.set(1, 1, Color.RED) 时，我得到：

Traceback (most recent call last):
  File "C:\Users\Ben\Desktop\Projects\bubble-breaker-bot\game.py", line 61, in <module>
    game.set(1, 1, Color.RED)
  File "C:\Users\Ben\Desktop\Projects\bubble-breaker-bot\game.py", line 21, in onDecorator
    return func(x, y, *args, **kwargs)
TypeError: set() missing 1 required positional argument: 'data'

我需要 boundtest 函数来检查 x 和 y 是否分别在 self.width 和 self.height 的范围内，同时能够将任意数量的参数传递给它正在装饰的函数。

为什么会这样？

Answer 1

装饰器应用于函数对象，而不是绑定方法。这意味着您需要手动传递self 参数：

def boundtest(func):
    def onDecorator(self, x, y, *args, **kwargs):
        print(x, y, *args, **kwargs)
        assert x in range(self.width) and y in range(self.height)
        return func(self, x, y, *args, **kwargs)

    return onDecorator

Python 使用一个名为binding 的进程将函数转换为绑定方法，并且调用绑定方法会自动将其绑定到 的任何内容作为第一个参数传入；当您在实例上调用函数时，这就是 self 传递给方法的方式。有关详细信息，请参阅Descriptor HowTo。除了手动传递self，您还可以通过invoke descriptor binding manually 调用func.__get__() 来生成绑定方法：

def boundtest(func):
    def onDecorator(self, x, y, *args, **kwargs):
        print(x, y, *args, **kwargs)
        assert x in range(self.width) and y in range(self.height)
        bound_method = func.__get__(self, type(self))
        return bound_method(x, y, *args, **kwargs)

    return onDecorator

该绑定行为应用于您的装饰器在解析game.set 时返回的onDecorator 函数对象，但未应用于包装的func 对象。