在構(gòu)建現(xiàn)代 Web 應(yīng)用時(shí)，我們往往需要處理復(fù)雜的輸入和輸出數(shù)據(jù)結(jié)構(gòu)。例如，響應(yīng)數(shù)據(jù)可能包含嵌套字典、列表、元組，甚至是多個(gè)嵌套對(duì)象。Pydantic 是一個(gè)強(qiáng)大的數(shù)據(jù)驗(yàn)證和序列化庫(kù)，可以幫助我們輕松地處理這些復(fù)雜的數(shù)據(jù)結(jié)構(gòu)，并通過(guò)自定義方法進(jìn)行驗(yàn)證和轉(zhuǎn)換。

本文將介紹如何使用 Pydantic 處理復(fù)雜數(shù)據(jù)結(jié)構(gòu)，包括嵌套模型、嵌套字典、列表、元組等，及如何使用自定義方法進(jìn)行數(shù)據(jù)驗(yàn)證。

1. Pydantic 簡(jiǎn)介

Pydantic 通過(guò)定義 Python 類并繼承 BaseModel，使得開(kāi)發(fā)者能夠輕松定義數(shù)據(jù)模型并進(jìn)行自動(dòng)驗(yàn)證。Pydantic 支持多種數(shù)據(jù)類型，包括基本類型（如 int、str 等）和更復(fù)雜的類型（如 List、Dict、Tuple、嵌套模型等）。

2. 嵌套模型

2.1 嵌套模型的定義

在許多應(yīng)用場(chǎng)景中，數(shù)據(jù)往往具有層級(jí)結(jié)構(gòu)。例如，一個(gè)訂單可能包含多個(gè)商品項(xiàng)，每個(gè)商品項(xiàng)都有自己的名稱、數(shù)量和價(jià)格。我們可以通過(guò)嵌套 Pydantic 模型來(lái)處理這種層級(jí)結(jié)構(gòu)。

假設(shè)我們有以下數(shù)據(jù)結(jié)構(gòu)：一個(gè)訂單包含用戶信息和多個(gè)商品項(xiàng)。我們可以定義兩個(gè)模型，User 和 Item，并在 Order 模型中嵌套這兩個(gè)模型。

from pydantic import BaseModel
from typing import Listclass Item(BaseModel):name: strquantity: intprice: floatclass User(BaseModel):name: stremail: strclass Order(BaseModel):user: Useritems: List[Item]total_amount: float

在這個(gè)例子中：

• Order 模型嵌套了 User 和 Item 模型。
• items 字段是一個(gè) Item 對(duì)象的列表，表示訂單中的多個(gè)商品項(xiàng)。
• total_amount 字段表示訂單總金額。

2.2 使用嵌套模型

我們可以像下面這樣創(chuàng)建一個(gè)訂單對(duì)象：

order_data = {"user": {"name": "John Doe", "email": "john.doe@example.com"},"items": [{"name": "Laptop", "quantity": 1, "price": 1200.00},{"name": "Mouse", "quantity": 2, "price": 25.50}],"total_amount": 1251.00
}order = Order(**order_data)
print(order)

輸出將是：

user=User(name='John Doe', email='john.doe@example.com') 
items=[Item(name='Laptop', quantity=1, price=1200.0), Item(name='Mouse', quantity=2, price=25.5)] 
total_amount=1251.0

2.3 嵌套字典和列表

Pydantic 模型也可以處理嵌套字典和列表結(jié)構(gòu)。假設(shè)我們有一個(gè)場(chǎng)景，其中每個(gè)商品項(xiàng)可能包含多個(gè)屬性，如商品的屬性信息。

from typing import Dictclass Item(BaseModel):name: strquantity: intprice: floatattributes: Dict[str, str]  # 商品的額外屬性class Order(BaseModel):user: Useritems: List[Item]total_amount: float

在這種情況下，attributes 字段是一個(gè)字典，存儲(chǔ)商品的屬性信息，如顏色、尺寸等。

order_data = {"user": {"name": "John Doe", "email": "john.doe@example.com"},"items": [{"name": "Laptop", "quantity": 1, "price": 1200.00, "attributes": {"color": "black", "size": "15 inch"}},{"name": "Mouse", "quantity": 2, "price": 25.50, "attributes": {"color": "red", "wireless": "yes"}}],"total_amount": 1251.00
}order = Order(**order_data)
print(order)

