如何用mypy指定字典必须含特定键？类同TypeScript接口无需改类

当然可以！你完全不用把现有字典改成类，也不用修改那些到处都是的d["x"]代码——mypy的TypedDict就是专门解决这个问题的，它能实现类似TypeScript接口的效果，只做静态类型检查，完全不影响代码运行时的行为。

具体步骤： #

1. 定义TypedDict类型
   首先从typing模块导入TypedDict，然后定义一个描述你字典结构的类型，明确指定必须包含的键和对应的类型：

   from typing import TypedDict
   
   # 命名可以根据实际场景调整，比如UserDict、ConfigDict等
   class RequiredDict(TypedDict):
       x: int  # 替换成"x"键实际的类型，str、float、bool等都支持
   

   这个定义仅用于mypy的类型检查，运行时不会创建任何实际的类对象，你的字典还是原来的普通字典。

2. 更新函数的类型注解
   把函数参数里的dict换成你刚定义的RequiredDict：

   def f(d: RequiredDict) -> None:
       x = d["x"]
       print(x)
   

   这样mypy就会自动检查所有传入f的字典是否包含"x"键，并且键对应的值类型是否匹配。

效果示例： #

• 符合要求的调用（mypy无报错）：

  valid_data = {"x": 100, "extra_key": "optional"}  # TypedDict允许额外字段存在
  f(valid_data)
  

• 不符合要求的调用（mypy会抛出明确错误）：

  invalid_data = {"y": 200}  # 缺少"x"键
  f(invalid_data)
  # mypy错误提示：Missing key "x" for TypedDict "RequiredDict"
  

额外说明： #

• 如果你的Python版本低于3.8，需要先安装typing_extensions包，然后从typing_extensions导入TypedDict（3.8及以上版本直接用typing里的即可）。
• 如果你需要允许某些键是可选的，可以在定义TypedDict时加上total=False参数，但你的场景只需要强制"x"存在，默认的total=True（可省略）就刚好合适。

这个方案完美适配你的需求——不用动现有业务代码，只需要添加类型注解就能让mypy帮你守住字典结构的规则。

内容的提问来源于stack exchange，提问作者Daniel Kats