本文档旨在指导开发者如何使用 Pydantic 自动识别模型中的必需属性。通过解析模型的字段定义，我们可以轻松地获取所有未提供默认值的属性名称。本文将提供适用于 Pydantic 1.x 和 2.x 版本的代码示例，帮助您在项目中更有效地管理数据验证和处理。
Pydantic 是一个强大的 Python 库，用于数据验证和设置管理。在使用 Pydantic 定义数据模型时，我们经常需要区分必需属性和可选属性。手动维护一个必需属性列表既繁琐又容易出错。本文将介绍如何通过 Pydantic 的内部机制自动获取模型的必需属性。
Pydantic 1.x 版本
在 Pydantic 1.x 版本中，模型的字段信息存储在 __fields__ 属性中。我们可以遍历这个字典，检查每个字段的 required 属性来判断它是否是必需的。
以下是一个示例函数，用于获取 Pydantic 1.x 模型的必需属性：
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_v1(pydantic_model):
return [field.name for field in pydantic_model.__fields__.values() if field.required]
result = mandatory_attributes_v1(MyClass)
print(result)
assert result == ["mandatory1", "mandatory2"]这段代码首先定义了一个 MyClass 模型，其中 mandatory1 和 mandatory2 是必需属性，而 optional 是可选属性（因为提供了默认值）。mandatory_attributes_v1 函数遍历模型的 __fields__ 字典，并返回所有 required 属性为 True 的字段名称列表。
Pydantic 2.x 版本
在 Pydantic 2.x 版本中，获取字段信息的方式发生了变化。字段信息存储在 model_fields 属性中，并且使用 field.is_required() 方法来判断字段是否是必需的。
以下是一个示例函数，用于获取 Pydantic 2.x 模型的必需属性：
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_v2(pydantic_model):
return [name for name, field in pydantic_model.model_fields.items() if field.is_required()]
result = mandatory_attributes_v2(MyClass)
print(result)
assert result == ["mandatory1", "mandatory2"]这段代码与 Pydantic 1.x 版本的示例类似，但使用了 model_fields 属性和 field.is_required() 方法。
注意事项
- 版本兼容性： 请根据您使用的 Pydantic 版本选择相应的代码示例。
- 字段类型： 此方法适用于所有类型的字段，包括基本类型、嵌套模型和列表等。
- 默认值： 如果字段定义了默认值，则会被视为可选属性，即使没有显式指定 default 参数。
总结
通过使用 Pydantic 提供的内部机制，我们可以轻松地自动获取模型的必需属性。这不仅可以减少手动维护的工作量，还可以提高代码的可维护性和可读性。无论您使用的是 Pydantic 1.x 还是 2.x 版本，本文提供的示例代码都可以帮助您更好地管理数据模型。希望本文对您有所帮助！
