0

0

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

碧海醫心

碧海醫心

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

|

854人浏览过

|

来源于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']

关键优势

Cliclic AI
Cliclic AI

Cliclic商品背景图编辑器是一款功能强大的AI工具,帮助用户快速生成具有吸引力的商品图背景。

下载
  • 类型提示仍完全保留(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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

25

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

44

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

177

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

50

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

92

2026.03.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号