如何将TypedDict定义自动转换为dataclass定义？

核心思路是利用Python的反射机制，提取TypedDict类的字段和类型信息，动态生成对应的dataclass。下面是具体的实现方案：

基础版：快速实现核心功能 #

TypedDict类会把所有字段和类型存储在__annotations__属性里，我们可以直接用dataclasses.make_dataclass函数动态创建dataclass：

from typing_extensions import TypedDict
from dataclasses import make_dataclass

def converter(typed_dict_cls, dataclass_name=None):
    # 自动生成dataclass类名，也支持用户自定义
    cls_name = dataclass_name or f"DataClass{typed_dict_cls.__name__}"
    # 提取TypedDict的字段与类型
    fields = list(typed_dict_cls.__annotations__.items())
    # 动态创建dataclass，默认开启init、不冻结
    return make_dataclass(cls_name, fields, init=True, frozen=False)

# 测试使用
class Square(TypedDict):
    l: float

DataClassSquare = converter(Square)
# 实例化测试
square = DataClassSquare(l=2.5)
print(square)  # 输出: DataClassSquare(l=2.5)

进阶版：支持继承与dataclass参数 #

如果你的TypedDict有继承关系，或者需要自定义dataclass的属性（比如冻结、关键字参数），可以优化一下：

def collect_all_annotations(typed_dict_cls):
    """递归收集所有父类的字段注解"""
    annotations = {}
    # 按继承顺序倒序遍历，保证子类字段覆盖父类
    for cls in reversed(typed_dict_cls.__mro__):
        if hasattr(cls, '__annotations__'):
            annotations.update(cls.__annotations__)
    # 清理掉object类自带的属性
    for key in ['__module__', '__dict__', '__weakref__']:
        annotations.pop(key, None)
    return annotations

def converter(typed_dict_cls, dataclass_name=None, **dataclass_kwargs):
    cls_name = dataclass_name or f"DataClass{typed_dict_cls.__name__}"
    all_annotations = collect_all_annotations(typed_dict_cls)
    fields = list(all_annotations.items())
    # 支持传递dataclass的配置参数，比如frozen、kw_only等
    return make_dataclass(cls_name, fields, **dataclass_kwargs)

# 测试继承场景
class Shape(TypedDict):
    color: str

class Square(Shape):
    l: float

# 创建冻结的dataclass
DataClassSquare = converter(Square, frozen=True)
square = DataClassSquare(l=3.0, color="red")
print(square)  # 输出: DataClassSquare(color='red', l=3.0)

高级版：处理可选字段 #

如果你的TypedDict用了total=False（部分字段可选），可以把这些可选字段转换成dataclass里带默认值的字段：

def converter_with_optional(typed_dict_cls, dataclass_name=None, **dataclass_kwargs):
    cls_name = dataclass_name or f"DataClass{typed_dict_cls.__name__}"
    all_annotations = collect_all_annotations(typed_dict_cls)
    fields = []
    
    # 处理必填字段
    for key in typed_dict_cls.__required_keys__:
        fields.append((key, all_annotations[key]))
    
    # 处理可选字段，默认值设为None（可根据需求修改）
    for key in typed_dict_cls.__optional_keys__:
        fields.append((key, all_annotations[key], None))
    
    return make_dataclass(cls_name, fields, **dataclass_kwargs)

# 测试可选字段场景
class Square(TypedDict, total=False):
    l: float
    color: str

DataClassSquare = converter_with_optional(Square)
# 可以不传可选字段
square = DataClassSquare(l=4.0)
print(square)  # 输出: DataClassSquare(l=4.0, color=None)

注意事项 #

• TypedDict的__required_keys__和__optional_keys__是Python 3.8+才有的属性，低版本可能需要用typing_extensions兼容
• 如果TypedDict里有复杂类型（比如嵌套TypedDict），转换后的dataclass字段类型会保留，你可以嵌套调用converter处理嵌套结构

内容的提问来源于stack exchange，提问作者Charbel-Raphael Segerie