如何通過代碼獲取 Pydantic 模型中字段的 max_length 值？

本文探討如何從Pydantic模型中提取字段的max_length值。 我們將演示如何避免常見的錯誤，并提供適用于不同Pydantic版本的解決方案。

假設我們有一個名為MetaCollection的Pydantic模型，其中description字段設置了max_length為1024：

from pydantic import BaseModel, Field  class MetaCollection(BaseModel):     id: int | None = Field(default=None)     collection_name: str = Field(max_length=64)     description: str | None = Field(None, max_length=1024)     # ... 其他字段

直接嘗試訪問extra字典來獲取max_length值是錯誤的，這會導致KeyError。 正確的方法是直接訪問field_info對象的max_length屬性：

# 獲取 description 字段的 max_length description_max_length = MetaCollection.model_fields["description"].field_info.max_length print(description_max_length)  # 輸出 1024

請注意，我們使用了MetaCollection.model_fields而不是__fields__。 model_fields是Pydantic中推薦的方式來訪問模型字段信息。

Pydantic版本差異:

上述方法適用于Pydantic v2及更高版本。 對于舊版本（例如Pydantic v1），field_info的結構可能略有不同。 請務必參考您所使用Pydantic版本的文檔以確保代碼的正確性。 在Pydantic v1中，max_length可能在field_info.extra中，但這不是可靠的方法。 建議升級到最新版本的Pydantic，以獲得更好的兼容性和更清晰的API。

總結:

獲取Pydantic模型字段的max_length值的關鍵在于直接訪問model_fields屬性，然后通過field_info.max_length獲取所需的值。 請確保您的代碼與您所使用的Pydantic版本兼容。 始終參考官方文檔以獲得最新的最佳實踐和API信息。