Pydantic严格模式详解:如何精确控制数据验证行为
pydantic Data validation using Python type hints 项目地址: https://gitcode.com/gh_mirrors/py/pydantic
什么是严格模式
Pydantic默认采用"宽松模式"进行数据验证,这意味着它会尽可能尝试将输入数据转换为目标类型。例如,当期望一个整数字段时,传入字符串"123"会被自动转换为整数123。这种自动转换在日常开发中非常实用,特别是在处理HTTP请求参数、环境变量等场景时。
然而在某些严格要求类型精确匹配的场景下,这种自动转换可能带来问题。为此,Pydantic提供了"严格模式"(Strict Mode),在该模式下,Pydantic会严格执行类型检查,拒绝任何隐式类型转换。
严格模式的核心特性
严格模式的核心特点是类型精确匹配。在严格模式下:
- 对于基本类型(如int、float、bool等),只接受对应类型的实例
- 对于复杂类型(如UUID、datetime等),同样要求精确匹配
- 从JSON数据验证时规则会略有放宽(后面会详细说明)
启用严格模式的四种方式
Pydantic提供了多种启用严格模式的方法,开发者可以根据需求选择最适合的方式。
1. 在验证方法中启用
最直接的方式是在调用验证方法时传入strict=True
参数:
from pydantic import BaseModel
class User(BaseModel):
age: int
# 宽松模式(默认)
user = User.model_validate({"age": "25"}) # 自动转换成功
# 严格模式
try:
user = User.model_validate({"age": "25"}, strict=True)
except Exception as e:
print(e) # 报错:输入应该是有效的整数
这种方式适用于临时性的严格验证需求,不会影响模型的其他使用场景。
2. 使用Field设置字段级严格模式
如果需要对特定字段启用严格模式,可以使用Field
:
from pydantic import BaseModel, Field
class Product(BaseModel):
id: int = Field(strict=True) # 该字段启用严格模式
price: float # 该字段保持宽松模式
try:
p = Product(id="123", price="99.9") # id字段会触发严格验证
except Exception as e:
print(e) # id字段验证失败
3. 使用Strict类型注解
Pydantic提供了Strict
类型,可以与Annotated
配合使用:
from typing import Annotated
from pydantic import BaseModel, Strict
class Account(BaseModel):
is_verified: Annotated[bool, Strict()] # 严格验证布尔值
try:
a = Account(is_verified="true") # 字符串无法通过严格验证
except Exception as e:
print(e)
Pydantic还内置了一些严格类型别名,如StrictInt
、StrictBool
等,可以直接使用。
4. 通过ConfigDict全局启用
如果希望整个模型都使用严格模式,可以通过配置实现:
from pydantic import BaseModel, ConfigDict
class Config(BaseModel):
model_config = ConfigDict(strict=True)
api_key: str
timeout: int
try:
c = Config(api_key="abc", timeout="30") # 所有字段都会严格验证
except Exception as e:
print(e) # timeout字段验证失败
严格模式下的特殊行为
JSON数据验证的特殊处理
从JSON数据验证时,Pydantic会适当放宽严格模式的限制。例如UUID字段:
import json
from uuid import UUID
from pydantic import BaseModel
class Resource(BaseModel):
uid: UUID
data = {"uid": "12345678-1234-1234-1234-123456789012"}
# 从Python字典验证(严格模式失败)
try:
Resource.model_validate(data, strict=True)
except Exception as e:
print(e)
# 从JSON字符串验证(严格模式成功)
Resource.model_validate_json(json.dumps(data), strict=True)
这是因为JSON本身是字符串格式,对某些类型进行适当转换是合理的。
嵌套模型的严格模式
默认情况下,严格模式不会递归应用到嵌套模型。要使嵌套模型也启用严格模式,需要显式配置:
from pydantic import BaseModel, ConfigDict
class InnerModel(BaseModel):
model_config = ConfigDict(strict=True)
value: int
class OuterModel(BaseModel):
model_config = ConfigDict(strict=True)
inner: InnerModel
try:
OuterModel(inner={"value": "123"}) # 嵌套模型也会严格验证
except Exception as e:
print(e)
实际应用建议
- API边界:在接收外部输入(如HTTP请求)时使用严格模式,防止意外类型转换
- 配置验证:应用配置通常需要精确匹配,适合使用严格模式
- 核心业务逻辑:关键业务数据建议使用严格模式保证数据一致性
- 数据转换层:在需要显式转换的场景可以关闭严格模式
严格模式是Pydantic强大的验证功能之一,合理使用可以显著提高代码的健壮性和可维护性。根据具体场景选择适当的启用方式,可以在灵活性和严格性之间取得良好平衡。
pydantic Data validation using Python type hints 项目地址: https://gitcode.com/gh_mirrors/py/pydantic
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考