Pydantic

吉小雨

已于 2024-05-28 12:31:35 修改

阅读量521

点赞数 3

分类专栏： python库文章标签： python

于 2024-05-28 10:02:00 首次发布

本文链接：https://blog.csdn.net/jixiaoyu0209/article/details/139257989

版权

python库专栏收录该内容

69 篇文章 0 订阅

订阅专栏

Pydantic是一个强大的Python数据验证和设置管理库，被广泛用于增强代码的健壮性和可靠性。它能够处理各种数据验证场景，从简单的任务如检查变量是否为整数，到复杂的任务如确保高度嵌套的字典键和值具有正确的数据类型。Pydantic特别适用于需要快速开发和易于使用的动态类型语言，同时在现实世界应用中提供更强大的类型检查和数据验证。

Pydantic的主要特点

类型提示驱动：Pydantic使用Python的类型提示来控制模式验证和序列化，减少学习成本和编码量，并与IDE和静态分析工具集成。
速度：Pydantic的核心验证逻辑用Rust编写，使其成为Python中最快的数据验证库之一。
JSON模式：Pydantic模型可以发出JSON模式，便于与其他工具集成。
严格和宽松模式：Pydantic可以在strict=True模式（不转换数据）或strict=False模式（尝试将数据转换为正确的类型）下运行。
支持多种标准库类型：包括dataclass和TypedDict。
定制化：Pydantic允许自定义验证器和序列化器，以多种方式更改数据处理。
生态系统和行业采纳：约8000个PyPI包使用Pydantic，包括FastAPI、huggingface、Django Ninja、SQLModel和LangChain等流行库。

安装Pydantic

Pydantic可以通过pip安装：

pip install pydantic

如果需要电子邮件验证，可以安装可选的email-validator依赖项：

pip install pydantic[email]

创建基本的Pydantic模型

创建Pydantic模型很简单。首先，从BaseModel类继承创建一个类，并指定各个字段和预期的类型。例如，创建一个Employee类：

from pydantic import BaseModel, EmailStr
class Employee(BaseModel):
    name: str
    age: int
    email: EmailStr
    department: str
    employee_id: str

在这个例子中，我们指定email字段为EmailStr类型，而不是普通的Python字符串，以确保所有有效字符串都是有效的电子邮件地址。

实现自定义验证

Pydantic允许实现自定义验证。例如，可以定义一个验证器来检查employee_id字段是否为长度为6的字母数字字符串：

from pydantic import BaseModel, EmailStr, validator
...
@validator("employee_id")
def validate_employee_id(cls, v):
    if not v.isalnum() or len(v) != 6:
        raise ValueError("Employee ID must be exactly 6 alphanumeric characters")
    return v

使用Pydantic模型加载和解析JSON数据

在实际应用中，经常需要从API解析JSON响应到Python数据结构，如字典。例如，假设有一个employees.json文件，包含员工记录。可以使用内置的json模块来解析这个文件，并尝试创建Employee对象，同时处理数据验证失败时抛出的ValidationError异常。

import json
from pydantic import BaseModel, EmailStr, ValidationError, validator
...
# Load and parse the JSON data
with open("employees.json", "r") as f:
    data = json.load(f)
# Validate each employee record
for record in data:
    try:
        employee = Employee(**record)
        print(f"Valid employee record: {employee.name}")
    except ValidationError as e:
        print(f"Invalid employee record: {record['name']}")
        print(f"Errors: {e.errors()}")

运行脚本后，将看到每个员工记录的验证结果，包括任何错误。

当然，让我们继续深入探讨Pydantic的一些更高级的功能和用例。

进阶功能

1. 嵌套模型和列表

Pydantic支持创建嵌套模型和包含模型的列表。这对于表示复杂的数据结构非常有用。

from pydantic import BaseModel
class Address(BaseModel):
    street: str
    city: str
    postal_code: str
class Employee(BaseModel):
    name: str
    age: int
    email: EmailStr
    department: str
    addresses: list[Address]

在这个例子中，Employee模型包含一个addresses字段，它是一个Address模型的列表。

2. 字段默认值和可选字段

可以为模型字段设置默认值，也可以将字段标记为可选。

from pydantic import BaseModel, Field, EmailStr
class Employee(BaseModel):
    name: str
    age: int = Field(default=18, title="The age of the employee")
    email: EmailStr
    department: str = "Engineering"
    employee_id: str

在这里，age字段有一个默认值18，department字段默认为"Engineering"。字段默认值可以在模型实例化时被覆盖。

3. 环境变量和配置

Pydantic可以用来处理环境变量和配置文件。这对于创建可配置的应用程序非常有用。

from pydantic import BaseSettings
class Settings(BaseSettings):
    app_name: str = "Awesome App"
    admin_email: EmailStr
settings = Settings()

在这个例子中，Settings类从BaseSettings继承，用于处理配置。可以通过环境变量设置这些值。

高级教程

1. 自定义数据转换

Pydantic允许在数据加载和验证过程中进行自定义转换。

from pydantic import BaseModel, validator
class Employee(BaseModel):
    name: str
    salary: str
    @validator("salary")
    def salary_to_int(cls, v):
        return int(v.replace("$", "").replace(",", ""))

在这个例子中，我们定义了一个自定义验证器来将工资字符串转换为整数。

2. 继承和模型复用

可以通过继承来复用模型，减少代码重复。

class Manager(Employee):
    team_size: int

在这里，Manager类继承自Employee类，并添加了一个新的字段team_size。

3. 复杂验证逻辑

Pydantic支持复杂的验证逻辑，包括字段之间的相互依赖。

from pydantic import BaseModel, ValidationError, validator
class Employee(BaseModel):
    name: str
    age: int
    email: EmailStr
    @validator("age")
    def check_age(cls, v, values):
        if "email" in values and v < 18:
            raise ValueError("Underage employees must not have an email address")
        return v