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

Pydantic RootModel 自定义行为:让根模型像原生列表一样使用

大杰吖_4161

大杰吖_4161

发布时间:2025-12-29 20:01:24

|

874人浏览过

|

来源于php中文网

原创

Pydantic RootModel 自定义行为:让根模型像原生列表一样使用

通过为 rootmodel 子类实现 `__iter__`、`__getitem__` 等魔术方法,可使其在保持类型安全的同时,支持 `foo.pets[0]`、`for pet in foo.pets` 等自然语法,避免冗余的 `.root` 访问。

在 Pydantic v2 中,RootModel 是处理“纯容器型”数据(如顶层 JSON 数组或字典)的推荐方式。但默认情况下,其数据始终封装在 .root 属性中——这虽保证了模型一致性,却牺牲了 Python 的惯用体验。例如:

from pydantic import RootModel, BaseModel
from typing import List

Pets = RootModel[List[str]]
class Foo(BaseModel):
    pets: Pets

foo = Foo(pets=Pets(['dog', 'cat']))
print(foo.pets.root)  # ✅ 可行但冗余
# print(foo.pets[0])  # ❌ AttributeError: 'Pets' object has no attribute '__getitem__'

要让 foo.pets 直接支持索引、迭代、解包等操作,只需继承 RootModel 并实现对应协议方法:

from typing import List, Iterator, Any
from pydantic import RootModel

class Pets(RootModel[List[str]]):
    def __iter__(self) -> Iterator[str]:
        return iter(self.root)

    def __getitem__(self, item: int | slice) -> str | List[str]:
        return self.root[item]

    def __len__(self) -> int:
        return len(self.root)

    def __contains__(self, item: str) -> bool:
        return item in self.root

    def __repr__(self) -> str:
        return f'Pets({self.root!r})'

# 现在可自然使用:
foo = Foo(pets=Pets(['dog', 'cat', 'bird']))
print(foo.pets[0])           # → 'dog'
print(len(foo.pets))         # → 3
print('cat' in foo.pets)     # → True
for pet in foo.pets:         # ✅ 支持 for 循环
    print(pet)
print(list(foo.pets))        # → ['dog', 'cat', 'bird']

关键优势

python全能编程助手
python全能编程助手

SkillSub Pro - Python 题解与代码注释双功能技能功能概述SkillSub Pro - Python 题解与代码注释双功能技能是一项面向实际任务的技能,主要用于SkillSub Pro 是一个 Python 题解生成与代码注释的 双功能合体技能 ,专为学生、算法学习者和开发者设计;✅ 一个技能,两种用途 :;核心要点📝 题解模式 :输入题目/题号,自动生成完整 Python 题解(含详细注释、解题思路、复杂度分析);💬 注释模式 :输入 Python 代码,自动添加详细中。它将相关步骤、

下载
  • 类型提示仍完全保留(IDE 和 mypy 均能正确推导 foo.pets 为 Pets,且 foo.pets[0] 为 str);
  • 序列协议兼容标准库函数(如 sorted()、list()、enumerate());
  • 无需修改现有模型结构,仅需一次封装即可提升 API 友好度。

⚠️ 注意事项

  • 不要重写 __init__ 或 model_dump() 等核心方法,除非有特殊需求;Pydantic 已自动处理序列化/验证逻辑;
  • 若需支持 +、* 等操作,可补充 __add__、__mul__,但需返回新 Pets 实例以保持不可变语义(推荐);
  • 避免在 __getitem__ 中返回 self.root[item] 以外的类型,否则会破坏类型一致性。

通过这种方式,你既遵守了 Pydantic 的建模规范,又赋予了模型原生容器的表达力——真正实现「类型安全」与「Pythonic 体验」的统一。

热门AI工具

更多
WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

1955

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2642

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

916

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2939

2025.09.10

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

20

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

0

2026.09.23

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

0

2026.09.23

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

0

2026.09.22

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

20

2026.09.22

热门下载

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

精品课程

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

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