高阶Python｜返回类型提示技巧 (1)

引言

Python提供了一种可选的特性——类型提示，它有助于提高代码的可读性、可推理性和可调试性。通过类型提示，开发者能够清楚地了解变量、函数参数和返回值应具备的数据类型。在开发那些需要高度灵活性的应用程序时，您可能会需要为代码指定多种可能的返回类型，这样做可以使您的程序更加健壮，更能适应多变的运行环境。

在实际开发中，您可能会碰到需要在Python函数中标注多种返回类型的情况。这意味着函数返回的数据类型不是单一的，而是多样的。本文^[1]将通过实例向您展示，如何为一个从电子邮件地址中解析出域名的函数定义多种可能的返回类型。同时，您还将学习到如何为那些接受函数作为参数或者作为回调的函数添加类型提示。通过这些示例，您将能够更自如地在函数式编程中使用类型提示。

处理单一数据项的多种类型

在本节中，您将了解如何为可能返回多种类型数据的函数添加类型提示。考虑使用多种返回类型的情境包括：

• 条件判断：当函数通过条件判断返回不同类型结果时，您可以利用类型提示来指明函数可能返回的多种类型。
• 可选返回值：有时函数可能不返回任何值，这时您可以用类型提示来标明偶尔的无返回值情况。
• 异常处理：如果函数运行中遇到错误，您可能希望返回一个特定的错误对象，这与正常返回结果的类型不同。这样可以帮助其他开发者更好地在代码中处理异常。
• 代码灵活性：在设计和编写代码时，我们通常追求代码的通用性、灵活性和可复用性。这可能意味着编写能够适应多种数据类型的函数。在类型提示中明确这一点，有助于其他开发者理解代码的适用范围及其在不同情境下的预期使用。

以下示例展示了如何在处理条件判断时使用类型提示。设想您正在处理客户数据，需要编写一个函数来解析用户电子邮件地址以抽取用户名。

在Python 3.10或更新版本中，若要使用类型提示来表示多种可能类型的单一数据项，您可以使用管道符（|）。例如，在一个通常返回用户名字符串的函数中，如果电子邮件地址不完整，函数也可能返回None，您可以这样使用类型提示：

def parse_email(email_address: str) -> str | None:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username
    return None

在上面的示例中，parse_email() 函数有一个条件语句，用于检查作为参数传递的电子邮件地址是否包含 at 符号 (@)。如果是，则该函数会对该符号进行拆分，以提取 at 符号之前和之后的元素，将它们存储在局部变量中，并返回用户名。如果参数不包含 at 符号，则返回值为 None，表示电子邮件地址无效。

因此，该函数的返回值要么是包含用户名的字符串，要么是 None（如果电子邮件地址不完整）。返回值的类型提示使用管道运算符 (|) 来指示函数返回的单个值的替代类型。要在早于 3.10 的 Python 版本中定义相同的函数，您可以使用替代语法：

from typing import Union

def parse_email(email_address: str) -> Union[str, None]:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username
    return None

此函数使用打字模块中的 Union 类型来指示 parse_email() 返回字符串或 None，具体取决于输入值。无论您使用旧语法还是新语法，联合类型提示都可以组合两种以上的数据类型。

处理多种类型的多个数据项

在某些情况下，函数可能会返回多个值。在Python中，您可以通过类型提示来表明这一点。您可以利用元组来指明函数一次性返回的每个数据项的类型。如果您使用的是Python 3.9或更高版本，可以直接使用内置的元组结构。对于旧版本的Python，您需要在类型注释中使用typing.Tuple。

设想您希望在之前的例子上进一步发展。您想要声明一个函数，它不仅返回从电子邮件地址解析出的用户名，还希望同时返回域名。

以下是您如何使用类型提示来指明该函数返回一个元组，其中包含用户名的字符串和域名的字符串：

def parse_email(email_address: str) -> tuple[str, str] | None:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username, domain
    return None

该函数返回的是一个包含两个字符串的元组，这两个字符串分别代表电子邮件地址的用户名和域名。如果输入值不是一个有效的电子邮件地址，则函数会返回None。

