讲师中心 微信公众号
AI工具推荐 视频效率加速

怎么在Python 3.11中用typing.TypedDict校验字典?

小强小哥_3757

小强小哥_3757

发布时间:2026-11-05 11:23:28

|

485人浏览过

|

来源于php中文网

原创

TypedDict 仅在类型检查阶段生效,运行时不校验字典结构;Python 3.11+ 支持 Required/NotRequired 标注可选字段,但依然不影响运行时;需运行时校验应使用 pydantic、dataclasses 或手动验证。

怎么在python 3.11中用typing.typeddict校验字典?

TypedDict 不是运行时校验工具,它只在类型检查阶段起作用

直接用 TypedDict 定义类,Python 解释器在运行时完全不检查字典结构——哪怕你传个空字典、缺字段、多字段、类型全错,代码照样执行成功。它只对 mypy、pylance、pyright 这类类型检查器生效。

常见错误现象:my_dict: MyDict = {"name": 123} 在 VS Code 里标红(类型检查报错),但 python script.py 仍能跑通,毫无异常。

  • 如果你需要运行时校验,得额外用 pydantic、dataclasses 或手写验证逻辑
  • TypedDict 的核心价值是让 IDE 补全字段、提前暴露拼写错误和类型不匹配
  • Python 3.11 开始支持 Required 和 NotRequired,但它们也仅影响类型检查,不改变运行时行为

定义 TypedDict 时怎么标注可选字段(Python 3.11+)

3.11 引入了 typing.Required 和 typing.NotRequired,替代旧版的字符串注释写法(如 "age?: int" 已弃用)。

示例:

立即学习“Python免费学习笔记(深入)”;

from typing import TypedDict, Required, NotRequired
<p>class User(TypedDict):
name: str
age: Required[int]      # 必填字段(默认行为,可省略 Required[])
email: NotRequired[str] # 可选字段:可以不存在,存在则必须是 str

注意点:

  • NotRequired 字段在字典中可以完全缺失,也可以为 None(除非你额外限制非空)
  • 如果字段类型本身是 Optional[str],表示“可为 None”,和 NotRequired[str](可完全不存在)语义不同
  • 混合使用时,NotRequired 字段必须放在所有 Required 字段之后(否则 mypy 报错)

运行时想真正校验字典?得自己加一层判断

没有银弹。最轻量的做法是写个校验函数,配合 TypedDict 的 __annotations__ 和 __required_keys__ / __optional_keys__ 属性(Python 3.11+ 支持)。

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载

示例:

立即学习“Python免费学习笔记(深入)”;

def validate_user(d: dict) -> User:
    required = User.__required_keys__
    optional = User.__optional_keys__
    keys = set(d.keys())
<pre class="brush:php;toolbar:false;">if not keys >= required:
    missing = required - keys
    raise ValueError(f"Missing required keys: {missing}")

if not keys <= (required | optional):
    extra = keys - (required | optional)
    raise ValueError(f"Unexpected keys: {extra}")

# 类型粗检(仅基础类型,不递归)
for k, v in d.items():
    annot = User.__annotations__[k]
    if not isinstance(v, annot.__args__[0] if hasattr(annot, '__args__') else annot):
        raise TypeError(f"Field {k} expected {annot}, got {type(v).__name__}")
return d  # type: ignore

说明:

  • User.__required_keys__ 和 User.__optional_keys__ 是 Python 3.11 新增的只读属性,返回 frozenset
  • 这个函数不处理嵌套 TypedDict 或泛型,复杂场景建议换 pydantic.BaseModel
  • 别依赖 isinstance(d, User) —— 它永远返回 False,因为 TypedDict 不是运行时类型

和 pydantic BaseModel 混用要注意什么

很多人想“既用 TypedDict 做类型提示,又用 pydantic 做运行时校验”,但二者字段定义方式不兼容。

典型坑:

  • TypedDict 中的 NotRequired[str] ≠ pydantic.Field(default=None):前者允许字段缺失,后者要求字段存在且可为 None
  • pydantic v2 的 model_validate 不接受纯 TypedDict 类型作为目标,需显式用 model_validate(dict_data)
  • 如果只想要类型提示 + 校验,直接用 pydantic.BaseModel 更省事;TypedDict 真正适合的是“零运行时开销 + IDE 友好”的纯数据契约场景

字段定义差异大,硬凑容易两边都失效。选一个主力,别指望自动互通。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1871

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5104

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1809

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

30717

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3647

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3667

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1243

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn