Pydantic简介与基础入门

霍格沃兹测试开发Muller老师

发布于 2024-07-12 16:19:40

880

发布于 2024-07-12 16:19:40

简介

Pydantic是一个基于Python类型注解的数据验证和设置管理工具。它主要用于FastAPI等框架中进行数据验证，但也可以在其他场景中使用。Pydantic的核心是基于数据类（dataclass）的模型，它通过类型注解和验证器来确保数据的有效性和完整性。本文将介绍Pydantic的基础知识和入门示例，帮助你快速掌握这一强大的工具。

Pydantic简介

Pydantic的设计目标是通过Python的类型注解提供数据验证和解析功能。它支持各种Python类型，包括基本类型、容器类型和自定义类型，并提供了一些高级特性，如嵌套模型、别名支持和验证器等。

主要特性包括：

数据验证：自动验证数据类型和格式。
数据解析：将数据转换为目标类型。
类型安全：利用Python类型注解实现类型安全。
性能优越：在保证数据安全性的同时，保持高性能。

安装Pydantic

在开始使用Pydantic之前，需要先安装它。可以使用以下命令安装：

pip install pydantic

基本使用

Pydantic的核心是BaseModel类，通过继承BaseModel，可以定义数据模型并实现数据验证和解析。

定义数据模型

以下是一个基本的数据模型示例：

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    age: int
    is_active: bool = True

在这个示例中，我们定义了一个User模型，其中包含id、name、age和is_active字段。is_active字段有一个默认值True。

数据验证和解析

使用数据模型时，Pydantic会自动进行数据验证和解析：

data = {
    'id': 1,
    'name': 'Alice',
    'age': 30
}

user = User(**data)
print(user)
print(user.id)
print(user.name)

如果数据无效，Pydantic会抛出验证错误：

invalid_data = {
    'id': 'invalid',  # id 应该是 int 类型
    'name': 'Bob',
    'age': 'thirty'   # age 应该是 int 类型
}

try:
    user = User(**invalid_data)
except ValueError as e:
    print(e)

高级特性

Pydantic提供了一些高级特性，如嵌套模型、别名支持和自定义验证器等。

嵌套模型

可以在一个模型中包含另一个模型，从而实现复杂的数据结构：

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

class UserWithAddress(BaseModel):
    id: int
    name: str
    age: int
    address: Address

data = {
    'id': 1,
    'name': 'Alice',
    'age': 30,
    'address': {
        'street': '123 Main St',
        'city': 'Springfield',
        'country': 'USA'
    }
}

user = UserWithAddress(**data)
print(user)

别名支持

可以为模型字段定义别名，以支持不同的数据表示形式：

class UserWithAlias(BaseModel):
    id: int
    name: str
    age: int

    class Config:
        fields = {
            'name': 'full_name'
        }

data = {
    'id': 1,
    'full_name': 'Alice',
    'age': 30
}

user = UserWithAlias(**data)
print(user)

自定义验证器

可以使用@validator装饰器定义自定义验证器：

from pydantic import BaseModel, validator

class UserWithValidation(BaseModel):
    id: int
    name: str
    age: int

    @validator('age')
    def age_must_be_positive(cls, v):
        if v < 0:
            raise ValueError('age must be positive')
        return v

try:
    user = UserWithValidation(id=1, name='Alice', age=-1)
except ValueError as e:
    print(e)  # 输出: age must be positive

与FastAPI集成

Pydantic与FastAPI无缝集成，可以用于请求体验证和响应模型定义。

以下是一个简单的FastAPI应用示例：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    id: int
    name: str
    age: int

@app.post("/users/")
async def create_user(user: User):
    return user

# 运行命令: uvicorn your_module_name:app --reload

在这个示例中，User模型用于请求体验证，确保客户端发送的数据符合预期格式。