使用pydantic生成动态模型

Question

我正在尝试使用Python的pydantic库创建一个动态模型。我的输入数据是一个常规的dict。但是，dict的内容(读取:其密钥)可能会有所不同。

我想知道如何动态创建一个依赖于dict内容的pydantic模型？

我用两个不同的dict (inputs1和inputs2)创建了一个玩具示例。让我们假设名为strategy的嵌套dict可能不同。基于strategy/name，我提前知道strategy中将存在哪些字段。我需要创建基于strategy/name的pydantic模型。

from pydantic import BaseModel

inputs1 = {
    "universe": {"name": "test_universe", "ccy": "USD"},
    "price_src": "csv",
    "strategy": {"name": "test_strat1"},
}
inputs2 = {
    "universe": {"name": "test_universe", "ccy": "USD"},
    "price_src": "csv",
    "strategy": {"name": "test_strat2", "periods": 10},
}


class Universe(BaseModel):
    name: str
    ccy: str = "EUR"


strategy_name = "test_strat2"

if strategy_name == "test_strat1":
    inputs = inputs1

    class Strategy(BaseModel):
        name: str


elif strategy_name == "test_strat2":
    inputs = inputs2

    class Strategy(BaseModel):
        name: str
        periods: int


class StaticModel(BaseModel):
    universe: Universe
    price_src: str = "csv"
    strategy: Strategy


static_model = StaticModel(**inputs)

如果strategy_name ==“test_strat1”，我的预期输出：

universe=Universe(name='test_universe', ccy='USD') price_src='csv' strategy=Strategy(name='test_strat1')

如果strategy_name ==“test_strat2”，我的预期输出：

universe=Universe(name='test_universe', ccy='USD') price_src='csv' strategy=Strategy(name='test_strat2', periods=10)

我在考虑使用pydantic的create_model函数，但是我不知道如何动态定义fields。

Answer 1

对于pydantic模型的动态创建，可以使用create_model。如下所示：

from pydantic import create_model

d = {"strategy": {"name": "test_strat2", "periods": 10}}

Strategy = create_model("Strategy", **d["strategy"])

print(Strategy.schema_json(indent=2))

输出：

{
  "title": "Strategy",
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "default": "test_strat2",
      "type": "string"
    },
    "periods": {
      "title": "Periods",
      "default": 10,
      "type": "integer"
    }
  }
}

Answer 2

您可以使用带有key=(type, ...) (字面意思是3个点)的create_model来指定该字段没有默认值。以下是基于您所需的工作代码。

from pydantic import BaseModel, create_model

...

if strategy_name == "test_strat1":
    inputs = inputs1
    Strategy = create_model('Strategy', name=(str, ...))

elif strategy_name == "test_strat2":
    inputs = inputs2
    Strategy = create_model('Strategy', name=(str, ...), periods=(int, ...))


class StaticModel(BaseModel):
    universe: Universe
    price_src: str = "csv"
    strategy: Strategy


print(Strategy.schema_json(indent=2))

strategy_name == "test_strat1"的输出

{
  "title": "Strategy",
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

而对于strategy_name == "test_strat2"

{
  "title": "Strategy",
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    },
    "periods": {
      "title": "Periods",
      "type": "integer"
    }
  },
  "required": [
    "name",
    "periods"
  ]
}

可以在以下位置找到相关的Pydantic文档：https://pydantic-docs.helpmanual.io/usage/models/#dynamic-model-creation

您可以在文档中看到：

没有

• foo=(str, ...) - defaults
• bar=123类型的123.

类型的foo属性的bar属性