使用 Pydantic 在 Python 中进行复杂数据结构的验证

花韻仙語
发布: 2025-10-19 12:56:01
原创
722人浏览过

使用 pydantic 在 python 中进行复杂数据结构的验证

本文介绍了如何使用 Pydantic 库在 Python 中验证复杂的数据结构,特别是针对包含嵌套列表和固定键名的字典的场景。通过 `conlist` 和 `BaseModel` 的结合使用,可以有效地确保数据的类型、长度和结构符合预期,从而提高代码的健壮性和可靠性。

在 Python 开发中,数据验证是一个至关重要的环节,尤其是在处理外部数据或用户输入时。Pydantic 是一个强大的数据验证和解析库,它使用 Python 类型注解来定义数据模型,并在运行时进行验证。本文将介绍如何使用 Pydantic 来验证复杂的数据结构,例如包含嵌套列表和固定键名的字典。

定义数据模型

假设我们需要验证如下的数据结构:

{
  "filters": {
    "simple": [["str1", "str2", "str3"], ["str4", "str5", "str6"]],
    "combined": [["str7", "str8", "str9"], ["str10", "str11", "str12"]]
  }
}
登录后复制

其中,filters 字段包含一个字典,该字典有两个固定的键名:simple 和 combined。每个键对应的值都是一个列表,列表中的每个元素又是一个包含三个字符串的列表。

立即学习Python免费学习笔记(深入)”;

为了使用 Pydantic 验证这种数据结构,我们需要定义相应的 Pydantic 模型。

from pydantic import BaseModel, conlist
from typing import List

class SimpleCombine(BaseModel):
    simple: List[conlist(str, min_length=3, max_length=3)]
    combined: List[conlist(str, min_length=3, max_length=3)]

class Filter(BaseModel):
    filters: SimpleCombine
登录后复制

在这个例子中,我们首先定义了一个 SimpleCombine 模型,它包含 simple 和 combined 两个字段。conlist(str, min_length=3, max_length=3) 用于指定列表中的每个元素都必须是一个字符串,并且列表的长度必须为 3。List[...] 用于指定 simple 和 combined 字段的值是一个列表,列表中的每个元素都符合 conlist 的定义。

即构数智人
即构数智人

即构数智人是由即构科技推出的AI虚拟数字人视频创作平台,支持数字人形象定制、短视频创作、数字人直播等。

即构数智人 36
查看详情 即构数智人

然后,我们定义了一个 Filter 模型,它包含一个 filters 字段,该字段的值是 SimpleCombine 模型的实例。

验证数据

定义好数据模型后,我们就可以使用 Pydantic 来验证数据了。

data = {
  "filters": {
    "simple": [["str1", "str2", "str3"], ["str4", "str5", "str6"]],
    "combined": [["str7", "str8", "str9"], ["str10", "str11", "str12"]]
  }
}

try:
    filter_data = Filter(**data)
    print("数据验证成功!")
    print(filter_data)
except Exception as e:
    print("数据验证失败:", e)
登录后复制

如果数据符合模型定义,Pydantic 将会创建一个模型实例。否则,将会抛出一个异常,指示数据验证失败的原因。

示例代码

以下是一个完整的示例代码:

from pydantic import BaseModel, conlist
from typing import List

class SimpleCombine(BaseModel):
    simple: List[conlist(str, min_length=3, max_length=3)]
    combined: List[conlist(str, min_length=3, max_length=3)]

class Filter(BaseModel):
    filters: SimpleCombine

data = {
  "filters": {
    "simple": [["str1", "str2", "str3"], ["str4", "str5", "str6"]],
    "combined": [["str7", "str8", "str9"], ["str10", "str11", "str12"]]
  }
}

try:
    filter_data = Filter(**data)
    print("数据验证成功!")
    print(filter_data)
except Exception as e:
    print("数据验证失败:", e)

# 示例:验证失败的情况
invalid_data = {
  "filters": {
    "simple": [["str1", "str2"]], # 长度不足
    "combined": [["str7", "str8", "str9"], ["str10", "str11", "str12"]]
  }
}

try:
    filter_data = Filter(**invalid_data)
    print("数据验证成功!")
    print(filter_data)
except Exception as e:
    print("数据验证失败:", e)
登录后复制

注意事项

  • conlist 只能用于列表,不能用于其他类型的容器。
  • min_length 和 max_length 用于指定列表的最小和最大长度。如果只指定一个值,则列表的长度必须等于该值。
  • Pydantic 提供了丰富的验证选项,可以满足各种不同的验证需求。

总结

通过使用 Pydantic 的 conlist 和 BaseModel,我们可以轻松地验证复杂的数据结构,确保数据的类型、长度和结构符合预期。这可以帮助我们提高代码的健壮性和可靠性,减少错误和异常的发生。 Pydantic 是一个非常实用的数据验证库,值得在 Python 开发中广泛使用。

以上就是使用 Pydantic 在 Python 中进行复杂数据结构的验证的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号