Python的Pydantic概念及基本用法

 更新时间:2026年01月14日 09:37:48   作者:小oo呆  
Pydantic是一个Python库,用于数据验证和解析,它基于TypeHints,提供数据验证和解析功能,基本用法包括定义模型、实例化与验证、字段约束和嵌套使用,常见应用场景包括Web API、配置管理等,这篇文章介绍Python的Pydantic概念及基本用法,感兴趣的朋友跟随小编一起看看吧

Pydantic是Python生态中最流行的数据验证和解析库。绝大多数的Web框架(如FastAPI)和大模型框架LangChain都是基于它构建。简单说他是一个基于Type Hints的库。其核心功能有两个,分别是:

  • 数据验证(Validation):确保你拿到的数据,符合你定义的格式
  • 数据解析(parsing):把凌乱的输入,自动转换成正确的类型

只要模型实例化成功,你就可以百分之百信任这个对象里的数据类型是完全正确的。

一、基本用法

pip install pydantic

1、定义模型

使用 BaseModel 类来创建数据模型:

from pydantic import BaseModel
class User(BaseModel):
    name: str
    age: int  # 如果不匹配,Pydantic 会尝试强制转换
    is_active: bool = True  # 可以有默认值

2、实例化与验证

# 从字典创建实例
user = User(name="Alice", age="25")  # 注意:age 是字符串,但会被转为 int
print(user.name)      # Alice
print(user.age)       # 25 (int)
print(user.is_active) # True
# 访问原始数据
print(user.model_dump())  # {'name': 'Alice', 'age': 25, 'is_active': True}

如果数据不合规,Pydantic 会抛出清晰的错误提示,而不是让程序在后续运行中崩溃。

from pydantic import ValidationError
try:
    User(name="Bob", age="not_a_number")
except ValidationError as e:
    print(e.json()) # 会详细列出格式错误

3、字段约束

字段约束不仅能检查“类型”对不对,还能检查“内容”是否符合业务规则(比如:年龄不能是负数、密码不能太短)。使用 Field 来添加额外的验证规则:

from pydantic import BaseModel, Field
class Product(BaseModel):
    name: str = Field(min_length=2, max_length=50)
    price: float = Field(gt=0)  # 必须大于 0
    tags: list[str] = Field(default=[], min_items=1)
# 示例
Product(name="Laptop", price=999.99, tags=["electronics"])
约束缩写全称适用类型说明
gtgreater thanint, float大于
gegreater than or equalint, float大于等于
ltless thanint, float小于
leless than or equalint, float小于等于
min_length-str, list, dict最小长度
max_length-str, list, dict最大长度
pattern-str正则表达式匹配
allow_inf_nan-float是否允许无穷大或 NaN

4、嵌套使用

可以将不同的数据模型嵌套起来使用。

from typing import List, Optional
from pydantic import BaseModel, Field
# 1. 定义底层模型:商品
class Item(BaseModel):
    name: str
    price: float
    quantity: int = Field(gt=0, description="数量必须大于0")
# 2. 定义底层模型:收货地址
class Address(BaseModel):
    city: str
    street: str
    zip_code: Optional[str] = None
# 3. 定义顶层模型:订单(嵌套了 Item 和 Address)
class Order(BaseModel):
    order_id: int
    items: List[Item]  # 嵌套商品列表
    address: Address   # 嵌套地址对象
    remark: str = "无"
