如何用Pydantic构建含可选sip字段及任意未知字段的模型？

完全可行，Pydantic通过配置extra参数可以轻松实现这个需求，既能保留明确定义的sip可选字段，又能兼容任意数量的未知字段，且解析、序列化都能正常工作。

Pydantic v2 实现代码 #

from pydantic import BaseModel
from typing import Optional, Dict

class MyModel(BaseModel):
    sip: Optional[Dict] = None
    
    # 允许模型接受并保留未定义的字段
    model_config = {"extra": "allow"}

# 测试解析包含sip和未知字段的JSON数据
sample_data = {
    "sip": {"param1": 1},
    "param2": 2,
    "custom_field": "任意值",
    "another_field": 3.14
}
model_instance = MyModel(**sample_data)

# 访问明确字段和未知字段
print(model_instance.sip)  # 输出: {'param1': 1}
print(model_instance.param2)  # 输出: 2
print(model_instance.custom_field)  # 输出: 任意值

# 序列化回JSON，保留所有字段
print(model_instance.model_dump_json(indent=2))

Pydantic v1 实现代码 #

如果还在使用Pydantic v1，配置方式略有不同：

from pydantic import BaseModel, Extra
from typing import Optional, Dict

class MyModel(BaseModel):
    sip: Optional[Dict] = None
    
    class Config:
        # 允许额外字段
        extra = Extra.allow

# 使用方式与v2一致
sample_data = {"param2": 2}  # 无sip字段的情况
model_instance = MyModel(**sample_data)
print(model_instance.sip)  # 输出: None
print(model_instance.dict())  # 序列化输出: {'sip': None, 'param2': 2}

核心要点 #

• 通过extra = "allow"（v2）或Extra.allow（v1）配置，让模型接受未定义的字段并将其作为实例属性保留
• sip字段声明为Optional[Dict]并设置默认值None，兼容JSON中不存在sip的场景
• 解析后的模型实例可以直接访问所有字段，序列化时会完整输出包括未知字段在内的所有数据

内容的提问来源于stack exchange，提问作者Anton Ovsyannikov