2.4 處理元組和其他數(shù)據(jù)類型

Pydantic 同樣支持驗(yàn)證元組、集合等數(shù)據(jù)類型。我們可以使用 Tuple 來(lái)驗(yàn)證數(shù)據(jù)。

from typing import Tupleclass Order(BaseModel):user: Useritems: List[Item]total_amount: floatstatus: Tuple[str, str]  # 狀態(tài)元組：訂單狀態(tài)和配送狀態(tài)

在上面的代碼中，status 是一個(gè)元組，包含兩個(gè)字符串，分別表示訂單的狀態(tài)和配送狀態(tài)。

3. 數(shù)據(jù)驗(yàn)證的自定義方法

Pydantic 允許我們?yōu)槟Ｐ妥侄翁砑幼远x驗(yàn)證方法，這使得我們可以根據(jù)特定規(guī)則對(duì)數(shù)據(jù)進(jìn)行進(jìn)一步驗(yàn)證。

3.1 使用 @validator 裝飾器進(jìn)行字段驗(yàn)證

假設(shè)我們需要驗(yàn)證訂單總金額 total_amount，確保它不小于所有商品項(xiàng)的總價(jià)格。我們可以使用 @root_validator 裝飾器來(lái)實(shí)現(xiàn)這個(gè)邏輯。

from pydantic import root_validator, ValidationErrorclass Order(BaseModel):user: Useritems: List[Item]total_amount: float@root_validatordef check_total_amount(cls, values):items = values.get('items')total_amount = values.get('total_amount')if items and total_amount:total_price = sum(item.quantity * item.price for item in items)if total_amount < total_price:raise ValueError('Total amount cannot be less than the sum of item prices.')return values

3.2 示例驗(yàn)證

假設(shè)我們創(chuàng)建一個(gè)訂單，其中 total_amount 小于所有商品項(xiàng)的總價(jià)格：

order_data = {"user": {"name": "John Doe", "email": "john.doe@example.com"},"items": [{"name": "Laptop", "quantity": 1, "price": 1200.00},{"name": "Mouse", "quantity": 2, "price": 25.50}],"total_amount": 1000.00
}try:order = Order(**order_data)
except ValidationError as e:print(e)

輸出將是：

1 validation error for Order
__root__Total amount cannot be less than the sum of item prices. (type=value_error)

Pydantic 會(huì)自動(dòng)執(zhí)行這個(gè)驗(yàn)證，并返回詳細(xì)的錯(cuò)誤信息。

3.3 驗(yàn)證嵌套模型中的數(shù)據(jù)

你還可以為嵌套的模型添加自定義驗(yàn)證。例如，我們可以確保用戶的郵箱地址包含 @ 符號(hào)：

class User(BaseModel):name: stremail: str@validator('email')def validate_email(cls, value):if '@' not in value:raise ValueError('Email must contain "@" symbol')return value

這樣，如果用戶的郵箱地址沒(méi)有 @ 符號(hào)，Pydantic 會(huì)自動(dòng)拋出驗(yàn)證錯(cuò)誤。

Pydantic 提供了強(qiáng)大的數(shù)據(jù)驗(yàn)證功能，幫助開(kāi)發(fā)者輕松處理復(fù)雜的輸入和輸出數(shù)據(jù)結(jié)構(gòu)。通過(guò)嵌套模型、字典、列表、元組等類型的支持，Pydantic 使得數(shù)據(jù)處理更加靈活和易于管理。同時(shí)，自定義的驗(yàn)證方法（如 @validator 和 @root_validator）允許開(kāi)發(fā)者根據(jù)業(yè)務(wù)邏輯定制數(shù)據(jù)驗(yàn)證規(guī)則，確保數(shù)據(jù)的正確性和一致性。

在使用 Pydantic 時(shí)，通過(guò)合理的模型設(shè)計(jì)和驗(yàn)證方法，可以提高代碼的可讀性、可維護(hù)性和健壯性。如果你正在構(gòu)建需要復(fù)雜數(shù)據(jù)結(jié)構(gòu)驗(yàn)證的應(yīng)用，Pydantic 是一個(gè)非常值得依賴的工具。