软件测试|使用 Pydantic Validator 验证器的数据验证 —— pre 和 each_item 验证器详解

前言

Pydantic 是一个功能强大的 Python 库，用于数据验证和解析。在 Pydantic 中，验证器是一种机制，用于在数据模型的属性上执行自定义验证逻辑。本文将重点介绍 Pydantic 中的两种验证器：pre 和 each_item，以及如何使用它们来验证数据模型的属性。

pre 验证器

pre 验证器允许我们在将数据赋值给属性之前执行自定义验证逻辑。例如，假设我们有一个数据模型 Person，其中包含一个名字属性，我们希望确保名字不为空字符串：

from pydantic import BaseModel, validator

class Person(BaseModel):
    name: str

    @validator('name', pre=True)
    def check_name_length(cls, name):
        if len(name) == 0:
            raise ValueError("名字不能为空字符串")
        return name

在这个示例中，我们使用 @validator 装饰器和 pre=True 参数定义了一个名为 check_name_length 的验证器。它检查名字属性是否为空字符串，如果是，将引发一个值错误。

现在我们来验证这个验证器是否生效：

try:
    person = Person(name="")
except ValueError as e:
    print(e)  # 输出："名字不能为空字符串"

运行脚本，将会输出如下内容，我们将收集到这个验证错误：

1 validation error for Person
name
  名字不能为空字符串 (type=value_error)

我们可以确定，我们添加的pre验证器成功生效，在数据模型的属性被设置之前执行了自定义验证逻辑。

each_item 验证器

each_item 验证器用于验证集合类型（如列表、字典等）中每个元素的值。例如，假设我们有一个数据模型 Product，其中包含一个价格属性，我们希望确保价格都大于零：

from pydantic import BaseModel, validator
from typing import List

class Product(BaseModel):
    prices: List[float]

    @validator('prices', each_item=True)
    def check_price(cls, price):
        if price <= 0:
            raise ValueError("价格必须大于零")
        return price

在这个示例中，我们使用 each_item=True 参数定义了一个名为 check_price 的验证器。它检查 prices 属性中的每个价格是否大于零，如果不是，将引发一个值错误。

现在，我们来测试这个验证器：

try:
    product = Product(prices=[10.0, -5.0, 20.0])
except ValueError as e:
    print(e)  # 输出："价格必须大于零"

运行脚本，将输出如下内容：

1 validation error for Product
prices -> 1
  价格必须大于零 (type=value_error)

我们可以发现，我们的each_item验证器成功生效，对集合类型中的每个元素执行了自定义验证逻辑。

总结

Pydantic 的 pre 和 each_item 验证器为数据验证提供了强大的工具，允许我们在数据模型属性被设置之前和集合类型元素被添加之前执行自定义验证逻辑。这使得数据验证更加灵活和可控，有助于确保应用程序接受和处理有效的数据。通过深入了解 Pydantic 的验证器机制，我们可以更好地应对各种数据验证需求，并提高代码的健壮性和可维护性。

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！