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 强烈反对在类型提示规范中添加例外，因为他不希望最终陷入需要检查异常（在调用代码中处理）或在每个级别显式声明的情况。

Answer 2

将异常路径作为函数类型注释的一部分是有充分理由的，至少在某些情况下是这样。它只是在您需要了解调用者必须处理哪些异常时，从类型检查器中为您提供更多帮助。 （如果您有兴趣进行更深入的分析，我写了 一篇关于此的博客文章。）

由于指示函数引发哪些异常超出了 Python 类型系统的范围（例如，在 Java 中），我们需要一个解决方法来获得 这。我们可以返回异常，而不是引发异常。这样，异常就成为函数签名的一部分，调用者必须利用类型检查器的强大功能来处理它。

以下代码的灵感来自Rust 中完成异常处理的方式< /a>：它提供一个 Result 类型，可以是 Ok 或 Err。 Ok 和 Err 类都有一个 unwrap() 函数，该函数返回包装的值或引发包装的异常。

from typing import Generic, TypeVar, NoReturn


OkType = TypeVar("OkType")
ErrType = TypeVar("ErrType", bound=Exception)


class Ok(Generic[OkType]):
    def __init__(self, value: OkType) -> None:
        self._value = value

    def unwrap(self) -> OkType:
        return self._value


class Err(Generic[ErrType]):
    def __init__(self, exception: ErrType) -> None:
        self._exception = exception

    def unwrap(self) -> NoReturn:
        raise self._exception


Result = Ok[OkType] | Err[ErrType]

Result 是一个 Generic，它有两种类型：Ok 值的类型和 Err 值的类型代码 > 异常。这里将其应用于您的示例：

def check_for_errors(result: list[str]) -> Result[bool, TypeError]:
    if 'success' in result:
        return Ok(True)

    if 'error' in result:
        return Err(TypeError())

    return Ok(False)


def careful_method(result: list[str]):
    r = check_for_errors(result)  
    # Now, typechecker knows that r is `Result[bool, TypeError]`
    if isinstance(r, Err):
         # implement the error handling
    else:
         # implement the happy path

# If you do not want to handle the exception at this stage 
def careless_method(result: list[str]):
    check_for_errors(result).unwrap()

这只是一个粗略的代码草图，用于演示原理。实际上有一个更复杂的库，poltergeist，如果您考虑遵循这种方法，我建议您使用它。

Answer 3

记录错误通常是个好主意。这意味着使用您的函数的其他开发人员将能够处理您的错误，而无需阅读您的代码。

Answer 4

您可以使用NoReturn：
https://peps.python.org/pep-0484/#the- noreturn-type

from typing import NoReturn

def stop() -> NoReturn:
    raise RuntimeError('no way')

或者这样：

from typing_extensions import NoReturn

def stop() -> NoReturn:
    raise RuntimeError('no way')