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-誰もがBadValueErrorPythonで独自のを作成することはよく理解されていますか、それとも別の好ましい方法がありますか？

より具体的な例外が必要でない限り、私は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自体が処理する方法だと思います。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

私たちのジュニア開発者が「python例外の間違った引数」のグーグル検索でこのページを見つけただけで、この質問がされて以来、明白な（私にとって）答えが10年間提案されなかったことに驚いています。

私はほとんどの場合ValueError、この状況で使用されるビルトインを見てきました。

それは議論の問題が何であるかによる。

引数のタイプが間違っている場合は、TypeErrorを送出します。たとえば、これらのブール値の1つではなく文字列を取得した場合です。

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")

または、この特定のケースでは、recurseの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のドキュメント

独自の例外をロールするというMarkusの提案に同意しますが、例外のテキストは、問題が個々の引数値ではなく引数リストにあることを明確にする必要があります。私は提案します：

class BadCallError(ValueError):
    pass

特定の呼び出しに必要なキーワード引数が欠落している場合、または引数値が個別に有効であるが互いに矛盾している場合に使用されます。 ValueError特定の引数が正しい型であるが範囲外の場合でも、正しいでしょう。

これはPythonの標準の例外ではないのですか？

一般的に、関数への悪い入力（呼び出し側の障害）を関数内の悪い結果（私の障害）から区別する際に、Pythonスタイルを少しシャープにしたいと思います。したがって、引数の値エラーとローカルの値エラーを区別するためのBadArgumentErrorも存在する可能性があります。