软件测试|Pydantic BaseModel使用详解

news2025/1/24 2:20:20

简介

当我们在Python中编写应用程序时，通常需要处理和验证数据。Pydantic 是一个流行的库，它可以帮助我们·定义数据模型并自动进行数据验证。在Pydantic中，BaseModel是一个核心概念，它用于定义数据模型和验证输入数据。在这篇文章中，我们将详细介绍如何使用Pydantic的BaseModel来创建和验证数据模型。

为什么使用BaseModel？

Pydantic 是一个Python库，用于数据验证和解析。它允许你定义数据模型，然后使用这些模型来验证和解析输入数据。Pydantic的一个关键特性是它的类型提示，这使得代码更加清晰和易于理解。

在Pydantic中，BaseModel是一个抽象基类，用于定义数据模型。它提供了一种简单而强大的方法来描述数据的结构和验证数据的有效性。使用BaseModel可以帮助我们减少手动验证代码的编写，提高代码的可维护性。

创建一个简单的BaseModel

让我们从一个简单的例子开始，假设我们正在开发一个应用程序，需要处理用户的个人信息。我们可以使用BaseModel来定义一个用户数据模型：

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str
    age: int

在这个例子中，我们定义了一个名为User的BaseModel，它有三个字段：username，email和age，分别代表用户的用户名、电子邮件地址和年龄。字段后面的类型提示是必需的，Pydantic会使用它们来验证输入数据的类型。

使用BaseModel验证数据

一旦我们定义了User模型，我们可以使用它来验证数据。假设我们已经有一些用户提供的数据，那我们可以将这些数据作为字典传递给User类的构造函数，Pydantic会自动验证数据并创建一个User对象：

user_data = {
    "username": "john_doe",
    "email": "john@example.com",
    "age": 30
}

user = User(**user_data)
print(user)

-------------
输出结果如下：
username='john_doe' email='john@example.com' age=30

如果提供的数据与模型不匹配，Pydantic会引发一个ValidationError异常。我们可以使用try和except来捕获这个异常并处理验证错误：

from pydantic import ValidationError

user_data = {
    "username": "john_doe",
    "email": ["invalid_email"],
    "age": "30"
}

try:
    user = User(**user_data)
except ValidationError as e:
    print(e)

在这个例子中，邮箱的数据类型错误，所以Pydantic引发了一个ValidationError。

使用默认值和可选字段

有时候，某些字段可能是可选的，或者我们想要为字段提供默认值。在Pydantic中，我们可以使用Field类来实现这些功能：

from pydantic import BaseModel, Field

class User(BaseModel):
    username: str = Field(..., min_length=3)
    email: str
    age: int = Field(default=18, ge=0)

在这个例子中，username字段是必需的，且必须至少包含3个字符，email字段是可选的，age字段有一个默认值为18，且必须大于等于0。

使用嵌套模型

在实际应用中，我们可能需要定义复杂的数据模型，包括嵌套模型。当然Pydantic支持嵌套模型的定义和验证：

from pydantic import BaseModel

class Address(BaseModel):
    street: str
    city: str
    zip_code: str

class User(BaseModel):
    username: str
    email: str
    age: int
    address: Address

在这个例子中，User模型包含一个嵌套的Address模型。我们可以像往常一样使用User模型来验证数据，包括嵌套的数据：

user_data = {
    "username": "Muller",
    "email": "muller@example.com",
    "age": 30,
    "address": {
        "street": "nanjing road",
        "city": "Shanghai",
        "zip_code": "10001"
    }
}
user = User(**user_data)
print(user)

-----------------
输出如下：
username='Muller' email='muller@example.com' age=30 address=Address(street='nanjing road', city='Shanghai', zip_code='10001')