获取 Pydantic 对象中的必需属性

本文旨在介绍如何使用 Pydantic 1.x 和 2.x 版本自动识别 Pydantic 模型中的必需属性。通过检查模型字段的 required 或 is_required() 属性，我们可以轻松地提取出所有必需字段的名称，从而避免手动维护必需属性列表，提高代码的可维护性和可扩展性。

Pydantic 是一个强大的 Python 库，用于数据验证和设置管理。在使用 Pydantic 定义数据模型时，我们经常需要区分必需属性和可选属性。手动维护必需属性列表既繁琐又容易出错。本文将介绍如何利用 Pydantic 提供的 API 自动获取 Pydantic 模型中的必需属性。

Pydantic 1.x 版本

在 Pydantic 1.x 版本中，模型字段的信息存储在 __fields__ 属性中。我们可以遍历该属性，并检查每个字段的 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"]

# 示例用法
my_class_mandatory_attributes = mandatory_attributes(MyClass)
print(f"MyClass 的必需属性: {my_class_mandatory_attributes}")

代码解释：

1. pydantic_model.__fields__.values()： 获取模型的所有字段。
2. field.required： 检查字段是否为必需字段。如果为 True，则表示该字段是必需的。
3. field.name： 获取字段的名称。

Pydantic 2.x 版本

Pydantic 2.x 版本对 API 进行了修改。模型字段的信息存储在 model_fields 属性中，并且使用 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(pydantic_model):
    return [name for name, field in pydantic_model.model_fields.items() if field.is_required()]


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

# 示例用法
my_class_mandatory_attributes = mandatory_attributes(MyClass)
print(f"MyClass 的必需属性: {my_class_mandatory_attributes}")

代码解释：

1. pydantic_model.model_fields.items()： 获取模型的所有字段，返回键值对，键为字段名，值为字段信息。
2. field.is_required()： 检查字段是否为必需字段。如果返回 True，则表示该字段是必需的。
3. name： 获取字段的名称。

注意事项

• 以上代码适用于 Pydantic 的标准字段定义。如果使用了自定义字段或复杂的验证逻辑，可能需要进行相应的调整。
• 在实际应用中，可以将 mandatory_attributes 函数封装成一个工具函数，方便在不同的模型中使用。

总结

本文介绍了如何使用 Pydantic 提供的 API 自动获取 Pydantic 模型中的必需属性。通过这种方法，我们可以避免手动维护必需属性列表，提高代码的可维护性和可扩展性。无论是 Pydantic 1.x 还是 2.x 版本，都可以通过检查模型字段的 required 或 is_required() 属性来轻松地提取出所有必需字段的名称。

以上就是获取 Pydantic 对象中的必需属性的详细内容，更多请关注php中文网其它相关文章！