Python数据验证神器Pydantic库的使用和实践中的避坑指南

# 传统验证的噩梦代码片段
def create_user(data: dict):
    if 'name' not in data:
        raise ValueError("Missing name")
    if len(data['name']) > 20:
        raise ValueError("Name too long")
    if 'email' not in data:
        raise ValueError("Missing email")
    if not re.match(r"[^@]+@[^@]+\.[^@]+", data['email']):
        raise ValueError("Invalid email")
    # 此处省略20个字段验证...

from pydantic import BaseModel, EmailStr

class UserCreateRequest(BaseModel):
    name: str  # 自动识别为必填字段！
    email: EmailStr  # 自带邮箱格式核武器
    age: int = 18  # 默认值这么写太优雅了吧？

# 正确数据
user_data = {"name": "张三", "email": "zhangsan@example.com"}
user = UserCreateRequest(**user_data)  # 自动验证并转换类型！

# 错误数据
bad_data = {"name": "李四", "email": "lisi#wrong.com"}
user = UserCreateRequest(**bad_data)  # 自动抛出ValidationError！

{
  "detail": [
    {
      "loc": ["email"],
      "msg": "value is not a valid email address",
      "type": "value_error.email"
    }
  ]
}

from datetime import datetime
from pydantic import HttpUrl, PositiveInt

class Product(BaseModel):
    id: PositiveInt  # 自动拒绝负数！
    url: HttpUrl      # 自动验证URL格式
    created_at: datetime  # 自动把字符串转成datetime对象

from pydantic import validator

class UserProfile(BaseModel):
    username: str
    
    @validator('username')
    def name_must_contain_letter(cls, v):
        if not any(char.isalpha() for char in v):
            raise ValueError('必须包含字母！')
        return v

from fastapi import FastAPI

app = FastAPI()

@app.post("/users")
def create_user(user: UserCreateRequest):  # 此处自动完成验证！
    # 直接使用user.name, user.email等强类型属性
    return {"message": f"用户{user.name}创建成功"}

# 错误示范（时区炸弹！）
birthday: datetime  # 可能引发时区混乱

# 正确姿势
from datetime import datetime
from pydantic import AwareDatetime

birthday: AwareDatetime  # 强制要求带时区

class Config:
    # 开启这个让解析速度飞起！
    anystr_strip_whitespace = True  
    
    # 禁止多余字段（防恶意传参！）
    extra = 'forbid'  

from pydantic import Field

class Payment(BaseModel):
    amount: float = Field(..., gt=0, description="支付金额必须为正数") 
    card_id: str = Field(..., min_length=16, max_length=19)

# 基础模型
class UserBase(BaseModel):
    email: EmailStr

# 创建专用
class UserCreate(UserBase):
    password: str

# 响应专用（隐藏密码字段）
class UserResponse(UserBase):
    id: int

# SQLAlchemy模型
class UserModel(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    name = Column(String(50))

# Pydantic模型
class UserResponse(BaseModel):
    id: int
    name: str

    # 添加这个配置实现自动转换！
    class Config:
        orm_mode = True  # 魔法开关！！！

# 使用示例
db_user = session.query(UserModel).first()
response_data = UserResponse.from_orm(db_user)  # 自动转换！

from pydantic import SecretStr

class LoginRequest(BaseModel):
    username: str
    password: SecretStr  # 自动屏蔽日志输出！！！

# 使用时
print(request.password)  # 输出：**********
real_pwd = request.password.get_secret_value()  # 获取真实值

@app.post("/login")
def login(credentials: LoginRequest):
    ...