.py · text/x-python

Pydantic v2: Python Pydantic v2 資料模型 (BaseModel)

Pydantic v2 模型結合 Python 型別提示與 BaseModel 類別(為駝峰式 JSON 鍵加上 Field 別名),由 Rust 核心提供極速驗證。

快速解答: Pydantic v2 模型結合 Python 型別提示與 BaseModel 類別(為駝峰式 JSON 鍵加上 Field 別名),由 Rust 核心提供極速驗證。 FastAPI 端點開發、Python LLM 結構化輸出與 Python 3.10+ 嚴格資料驗證。

結構類型具型別程式碼
人類可讀性高
支援巢狀結構支援
LLM Token 效率中
副檔名.py
MIME 類型text/x-python
最適合用於FastAPI 端點開發、Python LLM 結構化輸出與 Python 3.10+ 嚴格資料驗證。

核心優勢

  • FastAPI、OpenAI 與 LangGraph 原生採用的結構化輸出 Schema 標準
  • 自動保留符合 Python 慣例的 snake_case 欄位並以 Field(alias=...) 對應
  • Pydantic v2 的 Rust 驗證核心使 JSON 解析效能大幅躍升數個數量級

限制與權衡

  • Pydantic v1 與 v2 部分 API 語法有所差異(model_validate 取代 parse_obj)
  • Python 保留關鍵字或駝峰 JSON 鍵名必須仰賴 Field(alias=...) 映射
  • 循環或前向參照須引入 from __future__ import annotations

參考資料

在本機轉換與清理 Pydantic v2

相關工程指南

Pydantic v2 常見問題

JSON 轉 Pydantic 如何處理像 userId 這類駝峰 JSON 鍵名?

TxtTo 會自動將鍵名轉成符合 PEP 8 的 snake_case (user_id),同時附加 Field(alias="userId") 讓 Pydantic v2 無縫剖析 JSON。

巢狀物件會被提取成獨立的頂層 Python 類別嗎?

會的。巢狀 JSON 物件會整齊提升並依序宣告於根模型上方的獨立 BaseModel 類別中。

為何 Pydantic v2 輸出需包含 from __future__ import annotations?

這能確保在 Python 3.9+ 環境順暢支援現代 PEP 604 聯集型別寫法(str | None)與前向類別參照。