使用 Pydantic `create_model` 验证嵌套字典

Question

我正在使用 create_model 来验证一个配置文件，该文件会遇到许多嵌套的字典。在下面的示例中，我可以验证除日出和日落的最后一个巢穴之外的所有内容。

class System(BaseModel):

    data: Optional[create_model('Data', type=(str, ...), daytime=(dict, ...))] = None

try:
    p = System.parse_obj({
        'data': {
            'type': 'solar',
            'daytime': {
                'sunrise': 5,
                'sunset': 10
            }
        }})

    print(p.dict())
    vals = p.dict()
    print(vals['data']['daytime'], type(vals['data']['daytime']['sunrise']))

except ValidationError as e:
    print(e)

我如何在 create_model 中合并嵌套字典并确保日出和日落得到验证，或者是否有其他方法来验证这一点。 ？

感谢您的反馈。

Answer 1

目前尚不清楚您要实现的目标，所以这是我最好的猜测：

pydantic's create_model（） 是在使用时使用

直到运行时才知道模型的形状。

从您的代码中，尚不清楚这是否真的有必要。

这就是我要处理的方式。

（下面的代码使用Python 3.9及以上类型提示。如果您使用的是较早版本，则可能必须替换list typing.list 和>使用键入。dict.dict。）

使用“静态”模型，

from pydantic import BaseModel, create_model
from typing import Optional

class Data(BaseModel):
    type: str
    daytime: dict[str, int] # <- explicit types in the dict, values will be coerced

class System(BaseModel):
    data: Optional[Data]

system = {
    "data": {
        "type": "solar",
        "daytime": {
            "sunrise": 1,
            "sunset": 10
        }
    }
}

p = System.parse_obj(system)
print(repr(p))
# System(data=Data(type='solar', daytime={'sunrise': 1, 'sunset': 10}))

这将在daytime中接受整数，而不是其他类型，例如字符串。

这意味着，类似的事情：

system = {
    "data": {
        "type": "solar",
        "daytime": {
            "sunrise": "some string",
            "sunset": 10
        }
    }
}

p = System.parse_obj(system)

将失败：

pydantic.error_wrappers.ValidationError: 1 validation error for System
data -> daytime -> sunrise
  value is not a valid integer (type=type_error.integer)

如果您想对“白天”进行更多控制，则可以为其创建一个附加模型，例如：

class Daytime(BaseModel):
    sunrise: int
    sunset: int

class Data(BaseModel):
    type: str
    daytime: Daytime

class System(BaseModel):
    data: Optional[Data]

这将如上所述，但是只有参数Sunrise和Sunset才会被解析，并且可能在“ Daytime”内的其他所有内容都将被忽略（默认情况下）。

使用“动态”模型，

如果您确实需要动态创建模型，则可以使用类似的方法：

class System(BaseModel):
    data: Optional[
        create_model(
            "Data",
            type=(str, ...),
            daytime=(dict[str, int], ...), # <- explicit types in dict
        )
    ] = None

system = {
    "data": {
        "type": "solar",
        "daytime": {
            "sunrise": 1,
            "sunset": 10
        }
    }
}

p = System.parse_obj(system)
print(repr(p))

将有效，而

system = {
    "data": {
        "type": "solar",
        "daytime": {
            "sunrise": "abc",
            "sunset": 10
        }
    }
}

p = System.parse_obj(system)

将失败

pydantic.error_wrappers.ValidationError: 1 validation error for System
data -> daytime -> sunrise
  value is not a valid integer (type=type_error.integer)