Pydantic 简介

1.1 Pydantic 是什么？

Pydantic 是一个用于数据验证和设置管理的 Python 库。它通过 Python 类型注解来定义数据模型，并提供了强大的数据验证功能。Pydantic 的主要目标是确保数据在输入和输出时的一致性和有效性。它广泛应用于各种 Python 项目中，特别是在需要处理复杂数据结构和确保数据完整性的场景中。

Pydantic 的核心功能包括：

• 数据验证：确保输入数据符合预定义的类型和结构。
• 序列化：将复杂的数据结构转换为 Python 数据类型，便于处理和传输。
• 错误处理：提供详细的错误信息，帮助开发者快速定位和修复问题。
• 配置管理：支持通过环境变量等方式管理配置，提高应用的可配置性。

1.2 Pydantic 的主要特性

Pydantic 以其高效、灵活和易用性著称，以下是其主要特性：

• 类型注解支持：Pydantic 充分利用 Python 的类型注解，使得数据模型的定义简洁明了。
• 高性能：Pydantic 的核心验证逻辑是用 Rust 编写的，这使得它在数据验证方面表现出色，速度快于许多其他 Python 数据验证库。
• JSON Schema 生成：Pydantic 模型可以自动生成 JSON Schema，便于与其他工具和系统集成。
• 严格模式和宽松模式：Pydantic 支持严格模式（strict=True）和宽松模式（strict=False），在严格模式下，数据不会被自动转换，而在宽松模式下，Pydantic 会尝试将数据转换为正确的类型。
• 数据类支持：Pydantic 支持标准库中的数据类（dataclasses）和 TypedDict，提供更灵活的数据结构定义。
• 自定义验证器和序列化器：Pydantic 允许开发者自定义验证器和序列化器，以满足特定的数据处理需求。
• 生态系统丰富：Pydantic 被广泛应用于各种项目中，包括 FastAPI、Hugging Face、Django Ninja、SQLModel 和 LangChain 等知名库。
• 经过实战测试：Pydantic 每月被下载超过 7000 万次，被所有 FAANG 公司和纳斯达克 25 家最大公司中的 20 家使用，证明了其可靠性和广泛的应用场景。

通过这些特性，Pydantic 为 Python 开发者提供了一个强大而灵活的工具，用于处理数据验证和解析，极大地简化了数据处理的复杂性。

安装与迁移

2.1 安装 Pydantic

要安装 Pydantic，你可以使用 pip 包管理器。以下是安装 Pydantic 的命令：

pip install pydantic

Pydantic 还支持通过 Conda 进行安装，如果你使用的是 Anaconda 或 Miniconda，可以使用以下命令：

conda install -c conda-forge pydantic

安装完成后，你可以在 Python 脚本中导入 Pydantic 并开始使用它。例如：

from pydantic import BaseModel

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

user = User(id=1, name='John Doe')
print(user)

这将输出一个包含用户 ID 和名称的 Pydantic 模型实例。

2.2 从 Pydantic V1 迁移到 V2

Pydantic V2 引入了一些重大的变化和改进，因此在从 V1 迁移到 V2 时，需要注意以下几点：

1. 配置类：Pydantic V2 中，配置类 Config 被移除，取而代之的是直接在模型上使用类属性。例如：

from pydantic import BaseModel

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

    class Config:
        arbitrary_types_allowed = True

在 V2 中，你可以这样写：

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    arbitrary_types_allowed = True

2. 验证器：Pydantic V2 中，验证器的语法有所变化。例如，V1 中的验证器：

from pydantic import BaseModel, validator

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

    @validator('name')
    def check_name(cls, v):
        if len(v) < 3:
            raise ValueError('Name too short')
        return v

在 V2 中，你可以这样写：

from pydantic import BaseModel, field_validator

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

    @field_validator('name')
    def check_name(cls, v):
        if len(v) < 3:
            raise ValueError('Name too short')
        return v

3. 字段类型：Pydantic V2 对字段类型的处理更加严格，一些在 V1 中允许的类型在 V2 中可能不被支持。因此，在迁移时需要仔细检查每个字段的类型定义。

4. 性能优化：Pydantic V2 在性能上有了显著的提升，特别是在数据验证和序列化方面。因此，迁移到 V2 后，你可能会注意到应用程序的性能有所改善。

