pydantic，一个超强的 Python 库！

大家好，我是涛哥，本文内容来自 涛哥聊Python ，转载请标原创。

今天为大家分享一个超强的 Python 库 - pydantic。

Github地址：https://github.com/pydantic/pydantic

---

在软件开发过程中，数据验证和序列化是非常重要的一环。Python的pydantic库为开发者提供了强大的工具，可以轻松实现数据验证、模型定义和序列化操作。本文将介绍pydantic库的安装方法、特性、基本功能、高级功能、实际应用场景，并对其进行总结。

安装

要使用pydantic库，可以通过pip命令来安装：

pip install pydantic

安装完成后，即可开始使用pydantic库进行数据验证和序列化操作。

特性

• 数据验证：可以定义数据模型并对数据进行验证。
• 数据序列化：可以将数据序列化为JSON等格式。
• 数据转换：可以将数据转换为特定类型。
• 默认值和选项：可以设置字段的默认值和选项。
• 异常处理：可以处理数据验证过程中的异常情况。

基本功能

1. 定义数据模型

pydantic库可以帮助开发者定义数据模型，并对数据进行验证：

from pydantic import BaseModel

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

# 创建用户对象并进行数据验证
user_data = {"id": 1, "username": "john_doe", "email": "[e-mail]"}
user = User(**user_data)
print(user)

上述代码定义了一个用户数据模型，并对输入数据进行验证和初始化，确保数据符合定义的模型。

2. 数据序列化

pydantic库可以将数据序列化为JSON等格式：

from pydantic import BaseModel

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

user = User(id=1, username="john_doe", email="[e-mail]")
json_data = user.json()
print(json_data)

上述代码将用户对象序列化为JSON格式的数据，方便在网络传输或存储中使用。

高级功能

pydantic库不仅提供基本的数据验证和序列化功能，还具有许多高级功能，可以帮助开发者更灵活地处理数据和定义模型。

1. 自定义校验器

pydantic库允许开发者定义自定义校验器，以实现特定的数据验证逻辑。

例如，定义一个自定义校验器来验证密码复杂度：

from pydantic import BaseModel, constr, validator

class User(BaseModel):
    username: str
    password: constr(min_length=8)

    @validator("password")
    def validate_password(cls, value):
        if not any(char.isdigit() for char in value):
            raise ValueError("Password must contain at least one digit")
        if not any(char.isalpha() for char in value):
            raise ValueError("Password must contain at least one letter")
        return value

# 创建用户对象并进行数据验证
user_data = {"username": "john_doe", "password": "securepassword123"}
user = User(**user_data)
print(user)

上述代码定义了一个用户数据模型，并通过自定义校验器validate_password来验证密码的复杂度，确保密码包含字母和数字。

2. 继承和扩展模型

pydantic库支持模型的继承和扩展，可以在现有模型基础上定义新的模型。

例如，定义一个管理员用户模型，继承自普通用户模型：

from pydantic import BaseModel

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

class AdminUser(User):
    role: str = "admin"

# 创建管理员用户对象并进行数据验证
admin_data = {"username": "admin_user", "email": "[e-mail]", "role": "admin"}
admin_user = AdminUser(**admin_data)
print(admin_user)

上述代码定义了一个管理员用户模型AdminUser，继承自普通用户模型User，并添加了角色字段，默认为管理员角色。

3. 自定义序列化器和反序列化器

pydantic库允许开发者定义自定义序列化器和反序列化器，以实现特定的数据格式转换。

例如，定义一个自定义序列化器来将数据转换为XML格式：

from pydantic import BaseModel, root_validator

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

    @root_validator
    def to_xml(cls, values):
        xml_str = f"<user><username>{values['username']}</username><email>{values['email']}</email></user>"
        return {"xml_data": xml_str}

# 创建用户对象并进行数据转换
user_data = {"username": "john_doe", "email": "[e-mail]"}
user = User(**user_data)
print(user.xml_data)

上述代码定义了一个用户数据模型，并通过自定义序列化器to_xml将数据转换为XML格式的字符串，方便在XML环境中使用。

实际应用场景

pydantic库在实际应用中有广泛的用途，主要包括数据验证、API参数处理、数据序列化和数据库模型定义等方面。

1. 数据验证

pydantic库可以用于验证用户输入数据的合法性，保证数据符合预期的格式和规则。

例如，验证用户注册表单数据：

from pydantic import BaseModel, EmailStr

class UserRegistration(BaseModel):
    username: str
    email: EmailStr
    password: str

# 处理用户注册请求
def register_user(user_data: dict):
    user = UserRegistration(**user_data)
    # 处理注册逻辑
    return "User registered successfully"

# 示例请求数据
request_data = {"username": "john_doe", "email": "[e-mail]", "password": "securepassword123"}
result = register_user(request_data)
print(result)

上述代码通过定义用户注册表单数据模型UserRegistration，并使用pydantic库进行数据验证，确保用户输入的数据合法。

2. API参数处理

pydantic库可以用于处理API接口传入的参数，验证参数的合法性并转换为特定格式。

例如，处理用户搜索接口的请求参数：

from fastapi import FastAPI
from pydantic import BaseModel, constr

app = FastAPI()

class UserSearch(BaseModel):
    keyword: constr(min_length=3)

@app.post("/search")
def search_users(search_data: UserSearch):
    keyword = search_data.keyword
    # 处理搜索逻辑
    return f"Searching users with keyword: {keyword}"

# 示例请求数据
request_data = {"keyword": "john"}
result = search_users(request_data)
print(result)

上述代码定义了一个用户搜索请求参数模型UserSearch，并使用pydantic库进行参数验证和处理，确保传入的关键词长度大于等于3。

3. 数据序列化

pydantic库可以将数据序列化为特定格式，方便在网络传输或存储中使用。

例如，将用户对象序列化为JSON格式：

from pydantic import BaseModel

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

user = User(id=1, username="john_doe", email="[e-mail]")
json_data = user.json()
print(json_data)

上述代码将用户对象序列化为JSON格式的数据，方便在前端页面或API接口中使用。

总结

Python pydantic库是一个功能强大且易于使用的工具，用于数据验证、模型定义和数据序列化。它提供了丰富的特性，包括自定义校验器、模型继承、API参数处理和数据序列化等。在实际应用中，pydantic库可以帮助开发者提高数据处理的效率和准确性，确保数据符合预期的格式和规则。无论是处理用户输入数据、验证API参数、还是进行数据序列化，pydantic都能够简化开发过程并提供可靠的解决方案。