对于 Python 中的错误/非法参数组合，我应该提出哪个异常？

Question

我想知道在 Python 中指示无效参数组合的最佳实践。我遇到过一些你有这样的功能的情况：

def import_to_orm(name, save=False, recurse=False):
    """
    :param name: Name of some external entity to import.
    :param save: Save the ORM object before returning.
    :param recurse: Attempt to import associated objects as well. Because you
        need the original object to have a key to relate to, save must be
        `True` for recurse to be `True`.
    :raise BadValueError: If `recurse and not save`.
    :return: The ORM object.
    """
    pass

唯一的烦恼是每个包都有自己的，通常略有不同BadValueError。我知道在 Java 中存在 java.lang.IllegalArgumentException——大家都知道每个人都会在 Python 中创建自己的 BadValueErrors 吗？还是有另一种首选的方法？

Answer 1

除非您需要更具体的例外，否则我只会提出 ValueError。

def import_to_orm(name, save=False, recurse=False):
    if recurse and not save:
        raise ValueError("save must be True if recurse is True")

class BadValueError(ValueError):pass 确实没有意义 - 您的自定义类在使用上与 ValueError 相同，那么为什么不使用它呢？

Answer 2

我会继承 ValueError

class IllegalArgumentError(ValueError):
    pass

有时最好创建自己的异常，但要从内置的异常继承，它尽可能接近你想要的。

如果您需要捕获该特定错误，有一个名称会很有帮助。

Answer 3

我认为处理这个问题的最好方法是 python 本身处理它的方式。 Python 引发类型错误。例如：

$ python -c 'print(sum())'
Traceback (most recent call last):
File "<string>", line 1, in <module>
TypeError: sum expected at least 1 arguments, got 0

我们的初级开发人员刚刚在谷歌搜索“python 异常错误参数”时发现了这个页面，我很惊讶自从提出这个问题以来的十年里，从未提出过明显的（对我而言）答案。

Answer 4

这取决于参数的问题。

如果参数的类型错误，则引发 TypeError。例如，当您得到一个字符串而不是其中一个布尔值时。

if not isinstance(save, bool):
    raise TypeError(f"Argument save must be of type bool, not {type(save)}")

但是请注意，在 Python 中我们很少进行这样的检查。如果这个论点真的是无效的，一些更深层次的函数可能会为我们抱怨。如果我们只检查布尔值，也许一些代码用户稍后会只给它一个字符串，知道非空字符串总是 True。这可能会为他节省演员阵容。

如果参数具有无效值，则引发 ValueError。这似乎更适合您的情况：

if recurse and not save:
    raise ValueError("If recurse is True, save should be True too")

或者在这种特定情况下，递归的 True 值意味着保存的 True 值。由于我认为这是从错误中恢复，因此您可能还想在日志中抱怨。

if recurse and not save:
    logging.warning("Bad arguments in import_to_orm() - if recurse is True, so should save be")
    save = True

Answer 5

我大多只是看到在这种情况下使用的内置 ValueError。

Answer 6

在这种情况下，您很可能会使用ValueError（完整的raise ValueError()），但这取决于错误值的类型。例如，如果您创建了一个只允许字符串的函数，而用户输入了一个整数，那么您将改为 TypeError。如果用户输入了错误的输入（意味着它具有正确的类型但它不符合某些条件）Value Error 将是您的最佳选择。 Value 错误也可用于阻止程序发生其他异常，例如，您可以使用ValueError 来停止shell 表单，引发ZeroDivisionError，例如，在此函数中：

def function(number):
    if not type(number) == int and not type(number) == float:
        raise TypeError("number must be an integer or float")
    if number == 5:
        raise ValueError("number must not be 5")
    else:
        return 10/(5-number)

附：有关 python 内置异常的列表，请转到此处： https://docs.python.org/3/library/exceptions.html（这是官方python数据库）

Answer 7

我不确定我是否同意从 ValueError 继承——我对文档的解释是，ValueError 仅应该由内置函数...继承自它或自己举起来好像不对。

在内置操作或 函数接收一个参数 类型正确但不合适 值，而情况不是 由更精确的异常描述 比如IndexError。

-- ValueError documentation

Answer 8

同意 Markus 关于推出您自己的异常的建议，但异常的文本应阐明问题出在参数列表中，而不是单个参数值。我建议：

class BadCallError(ValueError):
    pass

在缺少特定调用所需的关键字参数或参数值单独有效但彼此不一致时使用。当特定参数类型正确但超出范围时，ValueError 仍然正确。

这不应该是 Python 中的标准例外吗？

一般来说，我希望 Python 风格能够更清晰地区分函数的错误输入（调用者的错误）和函数中的错误结果（我的错误）。所以可能还会有一个 BadArgumentError 来区分参数中的值错误和局部值错误。