Pengecualian mana yang harus saya ajukan pada kombinasi argumen buruk / ilegal dengan Python?

Saya bertanya-tanya tentang praktik terbaik untuk menunjukkan kombinasi argumen yang tidak valid dalam Python. Saya telah menemukan beberapa situasi di mana Anda memiliki fungsi seperti:

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

Satu-satunya gangguan dengan ini adalah bahwa setiap paket memiliki sendiri, biasanya sedikit berbeda BadValueError. Saya tahu bahwa di Jawa ada java.lang.IllegalArgumentException- apakah dipahami bahwa semua orang akan membuat sendiri BadValueErrordengan Python atau ada metode lain yang disukai?

Saya hanya akan meningkatkan ValueError , kecuali jika Anda memerlukan pengecualian yang lebih spesifik ..

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

Benar-benar tidak ada gunanya melakukan class BadValueError(ValueError):pass- kelas kustom Anda identik digunakan untuk ValueError , jadi mengapa tidak menggunakannya?

Saya akan mewarisi dari ValueError

class IllegalArgumentError(ValueError):
    pass

Terkadang lebih baik untuk membuat pengecualian Anda sendiri, tetapi mewarisi dari bawaan, yang sedekat mungkin dengan apa yang Anda inginkan.

Jika Anda perlu mengetahui kesalahan spesifik itu, sebaiknya memiliki nama.

Saya pikir cara terbaik untuk menangani ini adalah cara python sendiri menanganinya. Python memunculkan TypeError. Sebagai contoh:

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

Dev junior kami baru saja menemukan halaman ini di pencarian google untuk "argumen salah python exception" dan saya terkejut bahwa jawaban yang jelas (untuk saya) tidak pernah disarankan dalam dekade sejak pertanyaan ini diajukan.

Saya sebagian besar baru saja melihat builtin ValueErrordigunakan dalam situasi ini.

Itu tergantung pada apa masalahnya dengan argumen itu.

Jika argumen memiliki tipe yang salah, naikkan TypeError. Misalnya, ketika Anda mendapatkan string, bukan salah satu Boolean tersebut.

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

Perhatikan, bagaimanapun, bahwa dalam Python kita jarang melakukan pemeriksaan seperti ini. Jika argumen tersebut benar-benar tidak valid, beberapa fungsi yang lebih dalam mungkin akan melakukan komplain untuk kita. Dan jika kita hanya memeriksa nilai boolean, mungkin beberapa pengguna kode nantinya hanya akan memberinya string yang mengetahui bahwa string yang tidak kosong selalu Benar. Mungkin menyelamatkannya gips.

Jika argumen memiliki nilai yang tidak valid, naikkan ValueError. Ini tampaknya lebih sesuai untuk kasus Anda:

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

Atau dalam kasus khusus ini, memiliki nilai True recurse menyiratkan nilai True save. Karena saya akan menganggap ini sebagai pemulihan dari kesalahan, Anda mungkin juga ingin mengeluh dalam log.

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

Saya tidak yakin saya setuju dengan warisan dari ValueError- interpretasi saya dari dokumentasi adalah bahwa ValueErrorini hanya seharusnya dibesarkan oleh builtin ... mewarisi dari itu atau menaikkan sendiri sepertinya tidak benar.

Dibesarkan ketika operasi atau fungsi bawaan menerima argumen yang memiliki tipe yang tepat tetapi nilai yang tidak sesuai, dan situasinya tidak dijelaskan oleh pengecualian yang lebih tepat seperti IndexError.

- Dokumentasi ValueError

Setuju dengan saran Markus untuk melempar pengecualian Anda sendiri, tetapi teks pengecualian harus menjelaskan bahwa masalahnya ada dalam daftar argumen, bukan nilai argumen individual. Saya akan mengusulkan:

class BadCallError(ValueError):
    pass

Digunakan ketika argumen kata kunci hilang yang diperlukan untuk panggilan tertentu, atau nilai argumen secara individual valid tetapi tidak konsisten satu sama lain. ValueErrormasih akan benar ketika argumen tertentu adalah tipe yang benar tetapi di luar jangkauan.

Bukankah ini harus menjadi pengecualian standar dalam Python?

Secara umum, saya ingin gaya Python menjadi sedikit lebih tajam dalam membedakan input buruk ke fungsi (kesalahan pemanggil) dari hasil buruk dalam fungsi (kesalahan saya). Jadi mungkin juga ada BadArgumentError untuk membedakan kesalahan nilai dalam argumen dari kesalahan nilai di lokal.