python常用库之数据验证库pydantic

文章目录

python常用库之pydantic
- 什么是Pydantic
- - “为什么 Pydantic 是这样命名的？”
  - 为什么使用 Pydantic?
- 安装 Pydantic
- 工作常用
- - BaseModel
  - ConfigDict
  - model_validator

python常用库之pydantic

官方文档：https://docs.pydantic.dev/latest/
Pydantic 官方文档：https://pydantic.com.cn/

什么是Pydantic

Pydantic 是 Python 中使用最广泛的数据验证库。

Pydantic 会检查传入的数据类型是否符合定义的类型。例如，如果某个属性被定义为 int，而用户传入了一个字符串，Pydantic 会抛出一个错误，确保数据的正确性。

“为什么 Pydantic 是这样命名的？”

“Pydantic”这个名字是“Py”和“pedantic”的混合词。“Py”部分表示该库与 Python 相关，而“pedantic”指的是该库在数据验证和类型强制方面的细致方法。

综合这些元素，“Pydantic”描述了我们的 Python 库，它提供了注重细节、严格的数据验证。

我们意识到具有讽刺意味的是，Pydantic V1 在其验证中并不严格，所以如果我们很“吹毛求疵”的话，在 V2 版本之前，“Pydantic”是一个用词不当的名称😉。

为什么使用 Pydantic?

由类型提示驱动——借助 Pydantic，模式验证和序列化由类型注释控制；学习的更少，编写的代码更少，并且与您的 IDE 和静态分析工具集成。
速度——Pydantic 的核心验证逻辑是用 Rust 编写的。因此，Pydantic 是 Python 中最快的数据验证库之一。
JSON 模式——Pydantic 模型可以生成 JSON 模式，从而便于与其他工具进行集成。
严格模式和宽松模式——Pydantic 可以在 strict=True 模式（数据不进行转换）或 strict=False 模式下运行（在适当的情况下，Pydantic 尝试将数据强制转换为正确类型）。
数据类、类型字典等——Pydantic 支持对许多标准库类型的验证，包括 dataclass 和 TypedDict 。
自定义——Pydantic 允许自定义验证器和序列化器以多种强大方式改变数据的处理方式。
生态系统——PyPI 上约有 8000 个包使用 Pydantic，包括像 FastAPI、 huggingface、Django Ninja、SQLModel 和 LangChain 这样极受欢迎的库。
经过实战检验——Pydantic 每月被下载超过 7000 万次，被所有 FAANG 公司以及纳斯达克 25 家最大公司中的 20 家所使用。如果你正试图用 Pydantic 做某事，那么可能其他人已经做过了。

安装 Pydantic

pip install pydantic

工作常用

BaseModel：用于定义数据模型，提供数据验证和序列化功能。
ConfigDict：用于配置模型的行为，控制额外字段的处理等。
model_validator：用于添加自定义验证逻辑，增强模型的验证能力。
这三个组件结合使用，可以帮助开发者构建健壮且灵活的数据模型，确保数据的有效性和一致性。

BaseModel

BaseModel 是 Pydantic 的基础类，所有数据模型都应该继承自它。它提供了数据验证、序列化和反序列化等功能。

from pydantic import BaseModel  class User(BaseModel):  id: int  name: str  email: str  # 创建模型实例  
user = User(id=1, name="Alice", email="alice@example.com")  # 访问属性  
print(user.name)  # 输出: Alice  # 验证数据  
try:  user_invalid = User(id="not-an-int", name="Bob", email="bob@example.com")  
except ValueError as e:  print(e)  # 输出: 1 validation error for User  # id  #   value is not a valid integer (type=type_error.integer)

BaseModel 是 Pydantic 的基础类，所有数据模型都应该继承自它。它提供了数据验证、序列化和反序列化等功能。

使用方法
定义模型：通过继承 BaseModel，你可以定义自己的
数据模型。
属性定义：使用 Python 的类型提示来定义模型的属性及其类型。
数据验证：在创建模型实例时，Pydantic 会自动验证传入的数据是否符合定义的类型。

ConfigDict

ConfigDict 是 Pydantic 2.x 中引入的配置类，用于定义模型的配置选项。它允许开发者控制模型的行为，例如是否允许额外的字段、是否允许使用字段名称填充模型等。

from pydantic import BaseModel, ConfigDict  class User(BaseModel):  id: int  name: str  model_config = ConfigDict(  extra="forbid"  # 禁止额外字段  )  # 创建模型实例  
try:  user = User(id=1, name="Alice", age=30)  # age 是额外字段  
except ValueError as e:  print(e)  # 输出: 1 validation error for User  # extra fields not permitted (type=value_error.extra)

定义配置：在模型内部定义一个名为 model_config 的属性，并将其设置为 ConfigDict 的实例。
配置选项：可以通过 ConfigDict 的参数来设置模型的行为。

model_validator

model_validator 是一个装饰器，用于在模型实例创建之前或之后执行自定义验证逻辑。它允许开发者在模型的生命周期中添加额外的验证规则。

定义验证方法：在模型类中定义一个方法，并使用 @model_validator 装饰器标记它。
指定验证模式：可以指定验证是在实例创建之前（mode="before"）还是之后（mode="after"）进行。

from pydantic import BaseModel, model_validator  class User(BaseModel):  id: int  name: str  email: str  @model_validator(mode="before")  @classmethod  def validate_email(cls, values):  email = values.get('email')  if email and "@" not in email:  raise ValueError("Invalid email address")  return values  # 创建模型实例  
try:  user = User(id=1, name="Alice", email="aliceexample.com")  # 邮箱格式不正确  
except ValueError as e:  print(e)  # 输出: 1 validation error for User  # Invalid email address