类型提示中的返回值是一个用方括号括起来的元组，其中包含两个用逗号分隔的字符串类型元素。这表明元组中恰好有两个元素，且这两个元素都是字符串类型。紧接着的管道符（|）和None表示，函数的返回值可能是一个包含两个字符串的元组，或者在输入值无效时返回None。

对于Python 3.10之前的版本，您可以使用typing模块中的Tuple和Union类型来实现这个函数。

from typing import Tuple, Union

def parse_email(email_address: str) -> Union[Tuple[str, str], None]:
    if "@" in email_address:
        username, domain = email_address.split("@")
        return username, domain
    return None

这种表示法稍微冗长一些，需要从打字模块导入两种额外的类型。另一方面，您可以在较旧的 Python 版本中使用它。

定义一个接受回调函数的函数

在Python等编程语言中，函数不仅可以执行操作，还可以返回其他函数或者接受函数作为参数，这类函数被称为高阶函数，是函数式编程中非常有用的工具。要对可调用对象进行类型提示，可以使用collections.abc模块中的Callable类型。

高阶函数的一种常见形式是它接受一个回调函数作为参数。Python中的内置函数，如sorted()、map()和filter()，都允许传入一个回调函数，并将其连续应用于元素序列。这种高阶函数的使用减少了显式循环的编写，更符合函数式编程的风格。

以下是一个自定义的示例函数，它接受一个可调用对象作为参数，并展示了如何对其进行类型提示的注释：

>>> from collections.abc import Callable

>>> def apply_func(
...     func: Callable[[str], tuple[str, str]], value: str
... ) -> tuple[str, str]:
...     return func(value)
...
>>> def parse_email(email_address: str) -> tuple[str, str]:
...     if "@" in email_address:
...         username, domain = email_address.split("@")
...         return username, domain
...     return "", ""
...
>>> apply_func(parse_email, "claudia@realpython.com")
('claudia', 'realpython.com')

上述的第一个函数 apply_func()，它的第一个参数是一个可调用对象，第二个参数是一个字符串。这个可调用对象可能是一个普通函数、一个匿名函数（lambda表达式），或者是一个实现了特殊调用方法.call()的自定义类。这个函数的功能是返回两个字符串组成的元组。

在 Callable 类型提示中，通过方括号定义了两个参数：第一个参数是输入函数所接受的参数列表，这里 func() 只接受一个字符串类型的参数；第二个参数是函数的返回类型，这里是一个包含两个字符串的元组。

代码示例中的 parse_email() 函数是对之前总是返回字符串元组的函数的改进版本。

接着，您通过将 parse_email() 作为第一个参数，将 "claudia@realpython.com" 作为第二个参数来调用 apply_func()。apply_func() 随后会调用您提供的函数，并携带给定的参数，然后将结果返回给您。

如果您希望 apply_func() 能够接受具有多种输入参数和多种返回类型的不同函数，您可以对 Callable 类型提示的参数进行修改，使其更加泛化。

您可以使用省略号 (...) 来表示函数可以接受任意数量的参数，而不是列出具体的参数类型。同时，您可以使用 typing 模块中的 Any 类型来表明函数可以接受任何类型的返回值。

更进一步，您可以使用类型变量来建立可调用对象的返回类型与 apply_func() 的返回类型之间的联系。

这两种方法都仅对所讨论的函数的返回类型进行类型提示。以下是按照这种方式更新之前例子的示例：

from collections.abc import Callable
from typing import Any, TypeVar

T = TypeVar("T")

def apply_func(func: Callable[..., T], *args: Any, **kwargs: Any) -> T:
    return func(*args, **kwargs)

请注意，您已经使用省略号 (...) 作为 Callable 类型提示中方括号内的第一个元素，这意味着被输入的函数可以接受任意数量和类型的参数。

Callable 类型提示的第二个参数现在是一个类型变量 T，它可以代表任何数据类型。由于您也将 T 用作 apply_func() 的返回类型，这表明 apply_func() 的返回类型与传入的 func 函数的返回类型是一致的。

考虑到传递给 apply_func() 的可调用对象可以接受任意数量的参数，甚至是没有参数，您可以使用 *args 和 **kwargs 来表达这一点，这在 Python 中是一种常见的做法，用于表示函数可以接受不确定数量的参数。

Reference

[1]

Source: https://realpython.com/python-type-hints-multiple-types/

本文由 mdnice 多平台发布