Welche Ausnahme sollte ich auf schlechte/illegale Argumentkombinationen in Python auslösen?

Question

Ich habe mich über die besten Praktiken für die Anzeige von ungültigen Argumentkombinationen in Python gewundert. Ich habe über ein paar Situationen kommen, wo Sie eine Funktion wie so 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 seine eigene, meist leicht abweichende BadValueError . Ich weiß, dass es in Java Folgendes gibt java.lang.IllegalArgumentException -- ist es klar, dass jeder seine eigene Website erstellen wird BadValueError s in Python oder gibt es eine andere, bevorzugte Methode?

Answer 1

Ich würde einfach erhöhen WertFehler es sei denn, Sie benötigen eine genauere 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 hat wirklich keinen Sinn, das zu tun. class BadValueError(ValueError):pass - Ihre benutzerdefinierte Klasse ist in der Verwendung identisch mit WertFehler Warum sollte man das also nicht nutzen?

Answer 2

Ich würde erben von ValueError

class IllegalArgumentError(ValueError):
    pass

Manchmal ist es besser, eigene Ausnahmen zu erstellen, aber von einer eingebauten Ausnahme zu erben, die dem, was Sie wollen, so nahe wie möglich kommt.

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

Answer 3

Ich denke, der beste Weg, dies zu behandeln ist die Art und Weise Python selbst behandelt es. 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 bei einer Google-Suche nach "python exception wrong arguments" gefunden und ich bin überrascht, dass die offensichtliche (für mich) Antwort in den zehn Jahren, seit diese Frage gestellt wurde, nicht vorgeschlagen wurde.

Answer 4

Es kommt darauf an, was das Problem mit den Argumenten ist.

Wenn das Argument den falschen Typ hat, wird ein TypeError ausgelöst. Zum Beispiel, wenn Sie eine Zeichenkette anstelle eines dieser Booleans 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 sich wahrscheinlich eine tiefere Funktion für uns beschweren. Und wenn wir nur den booleschen Wert prüfen, wird vielleicht ein Code-Benutzer später einfach eine Zeichenkette einfügen, weil er weiß, dass nicht leere Zeichenketten immer wahr sind. Das könnte ihm einen Cast ersparen.

Wenn die Argumente ungültige Werte haben, wird ValueError ausgelöst. 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, dass ein Wahr-Wert von recurse einen Wahr-Wert von save impliziert. Da ich dies als Wiederherstellung nach einem Fehler betrachten würde, sollten Sie sich vielleicht 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

Answer 5

Ich habe meistens nur die eingebauten ValueError in dieser Situation verwendet.