Quelle exception dois-je lever sur les combinaisons d'arguments incorrectes / illégales en Python?

Je me demandais quelles étaient les meilleures pratiques pour indiquer des combinaisons d'arguments invalides en Python. Je suis tombé sur quelques situations où vous avez une fonction comme ça:

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

Le seul inconvénient est que chaque paquet a le sien, généralement légèrement différent BadValueError. Je sais qu'il existe en Java java.lang.IllegalArgumentException- est-il bien entendu que tout le monde va créer son propre BadValueErrors en Python ou existe-t-il une autre méthode préférée?

Je voudrais simplement soulever ValueError , sauf si vous avez besoin d'une exception plus spécifique ..

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

Il n'y a vraiment aucun intérêt à le faire class BadValueError(ValueError):pass- votre classe personnalisée est identique à ValueError , alors pourquoi ne pas l'utiliser?

J'hériterais de ValueError

class IllegalArgumentError(ValueError):
    pass

Il est parfois préférable de créer vos propres exceptions, mais héritez d'une exception intégrée, qui est aussi proche de ce que vous voulez que possible.

Si vous devez détecter cette erreur spécifique, il est utile d'avoir un nom.

Je pense que la meilleure façon de gérer cela est la façon dont python le gère lui-même. Python déclenche une TypeError. Par exemple:

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

Notre développeur junior vient de trouver cette page dans une recherche Google pour "les arguments incorrects de l'exception python" et je suis surpris que la réponse évidente (pour moi) n'ait jamais été suggérée dans la décennie depuis que cette question a été posée.

Je viens surtout de voir le builtin ValueErrorutilisé dans cette situation.

Cela dépend du problème avec les arguments.

Si l'argument a le mauvais type, déclenchez une TypeError. Par exemple, lorsque vous obtenez une chaîne au lieu d'un de ces booléens.

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

Notez cependant qu'en Python, nous effectuons rarement des vérifications comme celle-ci. Si l'argument est vraiment invalide, une fonction plus profonde fera probablement la plainte pour nous. Et si nous vérifions uniquement la valeur booléenne, peut-être qu'un utilisateur de code lui fournira plus tard une chaîne en sachant que les chaînes non vides sont toujours True. Cela pourrait lui sauver un casting.

Si les arguments ont des valeurs non valides, augmentez ValueError. Cela semble plus approprié dans votre cas:

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

Ou dans ce cas spécifique, avoir une valeur True de recurse implique une valeur True de save. Étant donné que je considérerais cela comme une récupération après une erreur, vous pouvez également vous plaindre dans le journal.

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

Je ne suis pas sûr d'être d'accord avec l'héritage de ValueError- mon interprétation de la documentation est que celle ValueError-ci n'est censée être générée que par les buildins ... l'hériter ou la générer vous-même semble incorrect.

Déclenché lorsqu'une opération ou une fonction intégrée reçoit un argument qui a le bon type mais une valeur inappropriée, et la situation n'est pas décrite par une exception plus précise telle que IndexError.

- Documentation ValueError

Acceptez la suggestion de Markus de lever votre propre exception, mais le texte de l'exception devrait clarifier que le problème se trouve dans la liste d'arguments, pas dans les valeurs d'argument individuelles. Je proposerais:

class BadCallError(ValueError):
    pass

Utilisé lorsque des arguments de mots clés sont manquants qui étaient requis pour l'appel spécifique, ou que les valeurs d'argument sont valides individuellement mais incohérentes les unes avec les autres. ValueErroraurait toujours raison quand un argument spécifique est de type correct mais hors de portée.

Cela ne devrait-il pas être une exception standard en Python?

En général, j'aimerais que le style Python soit un peu plus net pour distinguer les mauvaises entrées d'une fonction (faute de l'appelant) des mauvais résultats au sein de la fonction (ma faute). Il peut donc y avoir également une erreur BadArgumentError pour distinguer les erreurs de valeur dans les arguments des erreurs de valeur dans les sections locales.