如何在Python中创建虚假的哨兵对象？

Question

我有一个函数，它被设计为通过传入一个to关键字参数来调用。我使用哨兵对象作为默认值，这样我就可以确保没有人只是在没有任何参数的情况下调用func（），这是一个明显的逻辑错误。通过传递无作为其中一个参数的值来调用函数是可以的，在这种情况下它只是不做任何处理。

NO_VALUE = object()


def func(*, arg1 = NO_VALUE, arg2 = NO_VALUE):
    if arg1 is NO_VALUE and arg2 is NO_VALUE:
        raise ValueError("Pass in one of `arg1` or arg2`.")

    if arg1 is not NO_VALUE and arg1:
        # Do something with a truthy `arg1` value.
    if arg2 is not NO_VALUE and arg2:
        # Do something with a truthy `arg2` value.

如果arg1不是NO_ VALUE，arg1和arg2不是NO_VALUE，arg2和arg2，我可以简化＜code＞分别为＜code＞和＜code＞的＜code＞吗？

我尝试使NO_VALUE成为空元组（），但似乎空元组的id（）总是（？）与任何其他空元组的id（）相同。我也不想让NO_VALUE例如空列表对象，从那时起，我会收到有关使用可变默认值的linter警告。

Answer 1

为了获得您描述的行为，我认为您应该使用kwargs而不是关键字args。考虑以下功能：

def func(**kwargs):
    if kwargs.keys() == set(['arg1']):
        print(kwargs['arg1'])
    elif kwargs.keys() == set(['arg2']):
        print(kwargs['arg2'])
    else:
        raise ValueError("Pass in one of `arg1` or `arg2`")

因为你最终试图在你的函数参数上实现更复杂的逻辑，所以用代码来处理这个问题是有意义的，而不是让编译器尝试用奇怪的哨兵来整理它。

Answer 2

在任何情况下：对于Python对象是“Falsy”，它可以是实现__bool__并在调用时返回False的类的实例：

class FalsySentinel:
    def  __bool__(self):
        return False


NO_VALUE = FalsySentinel()


def func(*, arg1 = NO_VALUE, arg2 = NO_VALUE):
    if arg1 is NO_VALUE and arg2 is NO_VALUE:
        raise ValueError("Pass in one of `arg1` or arg2`.")

    if arg1:
        # Do something with a truthy `arg1` value.
    if arg2:
        # Do something with a truthy `arg2` value.

还有其他方法可以生成falsy对象，比如实现< code>__len__并返回< code>0的对象——但这是最直接明了的方法。