使用“重载”方法设计回调在Python中

Question

我设计了一个验证 API，其中使用回调来检查值。回调签名有两种变体：

def check(self, value):
    pass

def check(self, value, domain_object):          
    pass

调用回调实现的示例：

for constraint in constraints:
    constraint.check(value) 
    # or constraint.check(value, domain_object) depending on the implementation

现在，我在调用方法之前反射性地计算参数的数量，并根据结果向其传递一个或两个参数。但这是好的风格吗？

最好

• 始终使用带有三个参数的签名：check(self, value, domain_object)，还是
• 在第二种情况下使用不同的名称，例如check_with_domain_object？

我认为就 oop 而言，始终使用三参数变体将是最干净的方法。你怎么认为？

Answer 1

最惯用的方法是首先尝试使用两个参数，如果失败，则尝试使用一个：

try:
    callback(value_param, domain_object_param)
except TypeError:
    callback(value_param)

Answer 2

我喜欢 @Space_C0wb0y 的答案，它类似于 Raymond Hettinger 发送给我的代码，用于解决 pyparsing 中的类似情况（见下文）。对于简单的情况，尝试使用此规范化器类来包装给定的回调：

class _ArityNormalizer(object):
    def __init__(self, fn):
        self.baseFn = fn
        self.wrapper = None

    def __call__(self, value, domain_object):
        if self.wrapper is None:
            try:
                self.wrapper = self.baseFn
                return self.baseFn(value, domain_object)
            except TypeError:
                self.wrapper = lambda v,d: self.baseFn(v)
                return self.baseFn(value)
        else:
            return self.wrapper(value, domain_object)

您的代码现在可以将回调包装在 _ArityNormalizer 中，并且在回调时，始终使用 2 个参数进行调用。 _ArityNormalizer 只会执行一次试错“使用 2 个参数进行调用，如果失败则使用 1 个参数进行调用”逻辑，从那时起将直接转到正确的形式。

在 pyparsing 中，我想支持可能定义为采用 0、1、2 或 3 个参数的回调，并编写代码，根据回调函数的签名，用几个装饰器之一包装被调用的函数。这样，在运行/回调时，我总是使用 3 个参数进行调用，而装饰器负责使用正确数量的参数进行实际调用。

我的代码做了很多脆弱/不可移植/版本敏感的签名自省来做到这一点（听起来像OP当前正在做的事情），直到Raymond Hettinger给我发送了一个很好的数量修剪方法，该方法基本上完成了@Space_C0wb0y的答案建议的内容。 RH 的代码使用了一些非常简洁的装饰器，用一个非局部变量包装来记录成功调用的数量，这样你只需要经历一次试错，而不是每次调用回调时。您可以在 SourceForge 上的 pyparsing SVN 存储库中的函数 _trim_arity 中查看他的代码 - 请注意，由于使用了“nonlocal”关键字，他的代码具有 Py2/Py3 变体。

上面的_ArityNormalizer代码是受到RH代码的启发，在我完全理解他代码的魔力之前。

Answer 3

“Space_C0wb0y”使用 try ... except TypError 的想法看起来不错，但我不喜欢这样的事实，因为这可能会吞掉其他异常。 “Paul McGuire”对 _ArityNormalizer 的建议本质上与良好的界面相同。

最后，我决定让事情尽可能简单和面向对象，并且始终使用两个参数，即使在某些情况下第二个参数将不被使用：

实现方：

def check(self, value, domain_object):          
    pass

调用方：

constraint.check(value, domain_object)