通过以上步骤，你可以顺利地将你的项目从 Pydantic V1 迁移到 V2，并享受新版本带来的改进和优化。

基本使用

3.1 定义数据模型

在使用Pydantic进行数据验证之前，首先需要定义数据模型。Pydantic通过继承BaseModel类来实现这一点。以下是一个简单的示例，展示了如何定义一个包含基本数据类型的数据模型。

from pydantic import BaseModel
from typing import List

class EmployeeModel(BaseModel):
    name: str
    username: str
    salary: int
    habits: List[str]

在这个示例中，我们定义了一个名为EmployeeModel的类，它继承自BaseModel。该类包含四个字段：name、username、salary和habits。每个字段都通过类型注解（type annotation）指定了其数据类型。

3.2 数据验证示例

Pydantic的核心功能之一是数据验证。一旦定义了数据模型，Pydantic会自动验证输入数据是否符合模型定义的类型和结构。以下是一个验证示例：

employee = EmployeeModel(name='Bar', username='bar', salary=1000, habits=[])
print(employee)

在这个示例中，我们创建了一个EmployeeModel的实例，并传入相应的字段值。Pydantic会自动验证这些值是否符合模型定义的类型。如果验证通过，实例将被成功创建。

如果输入数据不符合模型定义的类型，Pydantic会抛出ValidationError异常，并提供详细的错误信息。例如：

try:
    employee = EmployeeModel(name='Bar', username='bar', salary='secret', habits=[])
except ValidationError as e:
    print(e)

在这个示例中，我们将salary字段设置为字符串'secret'，这不符合模型定义的int类型。因此，Pydantic会抛出ValidationError异常，并显示详细的错误信息：

1 validation error for EmployeeModel
salary
  value is not a valid integer (type=type_error.integer)

3.3 处理外部数据

Pydantic不仅可以在创建模型实例时进行数据验证，还可以处理外部数据，如JSON格式的数据。以下是一个处理外部数据的示例：

import json

# 假设我们有一个JSON字符串
json_data = '{"name": "Bar", "username": "bar", "salary": "1000", "habits": []}'

# 将JSON字符串解析为Python字典
data = json.loads(json_data)

# 使用字典数据创建模型实例
employee = EmployeeModel(**data)
print(employee)

在这个示例中，我们首先将JSON字符串解析为Python字典，然后使用字典数据创建EmployeeModel的实例。Pydantic会自动验证字典中的数据是否符合模型定义的类型。即使salary字段在JSON字符串中是字符串类型，Pydantic也会尝试将其转换为整数类型。

通过这种方式，Pydantic可以方便地处理来自外部数据源的数据，并确保数据的完整性和一致性。

高级功能

4.1 自定义验证器

Pydantic 提供了强大的数据验证功能，其中自定义验证器是一个非常重要的特性。通过自定义验证器，开发者可以实现复杂的验证逻辑，确保数据的完整性和准确性。

4.1.1 使用 @validator 装饰器

Pydantic 提供了 @validator 装饰器，用于在模型字段上定义自定义验证逻辑。以下是一个简单的示例：

from pydantic import BaseModel, validator, ValidationError

class UserModel(BaseModel):
    name: str
    age: int

    @validator('name')
    def name_must_contain_space(cls, v):
        if ' ' not in v:
            raise ValueError('must contain a space')
        return v.title()

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

try:
    user = UserModel(name="john doe", age=-1)
except ValidationError as e:
    print(e)

在这个示例中，我们定义了两个验证器：

1. name_must_contain_space：确保 name 字段包含空格。
2. age_must_be_positive：确保 age 字段是正整数。

4.1.2 验证器的参数

@validator 装饰器支持多个参数，用于控制验证器的行为：

• pre: 如果设置为 True，验证器将在字段验证之前执行。
• each_item: 如果设置为 True，验证器将应用于列表或字典中的每个元素。
• always: 如果设置为 True，验证器将始终执行，即使字段没有值。

from pydantic import BaseModel, validator

class UserModel(BaseModel):
    name: str
    hobbies: list

    @validator('hobbies', each_item=True)
    def check_hobbies_not_empty(cls, v):
        if not v:
            raise ValueError('hobby cannot be empty')
        return v

在这个示例中，check_hobbies_not_empty 验证器将应用于 hobbies 列表中的每个元素，确保每个爱好不为空。

4.2 嵌套模型

