Python中固定格式多类型Dict的正确类型提示方法及写法验证

原写法是否正确？ #

原写法不正确。Dict的泛型定义仅接受两个参数：Dict[KeyType, ValueType]，你传入四个类型参数的写法不符合语法规范，类型检查器（如mypy、Pyright）会直接报错。

如何为固定格式的多类型Dict添加类型提示？ #

针对键值格式固定、值类型多样的字典，Python提供了几种实用方案：

1. 使用TypedDict（推荐，Python 3.8+） #

TypedDict是专门为固定结构字典设计的类型提示工具，能明确标注每个键对应的具体值类型，类型检查器可精准识别结构。

示例代码：

from typing import List, TypedDict
# 假设CustomObject已在其他模块定义并导入
from your_module import CustomObject

class CargoEntry(TypedDict):
    ID: int
    cargo: List[CustomObject]

def some_func() -> List[CargoEntry]:
    my_list = [
        {"ID": 1, "cargo": [CustomObject(), CustomObject()]},
        {"ID": 2, "cargo": [CustomObject(), CustomObject()]},
        {"ID": 2, "cargo": [CustomObject(), CustomObject()]}
    ]
    return my_list

若需兼容Python 3.7及更低版本，可安装typing-extensions库，从typing_extensions导入TypedDict。

2. 使用NamedTuple #

如果偏好不可变的结构化数据，NamedTuple是合适的选择——它会生成轻量级类，兼具元组的不可变性与类的属性访问特性。

示例代码：

from typing import List, NamedTuple
from your_module import CustomObject

class CargoEntry(NamedTuple):
    ID: int
    cargo: List[CustomObject]

def some_func() -> List[CargoEntry]:
    my_list = [
        CargoEntry(ID=1, cargo=[CustomObject(), CustomObject()]),
        CargoEntry(ID=2, cargo=[CustomObject(), CustomObject()]),
        CargoEntry(ID=2, cargo=[CustomObject(), CustomObject()])
    ]
    return my_list

注：NamedTuple返回的是类实例而非字典，可通过._asdict()方法转换为标准字典。

3. 使用dataclasses（Python 3.7+） #

若需要可变的结构化数据，dataclasses提供了更灵活的类定义方式，支持默认值、自动生成特殊方法等特性。

示例代码：

from typing import List
from dataclasses import dataclass
from your_module import CustomObject

@dataclass
class CargoEntry:
    ID: int
    cargo: List[CustomObject]

def some_func() -> List[CargoEntry]:
    my_list = [
        CargoEntry(ID=1, cargo=[CustomObject(), CustomObject()]),
        CargoEntry(ID=2, cargo=[CustomObject(), CustomObject()]),
        CargoEntry(ID=2, cargo=[CustomObject(), CustomObject()])
    ]
    return my_list

dataclasses实例可通过dataclasses.asdict()方法转换为字典。

内容的提问来源于stack exchange，提问作者M.wol