python - 放入 Python 异常消息的详细信息量的约定？

Question

我正在尝试确定一些关于如何编写异常消息的指南。

例如，让我们假设一个假设的函数必须接收恒定数量的字节(作为 bytes 对象)，我们用 [1, 2, 3]。以下是所有可能的异常(exception)情况:

1. TypeError
2. TypeError: argument must be 16 bytes
3. TypeError: argument must be 16 bytes; got 'list'
4. TypeError: argument must be 16 bytes; got 'list' [1, 2, 3]

一般来说，我觉得消息应该始终解释未满足的条件，但我对包含多少有关违规对象的信息持观望态度。

有关于这个主题的指南吗？

Answer 1

好问题!

当我通常创建自定义异常时，我通常会查看通常详尽无遗的 Python 集。

现在关于提供多少细节的问题，我不会说得太具体，因为您不知道什么会触发或导致它们。

例如:

TypeError: unsupported operand type(s) for +: 'int' and 'str'

的描述性足以让我知道 + 运算符不受支持，我不需要知道字符串包含什么。

因此在您的示例中，前两个完全没问题，后两个在我看来是矫枉过正了。

祝你好运。