Pydantic 支持嵌套模型，这使得定义复杂的数据结构变得非常方便。嵌套模型可以包含其他模型作为字段，从而实现层次化的数据结构。

4.2.1 定义嵌套模型

以下是一个嵌套模型的示例：

from pydantic import BaseModel

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

class User(BaseModel):
    name: str
    address: Address

user = User(name="John Doe", address={"street": "123 Elm St", "city": "Springfield", "state": "IL", "zip_code": "62704"})
print(user)

在这个示例中，User 模型包含一个 Address 模型作为其 address 字段。

4.2.2 嵌套模型的验证

嵌套模型的验证是自动进行的。如果嵌套模型的字段不符合定义的类型或验证规则，Pydantic 将抛出 ValidationError。

try:
    user = User(name="John Doe", address={"street": "123 Elm St", "city": "Springfield", "state": "IL", "zip_code": "invalid"})
except ValidationError as e:
    print(e)

在这个示例中，zip_code 字段不符合定义的类型，因此会抛出验证错误。

4.3 配置选项

Pydantic 提供了多种配置选项，用于自定义模型的行为。这些配置选项可以在模型的 Config 类中定义。

4.3.1 常用的配置选项

• allow_mutation: 如果设置为 False，模型实例将是不可变的。
• extra: 控制如何处理未定义的字段。可选值包括 allow、forbid 和 ignore。
• validate_all: 如果设置为 True，所有字段在实例化时都将被验证。
• error_msg_templates: 自定义错误消息模板。

from pydantic import BaseModel

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

    class Config:
        allow_mutation = False
        extra = 'forbid'
        validate_all = True

user = User(name="John Doe", age=30)
try:
    user.age = 31  # 这将引发错误，因为 allow_mutation 设置为 False
except TypeError as e:
    print(e)

在这个示例中，allow_mutation 设置为 False，因此 user 实例是不可变的。

4.3.2 自定义错误消息

可以通过 error_msg_templates 自定义错误消息：

from pydantic import BaseModel, validator

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

    class Config:
        error_msg_templates = {
            'value_error.any_str.max_length': '字符串长度不能超过 {limit_value} 个字符',
            'value_error.any_str.min_length': '字符串长度不能少于 {limit_value} 个字符'
        }

    @validator('name')
    def name_length(cls, v):
        if len(v) > 10:
            raise ValueError('name too long')
        return v

在这个示例中，我们自定义了两个错误消息模板，用于处理字符串长度的错误。

通过这些高级功能，Pydantic 提供了强大的数据验证和自定义能力，使得开发者可以轻松处理复杂的数据结构和验证逻辑。

实际应用场景

5.1 Web 开发

在Web开发中，Pydantic可以作为数据验证和序列化的强大工具。特别是在使用FastAPI这样的现代Web框架时，Pydantic的数据模型可以直接用于定义API的请求和响应模型。以下是一个简单的示例，展示了如何在FastAPI中使用Pydantic模型：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str | None = None
    price: float
    tax: float | None = None

@app.post("/items/")
async def create_item(item: Item):
    return item

在这个示例中，Item类继承自Pydantic的BaseModel，用于定义一个数据模型。FastAPI使用这个模型来验证和解析传入的JSON数据。这种方式不仅简化了数据验证的代码，还使得API文档（如Swagger UI）能够自动生成，极大地提高了开发效率。

5.2 API 开发

Pydantic在API开发中的应用非常广泛，特别是在需要严格数据验证和序列化的场景。例如，开发一个RESTful API时，可以使用Pydantic来定义请求体和响应体的数据结构。以下是一个使用Pydantic进行API开发的示例：

from pydantic import BaseModel
from typing import List

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

class UserList(BaseModel):
    users: List[User]

def get_users() -> UserList:
    # 模拟从数据库获取用户数据
    users_data = [
        {"id": 1, "name": "Alice", "email": "alice@example.com"},
        {"id": 2, "name": "Bob", "email": "bob@example.com"}
    ]
    return UserList(users=users_data)

在这个示例中，User和UserList类分别定义了用户和用户列表的数据结构。通过这种方式，可以确保API的输入和输出数据的一致性和有效性。

5.3 数据处理

Pydantic在数据处理方面也非常有用，特别是在需要对复杂数据结构进行验证和转换的场景。例如，处理从外部系统导入的数据时，可以使用Pydantic来确保数据的正确性和完整性。以下是一个数据处理的示例：