# --- 模拟原始数据(例如来自前端请求或数据库) ---
raw_data = {
    "order_id": 1001,
    "items": [
        {"name": "键盘", "price": 299.0, "quantity": 1},
        {"name": "鼠标", "price": 99.5, "quantity": 2}
    ],
    "address": {
        "city": "上海",
        "street": "南京东路 123 号"
    }
}
# 解析数据
order = Order(**raw_data)
# 访问嵌套数据
print(f"订单 ID: {order.order_id}")
print(f"第一件商品名称: {order.items[0].name}") # 自动补全非常爽
print(f"收货城市: {order.address.city}")
  • 多级校验:当你实例化 Order 时,Pydantic 会递归校验。如果 items 列表里第二个商品的 price 格式不对,它会准确告诉你报错位置。
  • IDE 自动补全:在编写代码时,输入 order.address. 后,IDE 会自动提示 citystreet。这避免了手动处理字典时经常出现的拼写错误。
  • 自动转换:如果 items 里的 price 传的是字符串 "99.5",Pydantic 会自动帮你转成 float

二、常见应用场景

        最常见的场景当然是web API。可以用它来定义 API 的请求体和响应体。FastAPI 会自动根据你的 Pydantic 模型生成文档,并自动校验前端传来的 JSON 数据。其次是进行配置管理,从环境变量或配置文件加载并验证配置。通过 pydantic-settings 扩展,可以轻松读取环境变量(.env 文件)。

pip install pydantic-settings
from pydantic_settings import BaseSettings
class Settings(BaseSettings):
    db_url: str
    api_key: str
    class Config:
        env_file = ".env"
settings = Settings() # 自动从环境变量加载并校验

到此这篇关于Python的Pydantic概念及基本用法的文章就介绍到这了,更多相关Python Pydantic内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Python requests发送post请求的一些疑点

    Python requests发送post请求的一些疑点

    在Python爬虫中,使用requests发送请求,访问指定网站,是常见的做法,这篇文章主要介绍了Python requests发送post请求的一些疑点,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-05-05
  • python basemap 画出经纬度并标定的实例

    python basemap 画出经纬度并标定的实例

    今天小编就为大家分享一篇python basemap 画出经纬度并标定的实例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-07-07
  • Python Django使用forms来实现评论功能

    Python Django使用forms来实现评论功能

    这篇文章主要为大家详细介绍了Python Django使用forms来实现评论功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • Python 面向对象 成员的访问约束

    Python 面向对象 成员的访问约束

    在Java,C++,以及PHP中都有对应的关键字,public,protected,private,但是在Python中却没有这些关键字来声明类成员的访问作用域。
    2008-12-12
  • 基于进程内通讯的python聊天室实现方法

    基于进程内通讯的python聊天室实现方法

    这篇文章主要介绍了基于进程内通讯的python聊天室实现方法,实例分析了Python聊天室的相关实现技巧,需要的朋友可以参考下
    2015-06-06
  • Django框架之django admin的命令行详解

    Django框架之django admin的命令行详解

    这篇文章主要介绍了Django框架之django admin的命令行知识,文中通过示例代码给大家介绍的非常详细,需要的朋友可以参考下
    2021-09-09
  • Python爬取你好李焕英豆瓣短评生成词云的示例代码

    Python爬取你好李焕英豆瓣短评生成词云的示例代码

    这篇文章主要介绍了Python爬取你好李焕英豆瓣短评生成词云,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-02-02
  • Python googletrans库使用示例详解

    Python googletrans库使用示例详解

    googletrans是一个基于谷歌翻译API的Python库,支持多种语言的自动检测和翻译,提供了translate和detect方法,用于翻译文本和检测文本语言,通过简单的命令即可安装使用,适合需要实现多语言翻译功能的开发者
    2024-09-09
  • Python常遇到的错误和异常

    Python常遇到的错误和异常

    这篇文章主要介绍了Python常遇到的错误和异常,在日常的学习Python过程中,由于本身的编程水平受限,时不时的给我抛出一个异常让我真的很难受;在学习的过程中发现Python中的错误分为语法错误和异常两种。下面来看看下面文章错误异常的实例,需要的朋友可以参考一下
    2021-11-11
  • Python3.10新特性之match语句示例详解

    Python3.10新特性之match语句示例详解

    这篇文章主要为大家介绍了Python3.10新特性之match语句示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02

最新评论