Python的Pydantic概念及基本用法

更新時間：2026年01月14日 09:37:48 作者：小oo呆

Pydantic是一個Python庫,用于數(shù)據(jù)驗證和解析,它基于TypeHints,提供數(shù)據(jù)驗證和解析功能,基本用法包括定義模型、實例化與驗證、字段約束和嵌套使用,常見應用場景包括Web API、配置管理等,這篇文章介紹Python的Pydantic概念及基本用法,感興趣的朋友跟隨小編一起看看吧

一、基本用法

pip install pydantic

1、定義模型

使用 BaseModel 類來創(chuàng)建數(shù)據(jù)模型：

from pydantic import BaseModel
class User(BaseModel):
    name: str
    age: int  # 如果不匹配，Pydantic 會嘗試強制轉(zhuǎn)換
    is_active: bool = True  # 可以有默認值

2、實例化與驗證

# 從字典創(chuàng)建實例
user = User(name="Alice", age="25")  # 注意：age 是字符串，但會被轉(zhuǎn)為 int
print(user.name)      # Alice
print(user.age)       # 25 (int)
print(user.is_active) # True
# 訪問原始數(shù)據(jù)
print(user.model_dump())  # {'name': 'Alice', 'age': 25, 'is_active': True}

如果數(shù)據(jù)不合規(guī)，Pydantic 會拋出清晰的錯誤提示，而不是讓程序在后續(xù)運行中崩潰。

from pydantic import ValidationError
try:
    User(name="Bob", age="not_a_number")
except ValidationError as e:
    print(e.json()) # 會詳細列出格式錯誤

3、字段約束

字段約束不僅能檢查“類型”對不對，還能檢查“內(nèi)容”是否符合業(yè)務規(guī)則（比如：年齡不能是負數(shù)、密碼不能太短）。使用 Field 來添加額外的驗證規(guī)則：

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"])

約束縮寫	全稱	適用類型	說明
`gt`	greater than	`int`, `float`	大于
`ge`	greater than or equal	`int`, `float`	大于等于
`lt`	less than	`int`, `float`	小于
`le`	less than or equal	`int`, `float`	小于等于
`min_length`	-	`str`, `list`, `dict`	最小長度
`max_length`	-	`str`, `list`, `dict`	最大長度
`pattern`	-	`str`	正則表達式匹配
`allow_inf_nan`	-	`float`	是否允許無窮大或 NaN

4、嵌套使用

可以將不同的數(shù)據(jù)模型嵌套起來使用。

from typing import List, Optional
from pydantic import BaseModel, Field
# 1. 定義底層模型：商品
class Item(BaseModel):
    name: str
    price: float
    quantity: int = Field(gt=0, description="數(shù)量必須大于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 = "無"
# --- 模擬原始數(shù)據(jù)（例如來自前端請求或數(shù)據(jù)庫） ---
raw_data = {
    "order_id": 1001,
    "items": [
        {"name": "鍵盤", "price": 299.0, "quantity": 1},
        {"name": "鼠標", "price": 99.5, "quantity": 2}
    ],
    "address": {
        "city": "上海",
        "street": "南京東路 123 號"
    }
}
# 解析數(shù)據(jù)
order = Order(**raw_data)
# 訪問嵌套數(shù)據(jù)
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 會自動提示 city 和 street。這避免了手動處理字典時經(jīng)常出現(xiàn)的拼寫錯誤。
自動轉(zhuǎn)換：如果 items 里的 price 傳的是字符串 "99.5"，Pydantic 會自動幫你轉(zhuǎn)成 float。

二、常見應用場景

最常見的場景當然是web API。可以用它來定義 API 的請求體和響應體。FastAPI 會自動根據(jù)你的 Pydantic 模型生成文檔，并自動校驗前端傳來的 JSON 數(shù)據(jù)。其次是進行配置管理，從環(huán)境變量或配置文件加載并驗證配置。通過 pydantic-settings 擴展，可以輕松讀取環(huán)境變量（.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() # 自動從環(huán)境變量加載并校驗

到此這篇關于Python的Pydantic概念及基本用法的文章就介紹到這了,更多相關Python Pydantic內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: