登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  python教程

Python TypedDict 怎样表达 JSON 对象的必填与可选键

来源:17golang原创

时间:2026-11-16 23:24:42 267浏览 收藏

如果一个 JSON 对象里的 id 必须存在,而 nickname 可以完全不返回,Python 的 TypedDict 应该把这两个约束写在键的类型标注上。最常见的写法是:普通 TypedDict 保持默认必填,再给可缺失的键包一层 NotRequired。

先记住一个容易混淆的结论:NotRequired[str] 表示键可能不存在;str | None 表示键存在时值允许是 None。它们描述的是两个不同维度。TypedDict 主要服务于静态类型检查,运行时仍然只是普通 dict,不会自动替你校验 JSON。

先定位问题:JSON 键是缺失,还是值为空

接口响应经常同时出现下面三种字段:

业务语义TypedDict 写法含义
必须返回用户编号id: int键不能省略
昵称可不返回nickname: NotRequired[str]键可以缺失,出现时是字符串
昵称始终返回但可能为空nickname: str | None键存在,值可以是字符串或 None
TypedDict 使用 NotRequired、total=False 和 Required 表达必填与可省略键的关系说明图
图1:TypedDict 中必填键与可省略键的静态关系说明图,不是运行截图。

普通 TypedDict:默认所有键都必填

不写 total 时,TypedDict 默认相当于 total=True。下面的 id 和 name 都要求出现在对象中,静态检查器会把缺少其中任意一个键视为错误。

from typing import TypedDict


class UserPayload(TypedDict):
    # 业务约定:用户编号和显示名都必须随响应返回。
    id: int
    name: str


user: UserPayload = {
    "id": 17,
    "name": "小周",
}

# 静态检查器会提示缺少 name,不要把它当成运行时校验。
incomplete: UserPayload = {"id": 17}

这里的“必填”是类型层面的要求。Python 解释器仍会创建普通字典,所以如果数据来自网络,边界层仍应根据实际协议做解析或校验;不要因为写了 TypedDict 就认为非法 JSON 会自动被拦截。

大多数键必填时,用 NotRequired 标记例外

接口详情对象通常是“核心字段必填,展示字段按权限或配置出现”。这时保持普通 TypedDict 的默认规则,只给确实可以省略的键加 NotRequired:

from typing import NotRequired, TypedDict


class UserPayload(TypedDict):
    # 这两个键缺少时,调用方无法识别用户。
    id: int
    name: str
    # 键可以不存在,但一旦存在就必须是字符串。
    nickname: NotRequired[str]


minimal: UserPayload = {"id": 17, "name": "小周"}
with_nickname: UserPayload = {
    "id": 17,
    "name": "小周",
    "nickname": "zhou",
}

NotRequired 只改变“键是否必须存在”,不改变出现之后的值类型。也就是说,nickname: NotRequired[str] 不等价于允许 nickname 为 None;如果接口会返回空值,应明确写成 NotRequired[str | None]。

大多数键可省略时,用 total=False 再恢复必填键

更新接口的补丁对象、筛选条件和可选查询参数往往只有一个定位字段必填,其余字段都可能不传。逐个写 NotRequired 反而不直观,可以把整个 TypedDict 设为 total=False,再用 Required 标出少数必填键。

from typing import Required, TypedDict


class UserPatch(TypedDict, total=False):
    # 补丁必须带 id,服务端据此找到目标用户。
    id: Required[int]
    # 下面的修改项可以按需选择,未出现表示不修改。
    name: str
    nickname: str | None


patch: UserPatch = {"id": 17, "nickname": None}

# 静态检查器会提示缺少 Required 的 id。
invalid_patch: UserPatch = {"name": "新名字"}

total=False 的含义是“默认所有键都可能缺失”,不是“所有值都可以是 None”。Required[int] 只把 id 的存在性恢复为必填,仍然要求它的值是整数。

不要把 Optional 当成可省略键

这是 TypedDict 最常见的误判。Optional[str] 的传统含义是 str | None,它描述值,不描述键。下面的写法要求 nickname 这个键存在,只是允许它的值为空:

from typing import NotRequired, TypedDict


