当前位置：首页 > java >正文

PyDantic入门介绍：Python数据验证与解析的利器

java 2025/5/5 19:36:04

pydantic

在Python开发中，数据验证和解析是非常常见且重要的任务。PyDantic是一个强大且易用的库，专门用于定义数据模型并自动验证输入数据的结构和类型，极大地简化了数据处理流程。许多开发框架本身也用到了PyDantic,比如LangChain

本文将带你快速了解PyDantic的核心功能，并通过代码示例展示如何使用它。

什么是PyDantic？

PyDantic是一个基于Python类型注解的数据验证和解析库。你可以通过定义继承自BaseModel的模型类，指定字段类型，PyDantic会自动帮你验证数据是否符合预期，并将数据转换成对应的Python对象。它不仅支持基本类型，还支持复杂嵌套结构，且提供详细的错误信息，方便调试。

PyDantic广泛应用于FastAPI等现代Python框架中，用于请求体、响应体的数据验证和序列化。

PyDantic的安装

使用pip即可快速安装：

pip install pydantic

PyDantic基础用法

1. 定义数据模型

定义模型只需继承BaseModel，并使用Python的类型注解声明字段类型：

from pydantic import BaseModelclass Person(BaseModel):name: strage: inthobby: list

这里定义了一个Person模型，包含name（字符串）、age（整数）和hobby（列表）三个字段。

2. 创建模型实例并验证数据

通过传入字典数据创建模型实例，PyDantic会自动验证数据类型：

data = {"name": "Alice", "age": 30, "hobby": ["football"]}
person = Person(**data)
print(person)

输出：

name='Alice' age=30 hobby=['football']

如果数据类型不匹配，会抛出ValidationError异常：

data = {"name": "Bob", "age": "thirty", "hobby": "basketball"}
person = Person(**data)  # 会抛出异常

异常信息示例：

pydantic.error_wrappers.ValidationError: 2 validation errors for Person
agevalue is not a valid integer (type=type_error.integer)
hobbyvalue is not a valid list (type=type_error.list)

3. 访问字段和转换为字典

模型实例的字段可以像普通属性访问，也可以转换为字典：

print(person.name)  # 输出：Alice
print(person.dict())  # 输出：{'name': 'Alice', 'age': 30, 'hobby': ['football']}

4. 处理验证错误

可以使用try-except捕获验证错误，方便程序做出相应处理：

from pydantic import ValidationErrortry:data = {"name": "Muller", "age": "thirty", "hobby": ["football"]}person = Person(**data)
except ValidationError as e:print(e)

输出错误详情：

1 validation error for Person
agevalue is not a valid integer (type=type_error.integer)

5. 自定义验证规则

PyDantic支持自定义验证器，使用@validator装饰器定义字段的额外验证逻辑：

from pydantic import validatorclass Person(BaseModel):name: strage: inthobby: list@validator("age")def age_must_be_positive(cls, age):if age < 0:raise ValueError("Age must be a positive integer")return age

这样可以确保age字段必须为正整数。

进阶示例：使用Field定义字段约束

PyDantic的Field函数可以为字段添加描述、默认值及约束条件：

from pydantic import BaseModel, Fieldclass Product(BaseModel):name: strprice: float = Field(..., description="商品价格", gt=1, lt=1000)product = Product(name="Laptop", price=999.99)
print(product)