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

小强小哥_3757

小强小哥_3757

2026-11-05

485人浏览

原创

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 Hardener
Python Hardener

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

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

注意点:

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

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

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

示例:

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 <p></p>

说明:

  • 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 友好”的纯数据契约场景

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

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python python 3.11

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1871

4

python能做什么
python能做什么

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

2023.07.25

5104

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30717

23

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

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

2023.08.04

3647

5

python eval
python eval

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

2023.08.04

3667

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2843

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程