如何使用 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 表示该字段是必需的。

轻幕

轻幕是一个综合性短视频制作平台，诗词、故事、小说等一键成片转视频，让内容传播更生动！

76

查看详情

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中文网其它相关文章！