巧妙管理可能为 `None` 的值：`Optional` 使用指南

python

2024-03-06 18:32:32

用 Optional 巧妙管理可为 None 的值

简介

在 Python 中，管理可能为 None 的值至关重要。Optional 类型提示提供了简洁而强大的方法，可以明确表示变量或函数参数可以采用 None 值，从而提高代码的可读性、可维护性和鲁棒性。

`Optional` 与 `Union[type, None]` 的区别

乍一看，Optional 类型提示似乎与 Union[type, None] 表达式具有相似的语义。然而，两者在用法和语义上有微妙的差异：

Optional 是 Union[type, None] 的别名： 本质上，Optional 是 Union[type, None] 的简写，但它提供了一种更简洁、更清晰的方式来表达可为 None 的值。
Optional 强调语义： 使用 Optional 明确表示变量或参数可以是 None，而 Union[type, None] 更注重技术层面的细节。
Optional 具有更好的 IDE 支持： 某些 IDE（例如 PyCharm）为 Optional 提供了更好的支持，包括代码完成功能和类型检查。

何时使用 `Optional`

使用 Optional 的最佳时机是当你需要明确表示变量或参数可能为 None 时。这可以极大地提高代码的可读性和可维护性，并防止意外错误。

以下是使用 Optional 的一些典型场景：

函数参数或返回值可能为 None。
数据结构元素可能为 None。
数据库查询可能返回 None。

示例用法

以下是一些展示如何使用 Optional 的示例：

def get_user(user_id: Optional[int]) -> Optional[User]:
    """
    获取一个用户，如果用户不存在，则返回 None。

    参数：
        user_id: 用户的 ID，可以为 None。

    返回：
        如果用户存在，则返回一个 User 对象，否则返回 None。
    """
    user = User.query.get(user_id)
    return user

users = [user for user in users if user is not None]