Який виняток слід підкреслити щодо помилкових / незаконних комбінацій аргументів у 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- чи добре зрозуміло, що всі будуть створювати свої власні BadValueErrors в 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 піднімає 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")

Або в цьому конкретному випадку значення 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

Я не впевнений , що я згоден з успадкуванням від ValueError- моїй інтерпретації документації , що ValueErrorце тільки передбачається , піднятий ... наслідуючи вбудованих команд від нього або підняти його самі , здається неправильним.

Піднімається, коли вбудована операція або функція отримує аргумент, який має правильний тип, але невідповідне значення, і ситуація не описується більш точним винятком, таким як IndexError.

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

Погодьтесь із пропозицією Маркуса прокласти власний виняток, але текст винятку повинен уточнити, що проблема полягає у списку аргументів, а не в окремих значеннях аргументу. Я б запропонував:

class BadCallError(ValueError):
    pass

Використовується, коли відсутні аргументи ключових слів, необхідні для конкретного виклику, або значення аргументів є індивідуально допустимими, але несумісними між собою. ValueErrorвсе-таки буде правильним, коли конкретний аргумент є правильним типом, але поза діапазоном.

Чи не повинно це бути стандартним винятком у Python?

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