本文介绍了如何在 Pydantic v2 模型中实现条件性必填字段，以应对 API 接口返回字段可选，但创建对象时部分字段必须的要求。通过自定义模型验证器，可以在模型验证阶段检查是否满足特定条件，从而实现字段的条件性必填。
利用 model_validator 实现条件性必填
在 Pydantic v2 中，可以通过 model_validator 装饰器自定义模型验证器，实现更灵活的字段验证逻辑。以下展示如何创建一个基类，确保模型至少有一个字段不为 None，从而实现条件性必填的效果。
from typing import Selffrom pydantic import HttpUrl, BaseModel, PositiveInt, model_validatorclass AllRequired(BaseModel): @model_validator(mode='after') def not_all_none(self) -> Self: if all(v is None for _, v in self): raise ValueError('At least one value must be provided') return selfclass InvoiceItem(AllRequired): """ Pydantic model representing an Invoice """ id: PositiveInt | None = None org: HttpUrl | None = None relatedInvoice: HttpUrl | None = None quantity: PositiveInt | None = Nonetry: InvoiceItem(id=None, org=None, relatedInvoice=None, quantity=None) # Invalid itemexcept ValueError as e: print(e)
代码解释：
AllRequired 基类: 定义了一个 AllRequired 基类，继承自 BaseModel。@model_validator(mode=’after’) 装饰器: 使用 model_validator 装饰器定义了一个名为 not_all_none 的模型验证器。mode=’after’ 表示该验证器在所有字段验证之后执行。not_all_none 方法: 该方法遍历模型的所有字段，检查是否所有字段的值都为 None。如果是，则抛出一个 ValueError 异常，提示用户至少需要提供一个字段的值。Self 是Python 3.11 引入的类型提示，等价于 AllRequired。InvoiceItem 模型: 定义了一个 InvoiceItem 模型，继承自 AllRequired。该模型的所有字段都是可选的，但由于继承了 AllRequired，因此在创建 InvoiceItem 对象时，必须至少提供一个字段的值。
运行结果:
上述代码会抛出 ValueError: At least one value must be provided 异常，因为创建 InvoiceItem 对象时，所有字段的值都为 None。
其他条件性验证
除了验证是否所有字段都为 None 之外，还可以通过 model_validator 实现更复杂的条件性验证。例如，可以根据某个字段的值来决定其他字段是否必须提供。
from typing import Selffrom pydantic import BaseModel, model_validatorclass ConditionalRequired(BaseModel): field_a: str | None = None field_b: int | None = None field_c: float | None = None @model_validator(mode='after') def validate_fields(self) -> Self: if self.field_a == "require_b": if self.field_b is None: raise ValueError("field_b is required when field_a is 'require_b'") if self.field_a == "require_c": if self.field_c is None: raise ValueError("field_c is required when field_a is 'require_c'") return self# 测试用例try: ConditionalRequired(field_a="require_b")except ValueError as e: print(e)try: ConditionalRequired(field_a="require_c")except ValueError as e: print(e)print(ConditionalRequired(field_a="require_b", field_b=10))print(ConditionalRequired(field_a="require_c", field_c=3.14))
代码解释：
ConditionalRequired 模型: 定义了三个字段 field_a, field_b, 和 field_c，都是可选的。validate_fields 方法: 该方法根据 field_a 的值来决定 field_b 和 field_c 是否必须提供。如果 field_a 的值为 “require_b”，则 field_b 必须提供；如果 field_a 的值为 “require_c”，则 field_c 必须提供。
注意事项
model_validator 装饰器必须应用于类方法。mode=’after’ 表示验证器在所有字段验证之后执行。验证器方法必须返回模型自身 (Self)。可以使用 raise ValueError 抛出验证错误。
总结
通过 model_validator，可以在 Pydantic v2 模型中实现复杂的条件性验证逻辑，从而更好地满足实际应用的需求。 这种方法允许你定义基于模型状态的验证规则，从而确保数据的有效性和一致性。 这种方法比创建多个继承模型更加灵活，也避免了代码冗余。
以上就是Pydantic v2 模型中实现条件性必填字段的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1368450.html
微信扫一扫 
支付宝扫一扫 