from pydantic import BaseModel, ValidationError
from typing import Dict, Any

class Product(BaseModel):
    id: int
    name: str
    price: float

def process_product_data(data: Dict[str, Any]) -> Product:
    try:
        product = Product(**data)
        return product
    except ValidationError as e:
        print(e.errors())
        raise

# 示例数据
product_data = {
    "id": "123",  # 这里故意使用字符串类型来测试验证
    "name": "Laptop",
    "price": 999.99
}

try:
    product = process_product_data(product_data)
    print(product)
except ValidationError as e:
    print("数据验证失败:", e)

在这个示例中，Product类定义了产品的数据结构。process_product_data函数用于处理传入的数据，并使用Pydantic进行验证。如果数据不符合定义的结构，Pydantic会抛出ValidationError，从而确保数据的正确性。

通过这些示例，可以看出Pydantic在Web开发、API开发和数据处理等多个实际应用场景中的强大功能和灵活性。

Pydantic 的生态系统

Pydantic 不仅是一个强大的数据验证和设置管理工具，它还拥有一个丰富的生态系统，与其他流行的 Python 库和框架紧密集成，提供了更广泛的应用场景和更高效的工作流程。以下是 Pydantic 生态系统中的一些关键组成部分。

6.1 集成 FastAPI

FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，基于标准的 Python 类型提示，并利用 Pydantic 进行数据验证和设置管理。FastAPI 与 Pydantic 的集成是其高性能和易用性的关键因素之一。

示例代码

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
async def create_item(item: Item):
    return item

在这个示例中，Item 模型继承自 BaseModel，并在 FastAPI 的路由中用于验证和解析请求数据。FastAPI 自动生成 OpenAPI 文档，其中包括 Pydantic 模型的详细信息。

6.2 使用 Swagger 和 Redocly

Swagger 和 Redocly 是用于 API 文档生成的流行工具。由于 FastAPI 基于 Pydantic 模型自动生成 OpenAPI 文档，因此可以轻松地与 Swagger 和 Redocly 集成，提供交互式的 API 文档。

访问文档

• Swagger UI: 通过访问 /docs 路径，可以查看和测试 API。
• Redoc: 通过访问 /redoc 路径，可以查看更详细的 API 文档。

6.3 其他工具和插件

Pydantic 的生态系统还包括许多其他工具和插件，这些工具和插件进一步扩展了 Pydantic 的功能和应用场景。

1. Pydantic-SQLAlchemy

Pydantic-SQLAlchemy 是一个将 Pydantic 与 SQLAlchemy ORM 集成的库，使得从数据库模型到 Pydantic 模型的转换变得更加简单和高效。

2. Pydantic-Factories

Pydantic-Factories 提供了一种简单的方式来生成 Pydantic 模型的测试数据，这对于单元测试和集成测试非常有用。

3. Pydantic-Settings

Pydantic-Settings 是一个用于管理应用程序设置的库，它基于 Pydantic 的设置管理功能，提供了更高级的设置管理选项，如环境变量解析、.env 文件支持等。

4. Pydantic-Utils

Pydantic-Utils 包含了一系列实用工具和函数，用于增强 Pydantic 的功能，如自定义验证器、模型转换等。

通过这些工具和插件，Pydantic 不仅限于数据验证和设置管理，还可以扩展到更广泛的开发场景，提供更高效和灵活的开发体验。

Pydantic 的社区和资源

7.1 官方文档

Pydantic 的官方文档是学习和使用 Pydantic 的最佳资源。文档详细介绍了 Pydantic 的各个方面，包括安装、基本概念、数据验证、序列化、迁移指南、高级功能以及实际应用案例。以下是官方文档的一些关键部分：

• 安装指南：提供了详细的安装步骤，包括通过 pip 安装和从源码安装的方法。
• 快速入门：通过简单的示例帮助用户快速上手 Pydantic。
• 模型定义：详细介绍了如何定义数据模型，包括字段类型、默认值、验证器等。
• 高级功能：涵盖了自定义验证器、嵌套模型、配置选项等高级功能的使用方法。
• 迁移指南：指导用户从 Pydantic V1 迁移到 V2，详细说明了版本之间的差异和迁移步骤。
• API 文档：提供了 Pydantic 所有模块和类的详细 API 参考。

官方文档的地址是：Pydantic 官方文档