You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

Pydantic V2子类重写model_json_schema未生效,如何解决?

解决Pydantic子类自定义model_json_schema不生效的问题

问题原因

当父类Analysis的字段使用Union类型(如methods = t.Union[Properties1D, None])时,Pydantic生成JSON Schema会直接基于类型注解生成默认结构,不会自动调用子类重写的model_json_schema方法,因此子类的自定义schema修改无法生效。

解决方案

方案1:直接通过Field定义枚举(最简单)

如果只是给字段添加枚举约束,无需重写model_json_schema,直接在子类的字段中用Field指定enum参数即可:

import typing as t
from pydantic import BaseModel, Field

class Properties1D(BaseModel):
    method: t.Literal["Properties1D"] = "Properties1D"
    # 直接在Field中定义枚举和默认值
    value: str = Field("a", enum=["a", "b", "c"])

methods = t.Union[Properties1D, None]

class Analysis(BaseModel):
    method: methods = Field(..., description="Analysis method", discriminator="method")

# 调用验证
print(Analysis.model_json_schema())

这种方式会自动在生成的JSON Schema中给value字段添加enum属性,完全适配json-editor的需求。

方案2:手动替换子类的自定义Schema(动态修改场景)

如果必须通过重写model_json_schema实现动态修改(比如根据外部配置调整枚举值),需要在父类Analysis的model_json_schema方法中,手动替换Union类型中对应子类的Schema:

import typing as t
from pydantic import BaseModel, Field

class Properties1D(BaseModel):
    method: t.Literal["Properties1D"] = "Properties1D"
    value: str = "a"

    @classmethod
    def model_json_schema(cls, *args, **kwargs) -> dict[str, t.Any]:
        schema = super().model_json_schema(*args, **kwargs)
        # 动态添加枚举约束
        schema["properties"]["value"]["enum"] = ["a", "b", "c"]
        # 可添加其他自定义修改逻辑
        return schema

methods = t.Union[Properties1D, None]

class Analysis(BaseModel):
    method: methods = Field(..., description="Analysis method", discriminator="method")

    @classmethod
    def model_json_schema(cls, *args, **kwargs) -> dict[str, t.Any]:
        schema = super().model_json_schema(*args, **kwargs)
        # 定位method字段的Union结构(anyOf数组)
        method_field_schema = schema["properties"]["method"]
        if "anyOf" in method_field_schema:
            for idx, sub_schema in enumerate(method_field_schema["anyOf"]):
                # 通过method字段的const值匹配子类
                if sub_schema.get("properties", {}).get("method", {}).get("const") == "Properties1D":
                    # 替换为子类自定义生成的Schema
                    method_field_schema["anyOf"][idx] = Properties1D.model_json_schema(*args, **kwargs)
        return schema

# 测试验证
print(Analysis.model_json_schema())

该方法通过遍历anyOf数组,找到对应子类的Schema节点,替换为子类自定义生成的结果,确保子类的修改生效。

内容的提问来源于stack exchange,提问作者PythonF

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.10 18:25:28