【一分钟快学】提高 Python 3 代码质量：掌握 TypedDict 实现精确的类型安全字典

TypedDict，这是在Python 3.8版本中引入的，通过typing模块提供，用于创建具有固定键和各自类型值的字典类型。TypedDict使得静态类型检查器能够更准确地处理字典对象，从而为使用字典存储结构化数据的场景提供了类型安全。

TypedDict的核心内容

TypedDict允许开发者定义字典类型，这些字典的键是固定的，每个键对应的值也有固定的类型。这对于静态类型检查非常有用，因为它使得类型检查器可以确保代码中字典的使用与定义时预期的结构相匹配。

如何使用TypedDict

你可以通过继承TypedDict来定义一个类型化字典。例如，定义一个表示用户信息的类型化字典：

from typing import TypedDict

class User(TypedDict):
    name: str
    age: int
    is_active: bool

user: User = {
    "name": "John Doe",
    "age": 30,
    "is_active": True
}

在这个例子中，User是一个TypedDict，它期望有三个键：name（字符串类型）、age（整数类型）和is_active（布尔类型）。如果尝试添加不符合这个结构的键值对，或者给键赋予错误的类型的值，那么静态类型检查器（如mypy）会发出警告。

使用过程中需要注意的地方

1. 兼容性：尽管TypedDict在运行时不强制执行类型检查，但使用静态类型检查器时，确保遵循定义的类型约束很重要。
2. 不变性：默认情况下，TypedDict不支持标记为可选的键。如果需要可选键，可以使用total=False参数创建TypedDict的子类。
3. 动态字典操作：进行字典操作（如添加或删除键）时，可能会导致类型不匹配。尽管运行时不会报错，但这可能会影响静态类型检查的准确性。

代码示例：使用TypedDict的可选键

from typing import TypedDict, Optional

class User(TypedDict, total=False):
    name: str
    age: int
    email: Optional[str]

user: User = {
    "name": "Jane Doe",
    "age": 28
    # email 是可选的
}

在这个示例中，email字段被标记为可选（Optional[str]），这意味着在创建User类型的字典时可以不包含email键。

结论

TypedDict为Python中的字典类型提供了强类型支持，使得在使用字典来表示结构化数据时更加安全和清晰。在利用这一特性时，重要的是要确保遵循类型定义，并且在合适的场合使用静态类型检查工具来维护代码的类型安全性。