强制特定的函数签名

Question

我刚刚发现自己在写这样的代码：

def register(self, *,  # * enforces keyword-only parameters
             key_value_container:dict=None,    # legal parameter set #1
             key:str=None, value=None):        # legal parameter set #2

    # enforce one of the parameter sets
    if not ((key_value_container is not None and 
             key is None and value is None) or
            (key is not None and value is not None and 
             key_value_container is None)):
        raise TypeError('provide (key_value_container) or (key/value')

    # handle each legal parameter setf
    if key_value_container is not None:
        for _k, _s in key_value_container.items():
            self.register(_k, _s)
    else:
        do_something_with(key, value)

我的目标是拥有register() 方法的两个签名：它应该采用key 和value 或带有许多键和值的容器，例如dict。

参数中的* 至少迫使我提供命名参数，但不需要提供给定数量的参数甚至给定的一组参数.

当然，我可以（应该）提供两种不同名称和签名的方法，而不是一种。

但如果我想（必须）提供一种方法/函数具有多个参数语义 - 使其可见并强制执行它的最佳方法是什么？

详细说明：

• 是否可以在auto-completion和documentation中明确哪些是合法的参数组合？
• 如何检查（尽可能少的样板代码）是否提供了一种组合？

Answer 1

为了避免样板代码，您可以这样：编写指定不同签名的附加函数。然后有一个redirect 辅助函数，根据参数匹配的签名将参数从主函数发送到附加函数。

它仍然不是特别优雅。如果概括这一点，您还需要考虑如何处理None 是您可能想要传递的有效参数的情况。

from inspect import getargspec
class Eg(object):
    def register(self, key_value_container=None, key=None, value=None):
        return redirect(locals(), [self.register_dict, self.register_single])

    def register_dict(self, key_value_container=None):
        print('register dict', key_value_container)

    def register_single(self, key=None, value=None):
        print('register single', key, value)

def redirect(params, functions):
    provided = {k for k, v in params.items() if v is not None}
    for function in functions:
        if set(getargspec(function).args) == provided:
            return function(**{k: params[k] for k in provided if k != 'self'})
    raise TypeError('wrong configuration provided') 
    # This error could be expanded to explain which signatures are allowed       

a = Eg()
a.register(key='hi', value='there')
a.register(key_value_container={'hi': 'there'})