如何使用 Pydantic 自動獲取必需屬性

本文旨在介紹如何使用Pydantic 自動識別模型中的必需屬性。通過分析Pydantic 模型的字段定義，我們可以輕鬆地提取出所有未提供默認值的屬性，從而避免手動維護必需屬性列表，提高代碼的可維護性和可讀性。本文提供適用於Pydantic 1.x 和2.x 版本的代碼示例，幫助開發者快速實現此功能。

Pydantic 是一個強大的Python 庫，用於數據驗證和設置管理。在使用Pydantic 定義數據模型時，我們經常需要區分必需屬性（mandatory attributes）和可選屬性（optional attributes）。手動維護必需屬性列表容易出錯，且不易維護。本文將介紹如何使用Pydantic 提供的接口自動獲取模型的必需屬性。

Pydantic 1.x 獲取必需屬性

在Pydantic 1.x 版本中，可以通過訪問模型的__fields__ 屬性來獲取字段信息。 __fields__ 是一個字典，其中鍵是字段名，值是FieldInfo 對象。我們可以檢查FieldInfo 對象的required 屬性來確定字段是否是必需的。

以下是一個示例代碼：

 from pydantic import BaseModel, Field


class MyClass(BaseModel):
    mandatory1: str = Field(description="mandatory")
    mandatory2: str = Field(description="mandatory")
    optional: str = Field(default="", description="optional")


def mandatory_attributes(pydantic_model):
    return [field.name for field in pydantic_model.__fields__.values() if field.required]


assert mandatory_attributes(MyClass) == ["mandatory1", "mandatory2"]

這段代碼定義了一個mandatory_attributes 函數，該函數接受一個Pydantic 模型作為參數，並返回一個包含所有必需屬性名稱的列表。 field.required 屬性為True 表示該字段是必需的。

Pydantic 2.x 獲取必需屬性

在Pydantic 2.x 版本中，獲取字段信息的方式有所改變。不再使用__fields__ 屬性，而是使用model_fields 屬性。 model_fields 也是一個字典，其中鍵是字段名，值是FieldInfo 對象。但是，判斷字段是否必需的方式也發生了改變，使用field.is_required() 方法。

以下是一個示例代碼：

 from pydantic import BaseModel, Field


class MyClass(BaseModel):
    mandatory1: str = Field(description="mandatory")
    mandatory2: str = Field(description="mandatory")
    optional: str = Field(default="", description="optional")


def mandatory_attributes(pydantic_model):
    return [name for name, field in pydantic_model.model_fields.items() if field.is_required()]


assert mandatory_attributes(MyClass) == ["mandatory1", "mandatory2"]

這段代碼與Pydantic 1.x 的示例代碼類似，但使用了model_fields 屬性和field.is_required() 方法。

總結

本文介紹瞭如何使用Pydantic 自動獲取模型的必需屬性。通過使用__fields__ (Pydantic 1.x) 或model_fields (Pydantic 2.x) 屬性，並結合field.required (Pydantic 1.x) 或field.is_required() (Pydantic 2.x) 方法，我們可以輕鬆地提取出所有必需屬性的名稱。這種方法避免了手動維護必需屬性列表，提高了代碼的可維護性和可讀性。在使用不同版本的Pydantic 時，請注意選擇相應的代碼示例。

以上是如何使用 Pydantic 自動獲取必需屬性的詳細內容。更多資訊請關注PHP中文網其他相關文章！