如何在python函数中强制一个关键字

Question

我正在实现带有三个关键字的功能。 每个关键字的默认值为None ，但是我需要强制用户至少传递一个关键字。 我之所以要使用关键字，是因为关键字名称a, b和c是描述性的，并且将帮助用户弄清楚他需要将什么传递给method 。 我如何完成任务？

def method(a=None, b=None, c=None):

    if a!=None:
        func_a(a)
    elif b!=None:
        func_b(b)
    elif c!=None:
        func_c(c)
    else:
        raise MyError('Don\'t be silly, user - please!')

在上面的示例中，当然假设a, b和c具有不同的属性。 显而易见的解决方案是：

def method(x):
    if is_instance(x, A):
        func_a(x)
    elif is_instance(x, B):
        func_b(x)
    [...]

但是问题是，正如我所说，我想使用关键字名称a, b和c来帮助用户理解他确实需要传递给method ！

有没有更Python的方法来达到目的？

Answer 1

您可以使用all()尽早引发错误：

def foo(a=None, b=None, c=None):
    if all(x is None for x in (a, b, c)):
        raise ValueError('You need to set at least *one* of a, b, or c')

    if a is not None:
        func_a(a)
    # etc.

Answer 2

您可以使用装饰器来模拟“合同”编程范例。

def check_params(func):
    def wrapper(*args, **kwargs):
        a = kwargs.get('a', None)
        b = kwargs.get('b', None)
        c = kwargs.get('c', None)
        if (a == b == c == None):
            raise Exception("Set one of a, b or c is mandatory.")
        else:
            return func(*args, **kwargs)
    return wrapper


@check_params
def foo(a=None, b=None, c=None):
    print("Ok")


foo(a=4)  # This will print ok.
foo()     # This will rise an exception.

Answer 3

请注意，诸如method(b="something", a="otherthing") func_a(a)将返回func_a(a) ， 而不 func_b(b)用户可能期望的func_b(b) 。 实际上，最好确保一个且只有一个关键字不是 None （请参见例如此处 ），为此，对于用户来说，直接调用相应方法可能更有意义（尽管您可能想调用它们） method_from_a等）。

Answer 4

尝试使用此表达式来评估至少传递了一个参数

if not (a or b or c):
    raise MyError