讲师中心 微信公众号
AI工具推荐 视频效率加速

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

雨敏君_5746

雨敏君_5746

发布时间:2026-08-01 13:32:03

|

557人浏览过

|

来源于php中文网

原创

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

本文介绍如何使用 Pydantic v2 的 @model_validator(mode="after") 实现嵌套字段的条件校验——当主类别(如 meat/veg)确定后,自动限制子类别只能从对应预定义枚举中选取,确保数据结构强类型且业务逻辑内聚。

本文介绍如何使用 pydantic v2 的 `@model_validator(mode="after")` 实现嵌套字段的条件校验——当主类别(如 `meat`/`veg`)确定后,自动限制子类别只能从对应预定义枚举中选取,确保数据结构强类型且业务逻辑内聚。

在构建具有层级依赖关系的业务模型(如商品分类体系)时,简单的枚举嵌套无法表达“category=meat 时 sub_category 只能是 beef 或 lamb”这类动态约束。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"


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


# 使用 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,
        }
        expected_enum = valid_subcategories.get(self.category)
        # 检查 sub_category 是否属于预期枚举类型(注意:isinstance 对 str 枚举有效)
        if not isinstance(self.sub_category, expected_enum):
            raise ValueError(
                f"Sub-category '{self.sub_category}' is not valid for category '{self.category}'"
            )
        return self

关键要点说明:

  • Union[MeatSubCategory, VegSubCategory] 允许 sub_category 接收任一子枚举值,同时保留类型提示完整性;
  • @model_validator(mode="after") 在所有字段解析完成后执行,此时 self.category 和 self.sub_category 均已为 Python 原生对象(如 Category.meat 和 "beef" 字符串),可直接比对;
  • isinstance(value, EnumClass) 是校验枚举成员归属的可靠方式(优于字符串匹配,避免拼写误判);
  • 映射字典 valid_subcategories 易于扩展——新增类别只需添加枚举类 + 更新映射,无需修改校验逻辑。

⚠️ 注意事项:

  • 若 sub_category 传入非法字符串(如 "tofu"),Pydantic 默认会先尝试转换为 SubCategory 类型;若失败则抛出 ValidationError(提示“Input should be 'beef', 'lamb', 'carrot' or 'potato'”)。而我们的 model_validator 负责第二层业务规则校验——即“即使字符串合法,也必须匹配当前 category”。两者互补,不可替代;
  • 不建议在 @field_validator 中做跨字段校验,因其仅接收单个字段值,无法访问 category;
  • 如需支持更多类别(如 dairy, fruit),只需定义新 Enum 类并扩展 valid_subcategories 字典即可,保持高内聚低耦合。

通过该模式,你不仅能保障 API 输入的数据合规性,还能在 IDE 中获得完整的类型提示与静态检查支持,真正实现“用代码表达业务契约”。

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

1551

2023.07.20

python能做什么
python能做什么

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

3684

2023.07.25

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

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

1569

2023.07.31

python教程
python教程

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

21097

2023.08.03

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

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

2607

2023.08.04

python eval
python eval

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

2667

2023.08.04

scratch和python区别
scratch和python区别

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

1083

2023.08.11

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

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

576

2023.08.10

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

0

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn