Pydantic 实现条件化嵌套枚举校验:基于主类动态约束子类取值

浅晨酱_7014

浅晨酱_7014

2026-08-01

587人浏览

原创

Pydantic 实现条件化嵌套枚举校验:基于主类动态约束子类取值

本文介绍如何使用 Pydantic 的 @model_validator 在嵌套模型中实现「主类别决定可选子类别」的强约束校验,避免硬编码逻辑,确保 sub_category 的合法性严格依赖于 category 的实际值。

本文介绍如何使用 pydantic 的 `@model_validator` 在嵌套模型中实现「主类别决定可选子类别」的强约束校验,避免硬编码逻辑,确保 `sub_category` 的合法性严格依赖于 `category` 的实际值。

在构建具有层级关系的业务数据模型(如商品分类、内容标签、配置项分组)时,常需保证子字段的取值范围受父字段动态约束——例如选择 "meat" 类别后,子类别仅允许 "beef"、"lamb" 等肉类专属选项;若选 "veg",则只接受 "carrot"、"potato" 等蔬菜子类。Pydantic 本身不支持跨字段的枚举依赖声明,但可通过 @model_validator(mode="after") 在实例化后进行语义级校验,精准实现该需求。

以下是一个完整、可运行的示例:

from enum import Enum
from pydantic import BaseModel, model_validator
from typing import Union


class Category(str, Enum):
    meat = "meat"
    veg = "veg"


class MeatSubCategory(str, Enum):
    beef = "beef"
    lamb = "lamb"
    pork = "pork"


class VegSubCategory(str, Enum):
    carrot = "carrot"
    potato = "potato"
    tomato = "tomato"


# 使用 Union 构建统一类型提示(兼容类型检查与文档生成)
SubCategory = Union[MeatSubCategory, VegSubCategory]


class ProductCategory(BaseModel):
    category: Category
    sub_category: SubCategory

    @model_validator(mode="after")
    def validate_sub_category(self) -> "ProductCategory":
        # 定义类别到子类枚举的映射关系
        valid_subcategories = {
            Category.meat: MeatSubCategory,
            Category.veg: VegSubCategory,
        }
        # 获取当前 category 对应的合法子类枚举
        expected_enum = valid_subcategories.get(self.category)
        # 校验 sub_category 是否属于预期枚举类型
        if not isinstance(self.sub_category, expected_enum):
            raise ValueError(
                f"Sub-category '{self.sub_category}' is not valid for category '{self.category}'. "
                f"Expected one of: {[e.value for e in expected_enum]}"
            )
        return self

✅ 关键设计说明:

PhotoStudio AI
PhotoStudio AI

PhotoStudio AI是虹软科技推出的电商 AI 智能商拍服务平台。

下载
  • SubCategory = Union[...] 提供类型安全与 IDE 自动补全支持,同时兼容 OpenAPI/Swagger 文档生成;
  • @model_validator(mode="after") 在所有字段解析完成后执行,可安全访问 self.category 和 self.sub_category;
  • 映射字典 valid_subcategories 清晰表达业务规则,易于维护和扩展(如新增 Category.fruit 及其对应子类);
  • 错误信息包含具体可选值列表,提升调试与用户提示体验。

⚠️ 注意事项:

  • 不要将 sub_category 声明为 str 后再手动校验——这会丢失枚举的类型约束与序列化优势;
  • 若需支持更多动态规则(如数据库驱动的类别配置),可将映射逻辑抽离为外部函数或依赖注入服务;
  • Pydantic v2 要求显式返回 self(如示例所示),遗漏将导致校验失败。

运行验证示例:

# ✅ 合法组合
print(ProductCategory(category="meat", sub_category="beef"))
# → category='meat' sub_category=<meatsubcategory.beef:>

# ❌ 非法组合(抛出 ValueError)
ProductCategory(category="meat", sub_category="carrot")
# → ValueError: Sub-category 'carrot' is not valid for category 'meat'. Expected one of: ['beef', 'lamb', 'pork']</meatsubcategory.beef:>

该方案兼顾类型安全性、可读性与可维护性,是 Pydantic 中处理条件化枚举依赖的经典实践。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1771

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4624

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27337

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3307

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3307

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2563

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程