带有异常的Python类型提示

Question

我有一个看起来像这样的函数：

def check_for_errors(result):
    if 'success' in result:
        return True

    if 'error' in result:
        raise TypeError

    return False

在成功运行此函数时，我应该得到一个bool，但是如果出现错误，我应该得到一个TypeError-可以，因为我在另一个函数中处理了它。

我的函数第一行看起来像这样：

def check_for_errors(result: str) -> bool:

我的问题是：我应该在类型提示中提及错误吗？

Answer 1

类型提示不能说任何有关异常的信息。它们完全超出了该功能的范围。但是，您仍然可以在文档字符串中记录异常。

从 PEP 484-类型提示 ：

例外情况

没有提出用于列出显式引发的异常的语法。当前，此功能的唯一已知用例是文档说明，在这种情况下，建议将此信息放入文档字符串中。

Guido van
Rossum强烈反对在类型提示规范中添加异常，因为他不想最终陷入需要在每个级别
检查 （在调用代码中处理）或显式声明异常的情况。