class Profile(TypedDict):
    # 键始终存在,但接口可以用 None 表示没有昵称。
    nickname: str | None
    # 这个键可以完全不出现在 JSON 中。
    avatar: NotRequired[str]


profile: Profile = {"nickname": None}

if "avatar" in profile:
    # 先判断键存在,静态检查器才知道这里可以读取它。
    avatar_url = profile["avatar"]
else:
    # 缺失与存在但为 None 是两个业务分支。
    avatar_url = "默认头像"
JSON 键缺失与键存在但值为 None 的 TypedDict 语义对比图
图2:键缺失与键存在但值为 None 的对比说明图,不是运行截图。

如果业务确实允许“键可以省略,出现时也可以是空值”,组合两层语义即可:nickname: NotRequired[str | None]。读取时仍建议先用 "nickname" in payload 区分缺失,再处理值是否为 None。

交给静态检查器:错误要在编辑阶段暴露

Required 和 NotRequired 的主要价值在静态分析阶段。保存示例文件后,可以把它交给项目正在使用的检查器:

# 使用项目已固定版本的 mypy 检查 TypedDict 键约束。
python -m mypy typed_payload.py

# 如果项目使用 pyright,就用对应命令查看缺失键和错误类型。
pyright typed_payload.py

检查结果重点看两类问题:一是把缺少必填键的字典赋给 TypedDict;二是在没有先判断键存在时,直接读取 NotRequired 字段。前者是对象形状错误,后者是调用方没有处理“键可能缺失”的分支。

Python 版本兼容怎么处理

Required 和 NotRequired 在 Python 3.11 进入标准库 typing。如果项目需要兼容更早版本,通常使用 typing_extensions 提供的兼容实现,并保持类定义写法不变:

try:
    # Python 3.11 及以上优先使用标准库实现。
    from typing import NotRequired, Required, TypedDict
except ImportError:
    # 旧版本从 typing_extensions 获取同一套类型构造。
    from typing_extensions import NotRequired, Required, TypedDict


class Response(TypedDict):
    # 保持业务字段约束与 Python 小版本解耦。
    code: Required[int]
    message: NotRequired[str]

如果项目已经锁定最低 Python 版本,也可以直接统一从一个来源导入,避免团队成员在不同文件中混用。兼容包只解决类型构造的可用性,真正的 JSON 运行时解析仍需要项目自己的边界层。

一张表记住选择规则

需求写法静态含义
键必须存在,值是 Tkey: T普通 TypedDict 的默认行为
键可以缺失,出现时是 Tkey: NotRequired[T]可省略键
键必须存在,值是 T 或 Nonekey: T | None必填键 + 可空值
键可缺失且可空key: NotRequired[T | None]两个维度同时放宽
整体可省略但某键必须有TypedDict, total=False + Required[T]少数必填的补丁对象

常见问题

TypedDict 会在运行时拒绝缺少键的 JSON 吗?

不会。TypedDict 实例在运行时仍然是普通字典,必填与可省略主要交给静态类型检查器判断。需要运行时校验时,应在接收 JSON 的边界使用专门的解析或校验方案。

NotRequired[str] 和 Optional[str] 能互相替换吗?

不能。前者允许键缺失,后者允许键存在但值为 None。若两种情况都允许,应写成 NotRequired[str | None],并在读取前区分键是否存在。

为什么 total=False 还要写 Required?

因为 total=False 会把当前定义中的键默认视为可缺失。Required 用来恢复业务上必须存在的少数键,适合补丁或筛选参数这类结构。

Python 3.10 项目能直接从 typing 导入 NotRequired 吗?

为了兼容 Python 3.10 及更早版本,应从 typing_extensions 导入 TypedDict、Required 和 NotRequired,并把兼容包加入项目依赖。

总结

把 JSON 对象的约束拆成“键是否存在”和“值是否允许 None”之后,TypedDict 的选择就很清楚:默认写法表达必填键,NotRequired 表达可缺失键,total=False 适合整体可选的对象,Required 负责在其中恢复必填键。最后把检查交给 mypy 或 pyright,并在运行时边界单独处理不可信 JSON。

官方资料:https://docs.python.org/3/library/typing.html#typing.TypedDict;相关规范:https://peps.python.org/pep-0655/。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>