Python Pydantic示例

Pydantic 是一個基於類型註解的Python 庫，用於數據驗證和模型定義。 1. 可通過繼承BaseModel 定義模型，字段支持類型檢查與默認值；2. 自動驗證數據類型，錯誤時拋出ValidationError；3. 使用@validator 裝飾器實現自定義驗證邏輯，如範圍檢查、格式校驗；4. 支持從字典、JSON 字符串解析數據，使用parse_obj 或parse_raw 方法；5. 可嵌套模型處理複雜結構，如列表中的對象；6. 推薦使用model_dump() 和model_dump_json() 輸出數據，支持Config 配置如extra="ignore" 忽略多餘字段，廣泛用於FastAPI 等場景，使數據處理安全且簡潔。

Pydantic 是一個非常流行的Python 庫，用於數據解析、驗證和類型提示。它基於Python 的類型註解（type hints），可以自動驗證數據結構，非常適合處理API 請求、配置文件、數據模型等場景。

下面是一個實用的Pydantic 示例，展示如何定義模型、進行數據驗證、處理錯誤以及一些常用功能。

✅ 基本模型定義與數據驗證

from pydantic import BaseModel, ValidationError
from typing import Optional

class User(BaseModel):
    name: str
    age: int
    email: str
    is_active: bool = True # 默認值nickname: Optional[str] = None # 可選字段# 正常數據try:
    user = User(
        name="Alice",
        age=30,
        email="alice@example.com",
        nickname="Al"
    )
    print(user)
    # 輸出: name='Alice' age=30 email='alice@example.com' is_active=True nickname='Al'
except ValidationError as e:
    print(e)

⚠️ 數據驗證失敗示例

# 錯誤數據：age 是字符串，不符合int 類型try:
    user = User(
        name="Bob",
        age="not_a_number", # 錯誤類型email="bob@example.com"
    )
except ValidationError as e:
    print(e)
    # 輸出詳細錯誤信息，比如：
    # 1 validation error for User
    # age
    # value is not a valid integer (type=type_error.integer)

?️ 自定義驗證邏輯（使用@validator ）

 from pydantic import validator
import re

class User(BaseModel):
    name: str
    age: int
    email: str
    website: Optional[str] = None

    @validator('age')
    def check_age(cls, v):
        if v < 0 or v > 150:
            raise ValueError(&#39;Age must be between 0 and 150&#39;)
        return v

    @validator(&#39;email&#39;)
    def validate_email(cls, v):
        if not re.match(r&#39;^[^@] @[^@] \.[^@] $&#39;, v):
            raise ValueError(&#39;Invalid email format&#39;)
        return v

    @validator(&#39;website&#39;, pre=True) # pre=True 表示在類型轉換前處理def validate_website(cls, v):
        if v and not v.startswith((&#39;http://&#39;, &#39;https://&#39;)):
            v = &#39;https://&#39; v
        return v

# 測試try:
    user = User(
        name="Charlie",
        age=25,
        email="charlie@example.com",
        website="example.com"
    )
    print(user.website) # 輸出: https://example.com
except ValidationError as e:
    print(e)

? 從JSON 或字典加載數據

data = {
    "name": "Diana",
    "age": 28,
    "email": "diana@example.com"
}

user = User(**data)
print(user.json(indent=2))
# 輸出格式化JSON

或者使用.parse_obj() ：

 user = User.parse_obj(data)

也可以從JSON 字符串解析：

 import json

json_str = '{"name": "Eve", "age": 35, "email": "eve@example.com"}'
user = User.parse_raw(json_str)

? 模型嵌套（複雜結構）

 from typing import List

class Address(BaseModel):
    city: str
    zipcode: str

class Person(BaseModel):
    name: str
    addresses: List[Address]

# 使用示例data = {
    "name": "Frank",
    "addresses": [
        {"city": "Beijing", "zipcode": "100001"},
        {"city": "Shanghai", "zipcode": "200001"}
    ]
}

person = Person(**data)
print(person.json(indent=2))

? 小貼士

• 使用model_dump()替代舊版的dict() （Pydantic v2 推薦）
• 使用model_dump_json()輸出JSON 字符串
• 支持默認工廠（ default_factory ）
• 可設置Config控制行為，比如忽略未知字段：

 class User(BaseModel):
    name: str

    class Config:
        extra = "ignore" # 忽略多餘字段

基本上就這些。 Pydantic 讓數據驗證變得簡單、清晰，尤其在FastAPI 中被廣泛使用。不復雜，但非常實用。

以上是Python Pydantic示例的詳細內容。更多資訊請關注PHP中文網其他相關文章！