<think>根据用户的问题，用户想了解TypedDict的使用方法。结合提供的引用内容，我们可以总结出TypedDict的基本概念、定义方式以及使用场景。下面将按照结构化的方式回答用户的问题，并参考引用中的示例。 ### 1. TypedDict的基本概念 TypedDict是Python类型系统中的一个工具，用于定义字典的固定结构。它允许开发者指定字典中必须包含的键以及每个键对应的值类型。这对于静态类型检查（如使用mypy）非常有用，可以确保代码中字典的使用符合预期的结构[^2]。 ### 2. 如何定义TypedDict TypedDict可以通过两种方式定义：使用类继承或使用函数语法。下面分别介绍。 #### 2.1 类继承方式 ```python from typing import TypedDict class Person(TypedDict): name: str age: int email: NotRequired[str] # 可选键 ``` #### 2.2 函数语法方式 ```python from typing import TypedDict Person = TypedDict('Person', { 'name': str, 'age': int, 'email': NotRequired[str] }) ``` ### 3. TypedDict的使用示例 #### 3.1 基本使用 ```python # 定义一个表示用户信息的TypedDict class User(TypedDict): id: int username: str is_active: NotRequired[bool] # 可选字段 # 创建一个符合User结构的字典 user1: User = { "id": 1, "username": "alice" } # 正确，is_active可选 user2: User = { "id": 2, "username": "bob", "is_active": True } # 正确 # 错误的示例：缺少必填字段 user3: User = { "id": 3 } # 错误，缺少username ``` #### 3.2 嵌套TypedDict 引用[1]中展示了嵌套TypedDict的用法： ```python class DatabaseConfig(TypedDict): host: str port: int class LoggingConfig(TypedDict): level: str class FullConfig(TypedDict): database: DatabaseConfig logging: LoggingConfig # 使用示例 config: FullConfig = { "database": { "host": "localhost", "port": 5432 }, "logging": { "level": "DEBUG" } } ``` ### 4. TypedDict与类型检查 TypedDict的主要优势在于静态类型检查。例如，使用mypy检查以下代码： ```python def print_person(person: Person) -> None: print(f"Name: {person['name']}, Age: {person['age']}") # 正确调用 print_person({"name": "Alice", "age": 30}) # 错误调用：缺少age字段 print_person({"name": "Bob"}) # mypy会报错 ``` ### 5. 可选字段（NotRequired） 在TypedDict中，可以使用`NotRequired`标记可选字段（Python 3.11+）。在早期版本中，可以使用`total=False`来实现部分键可选。 #### 5.1 使用NotRequired（推荐） ```python from typing import TypedDict, NotRequired class FileInfo(TypedDict): path: str is_dir: NotRequired[bool] size: NotRequired[int] ``` #### 5.2 使用total=False（旧版方式） ```python class FileInfo(TypedDict, total=False): path: str # 注意：在total=False模式下，所有键默认都是可选的，所以这里path也变成了可选 is_dir: bool size: int ``` ### 6. 与其他类型工具结合 引用[4]提到了与Pydantic的BaseModel结合使用的情况。TypedDict主要用于静态类型检查，而Pydantic的BaseModel则提供了运行时数据验证和序列化功能。两者可以结合使用，例如： ```python from pydantic import BaseModel class TimeRange(BaseModel): start_time: str end_time: str def to_dict(self) -> dict: return self.model_dump(by_alias=True, exclude_unset=True) ``` ### 7. 在LangGraph中的应用 引用[3]指出，在LangGraph框架中，TypedDict被用作状态管理的结构化蓝图，帮助定义智能体的记忆系统。例如： ```python class AgentState(TypedDict): memory: list current_task: str ``` ### 总结 TypedDict是Python中定义字典结构的强大工具，特别适合在需要静态类型检查的场景下使用。通过定义明确的键和值类型，可以提高代码的可读性和可靠性。 §§相关问题§§ 1. TypedDict和Pydantic的BaseModel有什么区别？ 2. 如何在Python 3.8以下版本使用TypedDict？ 3. 使用TypedDict时如何做运行时验证？ 4. 在FastAPI中如何使用TypedDict？ </think> ### TypedDict 使用方法详解 TypedDict 是 Python 类型系统中用于定义结构化字典的工具，可明确指定字典的键名、值类型及可选性。以下是具体使用方法及示例： --- #### 一、基础定义方式 通过继承 `TypedDict` 类并声明键值类型： ```python from typing import TypedDict, NotRequired # 定义嵌套结构（引用[1]示例） class DatabaseConfig(TypedDict): host: str port: int class LoggingConfig(TypedDict): level: str # 组合复杂结构 class FullConfig(TypedDict): database: DatabaseConfig # 嵌套其他TypedDict logging: LoggingConfig ``` --- #### 二、可选字段声明 使用 `NotRequired` 标记非必填字段（引用[2]示例）： ```python class FileInfo(TypedDict): path: str # 必填字段 is_dir: NotRequired[bool] # 可选字段 size: NotRequired[int] # 可选字段 ``` --- #### 三、实际使用示例 1. **创建符合类型的字典** 类型检查器（如 mypy）会验证结构合法性： ```python config: FullConfig = { "database": {"host": "127.0.0.1", "port": 3306}, "logging": {"level": "DEBUG"} } ``` 2. **处理可选字段** 可省略 `NotRequired` 标记的字段： ```python file_data: FileInfo = {"path": "/tmp/test.txt"} # 合法 ``` --- #### 四、高级技巧 1. **与 Pydantic 结合**（引用[4]） 实现运行时类型验证 + 序列化： ```python from pydantic import BaseModel class TimeRange(BaseModel): start_time: str end_time: str def to_dict(self) -> dict: return self.model_dump(by_alias=True, exclude_unset=True) ``` 2. **在状态管理中的应用**（引用[3]） 作为智能体记忆系统的结构化容器： ```python class AgentState(TypedDict): memory: list[str] current_task: str ``` --- #### 五、注意事项 1. **Python 版本要求** - Python ≥ 3.8 内置支持 - 旧版本可通过 `typing_extensions` 导入 2. **类型检查依赖** 需配合静态类型检查工具（如 mypy）生效： ```bash mypy your_script.py ``` 3. **运行时限制** TypedDict 仅提供**静态类型提示**，不会在运行时验证数据。若需运行时验证，需结合 Pydantic 等库。 ---