Welche Ausnahme sollte ich für schlechte / illegale Argumentkombinationen in Python auslösen?

Ich habe mich über die Best Practices für die Angabe ungültiger Argumentkombinationen in Python gewundert. Ich bin auf einige Situationen gestoßen, in denen Sie eine Funktion wie diese haben:

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

Das einzige Ärgernis dabei ist, dass jedes Paket sein eigenes hat, normalerweise etwas anders BadValueError. Ich weiß, dass es in Java gibt java.lang.IllegalArgumentException- ist es gut verstanden, dass jeder seine eigenen BadValueErrorin Python erstellen wird, oder gibt es eine andere, bevorzugte Methode?

Ich würde nur ValueError auslösen , es sei denn, Sie benötigen eine spezifischere Ausnahme.

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

Es macht wirklich keinen Sinn, dies zu tun class BadValueError(ValueError):pass- Ihre benutzerdefinierte Klasse ist in der Verwendung mit ValueError identisch. Warum also nicht?

Ich würde von erben ValueError

class IllegalArgumentError(ValueError):
    pass

Manchmal ist es besser, eigene Ausnahmen zu erstellen, aber von einer integrierten zu erben, die so nah wie möglich an Ihren Wünschen liegt.

Wenn Sie diesen bestimmten Fehler abfangen müssen, ist es hilfreich, einen Namen zu haben.

Ich denke, der beste Weg, damit umzugehen, ist die Art und Weise, wie Python selbst damit umgeht. Python löst einen TypeError aus. Zum Beispiel:

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

Unser Junior-Entwickler hat diese Seite gerade in einer Google-Suche nach "falschen Argumenten für Python-Ausnahmen" gefunden, und ich bin überrascht, dass die offensichtliche (für mich) Antwort in dem Jahrzehnt, in dem diese Frage gestellt wurde, nie vorgeschlagen wurde.

Ich habe meistens nur das ValueErrorin dieser Situation verwendete eingebaute gesehen .

Es hängt davon ab, wo das Problem mit den Argumenten liegt.

Wenn das Argument den falschen Typ hat, lösen Sie einen TypeError aus. Zum Beispiel, wenn Sie einen String anstelle eines dieser Booleschen Werte erhalten.

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

Beachten Sie jedoch, dass wir in Python selten solche Überprüfungen durchführen. Wenn das Argument wirklich ungültig ist, wird wahrscheinlich eine tiefere Funktion die Beschwerde für uns erledigen. Und wenn wir nur den booleschen Wert überprüfen, füttert ihn möglicherweise ein Codebenutzer später einfach mit einer Zeichenfolge, da er weiß, dass nicht leere Zeichenfolgen immer True sind. Es könnte ihm eine Besetzung ersparen.

Wenn die Argumente ungültige Werte haben, erhöhen Sie ValueError. Dies scheint in Ihrem Fall angemessener zu sein:

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

Oder in diesem speziellen Fall bedeutet ein wahrer Wert für die Wiederholung einen wahren Wert für das Speichern. Da ich dies als Wiederherstellung nach einem Fehler betrachten würde, möchten Sie sich möglicherweise auch im Protokoll beschweren.

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

Ich bin nicht sicher , ich stimme mit Vererbung aus ValueError- meine Interpretation der Dokumentation ist , dass ValueErrorist nur angeblich von builtins angehoben werden ... von ihm erben oder erhöhen es selbst scheint falsch.

Wird ausgelöst, wenn eine integrierte Operation oder Funktion ein Argument mit dem richtigen Typ, aber einem unangemessenen Wert empfängt und die Situation nicht durch eine genauere Ausnahme wie IndexError beschrieben wird.

- ValueError-Dokumentation

Stimmen Sie dem Vorschlag von Markus zu, Ihre eigene Ausnahme zu rollen, aber der Text der Ausnahme sollte klarstellen, dass das Problem in der Argumentliste und nicht in den einzelnen Argumentwerten enthalten ist. Ich würde vorschlagen:

class BadCallError(ValueError):
    pass

Wird verwendet, wenn Schlüsselwortargumente fehlen, die für den jeweiligen Aufruf erforderlich waren, oder wenn Argumentwerte einzeln gültig sind, aber nicht miteinander übereinstimmen. ValueErrorwäre immer noch richtig, wenn ein bestimmtes Argument vom richtigen Typ ist, aber außerhalb des Bereichs liegt.

Sollte dies nicht eine Standardausnahme in Python sein?

Im Allgemeinen möchte ich, dass der Python-Stil etwas schärfer darin ist, schlechte Eingaben in eine Funktion (Fehler des Aufrufers) von schlechten Ergebnissen innerhalb der Funktion (mein Fehler) zu unterscheiden. Daher kann es auch einen BadArgumentError geben, um Wertfehler in Argumenten von Wertfehlern in Einheimischen zu unterscheiden.