Какое исключение я должен поднять на неправильные / недопустимые комбинации аргументов в Python?

Мне было интересно узнать, как лучше всего указывать недопустимые комбинации аргументов в 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- хорошо ли понимают, что все будут создавать свои собственные BadValueErrorв Python или есть другой, предпочтительный метод?

Я бы просто поднял 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 , так почему бы не использовать его?

Я бы унаследовал от ValueError

class IllegalArgumentError(ValueError):
    pass

Иногда лучше создавать свои собственные исключения, но наследовать от встроенного, которое максимально приближено к тому, что вы хотите.

Если вам нужно поймать эту конкретную ошибку, полезно иметь имя.

Я думаю, что лучший способ справиться с этим - это то, как сам Python справляется с этим. Python вызывает ошибку TypeError. Например:

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

Наш младший разработчик только что нашел эту страницу в поиске Google для «неправильных аргументов исключения Python», и я удивлен, что очевидный (для меня) ответ никогда не предлагался в течение десятилетия с тех пор, как был задан этот вопрос.

Я в основном только что видел встроенный ValueErrorв этой ситуации.

Это зависит от того, в чем проблема с аргументами.

Если аргумент имеет неправильный тип, вызовите 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")

Или в этом конкретном случае истинное значение recurse подразумевает истинное значение save. Поскольку я считаю, что это восстановление после ошибки, вы также можете пожаловаться в журнале.

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

Я не уверен , что я согласен с наследованием от ValueError- моей интерпретации документации , что ValueErrorэто только предполагается , поднятый ... наследуя встроенных команд от него или поднять его сами , кажется неправильным.

Возникает, когда встроенная операция или функция получает аргумент, который имеет правильный тип, но недопустимое значение, и ситуация не описывается более точным исключением, таким как IndexError.

- ValueError документация

Согласитесь с предложением Маркуса откатить собственное исключение, но текст исключения должен прояснить, что проблема в списке аргументов, а не в значениях отдельных аргументов. Я бы предложил:

class BadCallError(ValueError):
    pass

Используется, когда отсутствуют аргументы ключевого слова, которые требовались для определенного вызова, или значения аргументов индивидуально действительны, но несовместимы друг с другом. ValueErrorвсе равно будет правильным, если конкретный аргумент имеет правильный тип, но находится вне диапазона.

Разве это не должно быть стандартным исключением в Python?

В общем, я хотел бы, чтобы стиль Python был немного более четким в различении плохих входов в функцию (ошибка вызывающего) и плохих результатов в функции (моя ошибка). Таким образом, может также существовать ошибка BadArgumentError, чтобы отличать значения ошибок в аргументах от ошибок значений в локальных объектах.