Python Pydantic示例

Pydantic 是一个基于类型注解的 Python 库，用于数据验证和模型定义。1. 可通过继承 BaseModel 定义模型，字段支持类型检查与默认值；2. 自动验证数据类型，错误时抛出 ValidationError；3. 使用 @validator 装饰器实现自定义验证逻辑，如范围检查、格式校验；4. 支持从字典、JSON 字符串解析数据，使用 parse_obj 或 parse_raw 方法；5. 可嵌套模型处理复杂结构，如列表中的对象；6. 推荐使用 model_dump() 和 model_dump_json() 输出数据，支持 Config 配置如 extra="ignore" 忽略多余字段，广泛用于 FastAPI 等场景，使数据处理安全且简洁。

Pydantic 是一个非常流行的 Python 库，用于数据解析、验证和类型提示。它基于 Python 的类型注解（type hints），可以自动验证数据结构，非常适合处理 API 请求、配置文件、数据模型等场景。

下面是一个实用的 Pydantic 示例，展示如何定义模型、进行数据验证、处理错误以及一些常用功能。

✅ 基本模型定义与数据验证

from pydantic import BaseModel, ValidationError
from typing import Optional

class User(BaseModel):
    name: str
    age: int
    email: str
    is_active: bool = True  # 默认值
    nickname: Optional[str] = None  # 可选字段

# 正常数据
try:
    user = User(
        name="Alice",
        age=30,
        email="alice@example.com",
        nickname="Al"
    )
    print(user)
    # 输出: name='Alice' age=30 email='alice@example.com' is_active=True nickname='Al'
except ValidationError as e:
    print(e)

⚠️ 数据验证失败示例

# 错误数据：age 是字符串，不符合 int 类型
try:
    user = User(
        name="Bob",
        age="not_a_number",  # 错误类型
        email="bob@example.com"
    )
except ValidationError as e:
    print(e)
    # 输出详细错误信息，比如：
    # 1 validation error for User
    # age
    #   value is not a valid integer (type=type_error.integer)

?️ 自定义验证逻辑（使用 @validator）

from pydantic import validator
import re

class User(BaseModel):
    name: str
    age: int
    email: str
    website: Optional[str] = None

    @validator('age')
    def check_age(cls, v):
        if v < 0 or v > 150:
            raise ValueError('Age must be between 0 and 150')
        return v

    @validator('email')
    def validate_email(cls, v):
        if not re.match(r'^[^@] @[^@] \.[^@] $', v):
            raise ValueError('Invalid email format')
        return v

    @validator('website', pre=True)  # pre=True 表示在类型转换前处理
    def validate_website(cls, v):
        if v and not v.startswith(('http://', 'https://')):
            v = 'https://'   v
        return v

# 测试
try:
    user = User(
        name="Charlie",
        age=25,
        email="charlie@example.com",
        website="example.com"
    )
    print(user.website)  # 输出: https://example.com
except ValidationError as e:
    print(e)

? 从 JSON 或字典加载数据

data = {
    "name": "Diana",
    "age": 28,
    "email": "diana@example.com"
}

user = User(**data)
print(user.json(indent=2))
# 输出格式化 JSON

或者使用 .parse_obj()：

user = User.parse_obj(data)

也可以从 JSON 字符串解析：

import json

json_str = '{"name": "Eve", "age": 35, "email": "eve@example.com"}'
user = User.parse_raw(json_str)

? 模型嵌套（复杂结构）

from typing import List

class Address(BaseModel):
    city: str
    zipcode: str

class Person(BaseModel):
    name: str
    addresses: List[Address]

# 使用示例
data = {
    "name": "Frank",
    "addresses": [
        {"city": "Beijing", "zipcode": "100001"},
        {"city": "Shanghai", "zipcode": "200001"}
    ]
}

person = Person(**data)
print(person.json(indent=2))

? 小贴士

• 使用 model_dump() 替代旧版的 dict()（Pydantic v2 推荐）
• 使用 model_dump_json() 输出 JSON 字符串
• 支持默认工厂（default_factory）
• 可设置 Config 控制行为，比如忽略未知字段：

class User(BaseModel):
    name: str

    class Config:
        extra = "ignore"  # 忽略多余字段

基本上就这些。Pydantic 让数据验证变得简单、清晰，尤其在 FastAPI 中被广泛使用。不复杂，但非常实用。

以上是Python Pydantic示例的详细内容。更多信息请关注PHP中文网其他相关文章！