通过为 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 classPets(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']
✅ 关键优势:
⚠️ 注意事项:
通过这种方式,你既遵守了 Pydantic 的建模规范,又赋予了模型原生容器的表达力——真正实现「类型安全」与「Pythonic 体验」的统一。