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

本文介绍了如何在 Pydantic v2 模型中实现条件必需字段。通过自定义验证器，可以灵活地控制模型字段的必需性，从而满足不同场景下的数据验证需求。本文提供了一个示例，展示了如何确保模型至少包含一个非空字段。

在实际应用中，我们经常需要根据不同的场景对 Pydantic 模型的字段进行不同的验证。例如，在API交互中，接收数据时允许字段为空，而在创建数据时则要求某些字段必须存在。Pydantic v2 提供了灵活的方式来实现这种条件必需字段的验证。

以下提供一种实现方式，通过自定义模型验证器来实现：

1. 创建一个基类，用于定义条件验证逻辑

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('At least one field must be non-null')
        return self

在这个基类 AllRequired 中，我们定义了一个模型验证器 not_all_none。这个验证器会在模型初始化后执行，检查模型的所有字段是否都为 None。如果所有字段都为 None，则抛出一个 ValueError 异常，提示用户至少需要提供一个字段的值。

2. 创建实际的模型，并继承基类

sematic

一个开源的机器学习平台

下载

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 模型继承了 AllRequired 基类，因此它会自动应用基类中定义的验证逻辑。这意味着在创建 InvoiceItem 实例时，至少需要提供 id、org、relatedInvoice 或 quantity 中的一个字段的值。

3. 使用示例

# This will raise a ValueError because all fields are None
# InvoiceItem(id=None, org=None, relatedInvoice=None, quantity=None)

# This is a valid InvoiceItem
valid_item = InvoiceItem(id=1, org="https://example.com")
print(valid_item)

注意事项：

• model_validator 的 mode='after' 参数表示验证器在模型初始化后执行。
• all(v is None for _, v in self) 表达式用于检查模型的所有字段是否都为 None。
• 可以根据实际需求修改验证逻辑，例如，可以指定某些字段必须存在，或者某些字段之间存在依赖关系。
• 通过修改 AllRequired 类的 not_all_none 函数，可以实现更复杂的条件验证逻辑。例如，可以检查特定字段的组合是否满足特定条件。

总结：

通过自定义模型验证器，我们可以灵活地控制 Pydantic 模型字段的必需性，从而满足不同场景下的数据验证需求。这种方法不仅可以确保数据的完整性，还可以提高代码的可读性和可维护性。在实际应用中，可以根据具体需求定制验证逻辑，以实现更精细化的数据验证。