使用 Pydantic v2 实现条件性必填字段

本文介绍了如何在 Pydantic v2 模型中实现条件性必填字段。通过自定义验证器，可以根据模型中其他字段的值来动态地控制某些字段是否为必填项，从而满足 API 交互中数据验证的复杂需求。本文提供了一个具体的示例，展示了如何确保模型中至少有一个字段被赋值。

在 Pydantic v2 中，虽然没有直接提供像 v1 中 metaclass 那样灵活的条件性必填字段的机制，但我们可以利用 model_validator 来实现类似的功能。model_validator 允许我们在模型验证过程中执行自定义的检查，并根据需要抛出异常，从而实现条件性地强制某些字段必须存在。

实现原理

核心思路是创建一个基类，该基类包含一个 model_validator，用于检查是否满足特定条件。如果条件不满足，则抛出一个 ValueError 异常，导致验证失败。然后，我们可以让需要条件性必填字段的模型继承自这个基类。

示例代码

以下代码演示了如何创建一个基类，确保模型中至少有一个字段被赋值：

from typing import Self from pydantic import HttpUrl, BaseModel, PositiveInt, model_validator   class AllRequired(BaseModel):     @model_validator(mode='after')     def not_all_none(self) -> Self:         if all(v is None for _, v in self.__dict__.items()):             raise ValueError('At least one field must be provided.')         return self  class InvoiceItem(AllRequired):     """     Pydantic model representing an Invoice     """      id: PositiveInt | None = None     org: HttpUrl | None = None     relatedInvoice: HttpUrl | None = None     quantity: PositiveInt | None = None  # Invalid item # InvoiceItem(id=None, org=None, relatedInvoice=None, quantity=None)  # Valid item valid_item = InvoiceItem(id=1, org="https://example.com") print(valid_item)

代码解释

1. AllRequired 基类: 定义了一个 model_validator，名为 not_all_none。
2. mode=’after’: 指定验证器在所有字段验证之后运行。
3. all(v is None for _, v in self.__dict__.items()): 遍历模型的所有字段，检查它们的值是否都为 None。 self.__dict__.items() 用于访问模型的属性字典。
4. ValueError(‘At least one field must be provided.’): 如果所有字段都为 None，则抛出一个 ValueError 异常，指示至少需要提供一个字段。
5. InvoiceItem 模型: 继承自 AllRequired，因此它将自动应用 not_all_none 验证器。

注意事项

• mode=’after’ 非常重要，它确保所有字段都经过验证后再运行自定义验证器。
• 可以根据实际需求修改 not_all_none 验证器的逻辑，以实现更复杂的条件性必填字段。 例如，可以根据某个字段的值来决定另一个字段是否为必填项。
• 如果模型中包含默认值，需要注意验证器是否会受到默认值的影响。可能需要调整验证逻辑以处理默认值的情况。
• self.__dict__.items() 用于访问模型的属性字典。在 Pydantic v2 中，直接访问 self.__fields.items() 可能会导致错误，因为 __fields 属性是 Pydantic 内部使用的，不应该直接访问。

总结

通过使用 model_validator，我们可以在 Pydantic v2 中实现灵活的条件性必填字段。这种方法允许我们根据模型的状态执行自定义验证逻辑，从而满足各种复杂的数据验证需求。 关键在于设计合适的验证器，以确保模型符合预期的约束。