Pydantic必填字段获取方法解析

想知道 Pydantic 模型中哪些字段是必填的吗？本文为你详细解读如何利用 Pydantic 自动识别必需属性，告别手动维护的繁琐与易错。针对 Pydantic 1.x 和 2.x 版本，分别介绍了通过 `__fields__` 和 `model_fields` 属性，结合 `required` 属性或 `is_required()` 方法来提取必需字段名称的实用技巧。通过本文的学习，你将能够更高效、准确地获取 Pydantic 模型中的必填字段信息，提升开发效率和代码质量。还在为 Pydantic 必填字段而困扰？快来学习吧！

在 Pydantic 中，有时需要知道一个模型中的哪些字段是必需的，即在创建模型实例时必须提供的字段。手动维护这些字段的列表既繁琐又容易出错。本文将展示如何使用 Pydantic 的内置功能来自动提取这些必需属性。

Pydantic 1.x 获取必需属性

在 Pydantic 1.x 版本中，可以通过访问模型的 __fields__ 属性来获取所有字段的信息。__fields__ 是一个字典，其中键是字段的名称，值是 FieldInfo 对象。FieldInfo 对象包含有关字段的所有信息，包括它是否是必需的。

以下代码展示了如何使用 __fields__ 属性来获取必需属性的名称：

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 模型作为参数。它遍历模型的所有字段，并检查每个字段的 required 属性。如果 required 属性为 True，则将该字段的名称添加到结果列表中。

Pydantic 2.x 获取必需属性

在 Pydantic 2.x 版本中，__fields__ 属性被 model_fields 属性取代。model_fields 也是一个字典，其中键是字段的名称，值是 FieldInfo 对象。但是，在 Pydantic 2.x 中，FieldInfo 对象使用 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"]

这段代码与 Pydantic 1.x 的代码非常相似，唯一的区别在于它使用 model_fields 属性和 is_required() 方法。

注意事项

• 确保你使用的 Pydantic 版本与代码中的方法兼容。
• 这种方法依赖于 Pydantic 的内部结构，虽然不太可能改变，但仍然存在潜在的风险。

总结

通过访问 Pydantic 模型的 __fields__ (1.x) 或 model_fields (2.x) 属性，并检查每个字段的 required 或 is_required() 属性，可以轻松地提取出所有必需字段的名称。这使得代码更加简洁、易于维护，并减少了手动维护必需属性列表的错误。在编写 Pydantic 模型时，合理利用这些特性可以提高开发效率和代码质量。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。