Tôi nên đưa ra ngoại lệ nào đối với các kết hợp đối số xấu / bất hợp pháp trong Python?

Tôi đã tự hỏi về các thực tiễn tốt nhất để chỉ ra các kết hợp đối số không hợp lệ trong Python. Tôi đã gặp một vài tình huống trong đó bạn có một chức năng như vậy:

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

Khó chịu duy nhất với điều này là mọi gói đều có cái riêng, thường hơi khác nhau BadValueError. Tôi biết rằng trong Java tồn tại java.lang.IllegalArgumentException- có hiểu rõ rằng mọi người sẽ tạo ra BadValueErrors của riêng họ trong Python hoặc có một phương thức ưa thích khác không?

Tôi sẽ chỉ tăng ValueError , trừ khi bạn cần một ngoại lệ cụ thể hơn ..

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

Thực sự không có điểm nào trong việc thực hiện class BadValueError(ValueError):pass- lớp tùy chỉnh của bạn giống hệt với ValueError , vậy tại sao không sử dụng nó?

Tôi sẽ thừa hưởng từ ValueError

class IllegalArgumentError(ValueError):
    pass

Đôi khi tốt hơn là tạo ra các ngoại lệ của riêng bạn, nhưng kế thừa từ một tích hợp sẵn, gần với những gì bạn muốn nhất có thể.

Nếu bạn cần phải bắt lỗi cụ thể đó, thật hữu ích khi có một cái tên.

Tôi nghĩ cách tốt nhất để xử lý việc này là cách con trăn tự xử lý nó. Python tăng TypeError. Ví dụ:

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

Nhà phát triển cơ sở của chúng tôi vừa tìm thấy trang này trong một tìm kiếm của Google về "đối số sai ngoại lệ python" và tôi ngạc nhiên rằng câu trả lời rõ ràng (với tôi) đã không được đề xuất trong thập kỷ kể từ khi câu hỏi này được hỏi.

Tôi hầu như chỉ thấy nội dung ValueErrorđược sử dụng trong tình huống này.

Nó phụ thuộc vào vấn đề với các đối số là gì.

Nếu đối số có loại sai, hãy nâng TypeError. Ví dụ: khi bạn nhận được một chuỗi thay vì một trong các Booleans đó.

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

Tuy nhiên, lưu ý rằng trong Python chúng tôi hiếm khi thực hiện bất kỳ kiểm tra nào như thế này. Nếu đối số thực sự không hợp lệ, một số chức năng sâu hơn có thể sẽ làm phàn nàn cho chúng ta. Và nếu chúng ta chỉ kiểm tra giá trị boolean, có lẽ một số người dùng mã sau này sẽ cung cấp cho nó một chuỗi biết rằng các chuỗi không trống luôn luôn là True. Nó có thể cứu anh ta một diễn viên.

Nếu các đối số có giá trị không hợp lệ, hãy nâng cao ValueError. Điều này có vẻ phù hợp hơn trong trường hợp của bạn:

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

Hoặc trong trường hợp cụ thể này, có giá trị True của recurse ngụ ý giá trị True của tiết kiệm. Vì tôi sẽ coi đây là sự phục hồi từ một lỗi, bạn cũng có thể muốn khiếu nại trong nhật ký.

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

Tôi không chắc chắn tôi đồng ý với việc thừa kế từ ValueError- cách giải thích của tôi về tài liệu ValueErrornày chỉ được cho là được xây dựng bởi các nội dung ... kế thừa từ nó hoặc tự nâng cao nó có vẻ không chính xác.

Được nâng lên khi một hoạt động hoặc hàm tích hợp nhận được một đối số có loại đúng nhưng giá trị không phù hợp và tình huống không được mô tả bằng một ngoại lệ chính xác hơn như IndexError.

- Tài liệu ValueError

Đồng ý với đề xuất của Markus để đưa ra ngoại lệ của riêng bạn, nhưng văn bản của ngoại lệ sẽ làm rõ rằng vấn đề nằm trong danh sách đối số, không phải các giá trị đối số riêng lẻ. Tôi muốn đề xuất:

class BadCallError(ValueError):
    pass

Được sử dụng khi thiếu đối số từ khóa được yêu cầu cho cuộc gọi cụ thể hoặc giá trị đối số là hợp lệ riêng lẻ nhưng không nhất quán với nhau. ValueErrorvẫn sẽ đúng khi một đối số cụ thể là loại đúng nhưng nằm ngoài phạm vi.

Đây có phải là một ngoại lệ tiêu chuẩn trong Python không?

Nói chung, tôi muốn kiểu Python sắc nét hơn một chút trong việc phân biệt các đầu vào xấu với một hàm (lỗi của người gọi) với các kết quả xấu trong hàm (lỗi của tôi). Vì vậy, cũng có thể có một BadArgumentError để phân biệt lỗi giá trị trong các đối số với lỗi giá trị ở địa phương.