Python pydantic 模块：初学者必读

Travis Tang

2024-07-25

Python pydantic 模块：初学者必读

Pydantic 是一个用于 Python 的数据验证和设置管理的快速库，它使用 Python 类型注解来定义数据模型，并执行数据验证以确保数据的正确性和一致性。Pydantic 专门设计用于确保数据输入的有效性，提供了一个简洁的 API 类，用于定义和验证数据模型。它支持 Python 3.6 及以上版本，并且使用类型注释来实现强类型检查，处理方便并且易于使用。

应用场景

Pydantic 主要用于以下场景：

数据验证：在处理用户输入或外部来源的数据时，确保数据符合预期的格式和类型，避免潜在的错误。
API 请求和响应：与 Web 框架（如 FastAPI）结合使用，自动验证和序列化请求参数和响应数据。
配置管理：管理应用程序的配置，确保配置数据符合预定义的模型结构。

安装说明

Pydantic 是一个外部模块，因此需要通过 Python 的包管理工具 pip 进行安装。可以使用以下命令进行安装：

1	pip install pydantic # 安装 Pydantic 模块

如果使用的是 Anaconda，也可以通过 conda 安装：

1	conda install -c conda-forge pydantic # 通过 conda 安装 Pydantic

用法举例

1. 定义基本数据模型

from pydantic import BaseModel

# 定义一个用户数据模型
class User(BaseModel):
    id: int  # 用户 ID，整数类型
    name: str  # 用户名称，字符串类型
    email: str  # 用户邮箱，字符串类型

# 创建一个用户实例
user = User(id=1, name='Alice', email='alice@example.com')  # 使用基本数据模型赋值
print(user)  # 输出用户信息，包括 ID、名称和邮箱

2. 数据验证示例

from pydantic import BaseModel, EmailStr, ValidationError

# 定义带有数据验证的用户数据模型
class User(BaseModel):
    id: int  # 用户 ID，必须是整数
    name: str  # 用户名称，必须是字符串
    email: EmailStr  # 确保邮箱格式合法

try:
    User(id=2, name='Bob', email='not_an_email')  # 尝试创建用户，邮箱不合法
except ValidationError as e:
    print(e)  # 捕获并打印数据验证错误信息

3. 使用嵌套模型

from pydantic import BaseModel
from typing import List

# 定义地址模型
class Address(BaseModel):
    street: str  # 街道名称
    city: str  # 城市名称

# 定义完整用户模型，包括嵌套地址
class User(BaseModel):
    id: int  # 用户 ID
    name: str  # 用户名称
    addresses: List[Address]  # 一个用户可以有多个地址

# 创建用户实例，其中包括多个地址
user = User(id=3, name='Charlie', addresses=[{'street': '123 Main St', 'city': 'New York'},
                                              {'street': '456 Elm St', 'city': 'Los Angeles'}])
print(user)  # 输出包含用户以及嵌套地址信息

Pydantic 模块为开发者提供了强大的数据验证和管理功能，非常适合在复杂数据交互的项目中使用。通过引入该模块，您能够显著提升 Python 应用的稳健性和可维护性。

强烈建议大家关注本人的博客全糖冲击博客，优点是包含所有 Python 标准库使用教程方便查询和学习。通过关注我的博客，您将能够快速掌握各种 Python 模块的实际运用与技巧，不断提高自己的编程能力，探索编程的无限可能，让学习变得更加轻松和有趣。期待您的光临与支持，让我们一起进步！

软件和库版本不断更新

由于软件和库版本不断更新，如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang