Który wyjątek powinienem zgłosić w przypadku złych / nielegalnych kombinacji argumentów w Pythonie?

Zastanawiałem się nad najlepszymi praktykami wskazywania nieprawidłowych kombinacji argumentów w Pythonie. Spotkałem kilka sytuacji, w których masz taką funkcję:

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

Jedyną irytacją jest to, że każda paczka ma swoją, zwykle nieco się różni BadValueError. Wiem, że w Javie istnieje java.lang.IllegalArgumentException- czy dobrze wiadomo, że wszyscy będą tworzyć własne BadValueErrorw Pythonie, czy jest też inna, preferowana metoda?

Chciałbym tylko podnieść ValueError , chyba że potrzebujesz bardziej szczegółowego wyjątku.

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

Naprawdę nie ma sensu tego robić class BadValueError(ValueError):pass- twoja klasa niestandardowa jest identyczna w użyciu z ValueError , więc dlaczego tego nie użyć?

Odziedziczyłbym po ValueError

class IllegalArgumentError(ValueError):
    pass

Czasami lepiej jest tworzyć własne wyjątki, ale dziedziczyć po wbudowanym, który jest tak blisko, jak chcesz.

Jeśli chcesz wyłapać ten konkretny błąd, dobrze jest mieć nazwę.

Myślę, że najlepszym sposobem na poradzenie sobie z tym jest sposób, w jaki sam Python sobie z tym radzi. Python podnosi błąd typu. Na przykład:

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

Nasz młodszy programista właśnie znalazł tę stronę w wyszukiwaniu w Google „niepoprawne argumenty wyjątku Python” i jestem zaskoczony, że oczywista (dla mnie) odpowiedź nigdy nie była sugerowana w ciągu dekady, odkąd zadano to pytanie.

Najczęściej widziałem wbudowane ValueErrorużywane w tej sytuacji.

Zależy to od problemu z argumentami.

Jeśli argument ma niewłaściwy typ, podnieś błąd TypeError. Na przykład, gdy otrzymasz ciąg zamiast jednego z tych booleanów.

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

Zauważ jednak, że w Pythonie rzadko przeprowadzamy takie kontrole. Jeśli argument naprawdę jest nieprawidłowy, pewna głębsza funkcja prawdopodobnie narzeka za nas. A jeśli sprawdzimy tylko wartość boolowską, być może jakiś użytkownik kodu po prostu poda jej ciąg znaków, wiedząc, że niepuste ciągi są zawsze Prawdą. Może uratować mu obsadę.

Jeśli argumenty mają niepoprawne wartości, zwiększ wartośćError. Wydaje się to bardziej odpowiednie w twoim przypadku:

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

Lub w tym konkretnym przypadku, wartość True rekurencji oznacza True wartość save. Ponieważ uważam to za naprawę po błędzie, możesz również złożyć skargę w dzienniku.

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

Nie jestem pewien, zgadzam się z dziedziczenia ValueError- mojej interpretacji dokumentacji jest to, że ValueErrorjest tylko ma być podniesiony przez builtins ... dziedziczenie z nim lub podnosząc ją samemu wydaje się błędne.

Wywoływany, gdy wbudowana operacja lub funkcja odbiera argument, który ma odpowiedni typ, ale niepoprawną wartość, a sytuacja nie jest opisana bardziej precyzyjnym wyjątkiem, takim jak IndexError.

- Dokumentacja ValueError

Zgadzam się z sugestią Markusa dotyczącą wprowadzenia własnego wyjątku, ale tekst wyjątku powinien wyjaśniać, że problem dotyczy listy argumentów, a nie poszczególnych wartości argumentów. Zaproponowałbym:

class BadCallError(ValueError):
    pass

Używane, gdy brakuje argumentów słów kluczowych wymaganych dla konkretnego wywołania lub wartości argumentów są indywidualnie ważne, ale niespójne ze sobą. ValueErrornadal miałoby rację, gdy określony argument jest poprawnego typu, ale poza zakresem.

Czy nie powinien to być standardowy wyjątek w Pythonie?

Ogólnie rzecz biorąc, chciałbym, aby styl Pythona był nieco ostrzejszy w odróżnianiu złych danych wejściowych funkcji (błąd wywołującego) od złych wyników w obrębie funkcji (moja wina). Może więc istnieć błąd BadArgumentError, aby odróżnić błędy wartości w argumentach od błędów wartości w plikach lokalnych.