Pydantic v2 模型中实现条件必填字段

本文介绍了在 Pydantic v2 模型中实现条件必填字段的方法。通过自定义模型验证器，可以在模型初始化后检查字段是否满足特定条件，从而灵活地控制字段的必填性，以适应不同的应用场景，例如 API 数据解析和对象创建。

在使用 Pydantic 构建数据模型时，经常会遇到这样的需求：某些字段在特定条件下是必须的，而在其他情况下则可以为空。例如，在处理 API 响应时，为了兼容不同的查询参数，模型中的所有字段可能都需要设置为可选。但是，在创建新对象时，某些字段又必须提供。Pydantic v2 提供了一种灵活的方式来实现这种条件必填字段，即通过自定义模型验证器。

以下代码展示了如何使用模型验证器来确保至少有一个字段被赋值：

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):             raise ValueError('All values were none')         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   # InvoiceItem(id=None, org=None, relatedInvoice=None, quantity=None) # Invalid item InvoiceItem(id=1, org="https://example.com", relatedInvoice=None, quantity=None) # Valid item

代码解释：

1. AllRequired 基类: 定义了一个名为 AllRequired 的基类，它继承自 BaseModel。这个基类包含了一个模型验证器 not_all_none。

2. @model_validator(mode=’after’) 装饰器: @model_validator(mode=’after’) 装饰器指示 Pydantic 在模型初始化完成后运行 not_all_none 方法。mode=’after’ 确保验证器在所有字段都已解析后运行。

3. not_all_none 方法: 这个方法遍历模型的所有字段，检查它们是否都为 None。如果所有字段都为 None，则抛出一个 ValueError 异常，提示至少需要一个字段被赋值。

4. InvoiceItem 模型: InvoiceItem 模型继承自 AllRequired 基类，并定义了四个可选字段：id、org、relatedInvoice 和 quantity。由于它继承了 AllRequired，因此在创建 InvoiceItem 实例时，至少需要提供其中一个字段的值。

使用方法：

• 将上述代码复制到你的项目中。
• 根据你的实际需求，修改 InvoiceItem 模型中的字段类型和名称。
• 创建 InvoiceItem 实例时，确保至少提供一个字段的值。

注意事项：

• 模型验证器在模型初始化完成后运行，因此它只能验证字段之间的关系，而不能改变字段的类型或值。
• 如果需要更复杂的条件验证，可以在模型验证器中添加更多的逻辑。
• 可以使用多个模型验证器来验证不同的条件。

总结：

通过使用 Pydantic v2 的模型验证器，可以方便地实现条件必填字段，从而提高数据模型的灵活性和健壮性。这种方法适用于各种需要根据特定条件来验证数据的场景，例如 API 数据解析、表单验证等。记住，关键在于定义一个合适的模型验证器，并在其中实现你的验证逻辑。