使用 Pydantic 在 Python 中进行复杂数据结构的校验-Python教程-PHP中文网

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

聖光之護

发布： 2025-10-19 10:59:22

原创

447人浏览过

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

本文介绍了如何使用 Pydantic 在 Python 中校验复杂的数据结构，特别是嵌套列表和字典的组合。通过 `conlist` 和 `BaseModel` 的组合使用，可以精确地定义和验证数据的类型、长度和内容，从而确保数据的有效性和一致性。

Pydantic 是一个强大的 Python 库，用于数据验证和设置管理。它允许你使用 Python 类型提示来定义数据结构，并在运行时进行验证。这对于构建健壮的 API 和处理外部数据源至关重要。本文将重点介绍如何使用 Pydantic 校验包含嵌套列表和字典的复杂数据结构，并提供一个实际的示例。

使用 conlist 约束列表长度和类型

conlist 是 Pydantic 提供的一个特殊类型，允许你约束列表的长度和类型。例如，你可以定义一个列表，其中每个元素都必须是字符串，且列表的长度必须是 3。这对于需要特定格式的数据非常有用。

使用 BaseModel 定义数据模型

BaseModel 是 Pydantic 的核心类，用于定义数据模型。你可以通过继承 BaseModel 来创建自己的数据模型，并在模型中定义字段及其类型。Pydantic 会自动验证这些字段的值是否符合定义的类型。

立即学习“Python免费学习笔记（深入）”；

示例：校验包含嵌套列表的字典

假设我们需要校验以下数据结构：

{
  "filters": {
    "simple": [["str", "str", "any"], ...],
    "combined": [["str", "str", "str"], ...]
  }
}

登录后复制

其中，filters 字段是一个字典，包含 simple 和 combined 两个键。simple 和 combined 的值都是一个列表，列表中的每个元素都是一个包含 3 个字符串的列表。

我们可以使用 Pydantic 来定义以下模型：

用Apache Spark进行大数据处理

本文档主要讲述的是用Apache Spark进行大数据处理——第一部分：入门介绍；Apache Spark是一个围绕速度、易用性和复杂分析构建的大数据处理框架。最初在2009年由加州大学伯克利分校的AMPLab开发，并于2010年成为Apache的开源项目之一。在这个Apache Spark文章系列的第一部分中，我们将了解到什么是Spark，它与典型的MapReduce解决方案的比较以及它如何为大数据处理提供了一套完整的工具。希望本文档会给有需要的朋友带来帮助；感

查看详情

from pydantic import BaseModel, conlist
from typing import List, Any

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 个字符串。
Filter 模型定义了 filters 字段，它的类型是 SimpleCombine。

现在，我们可以使用这个模型来验证数据：

data = {
  "filters": {
    "simple": [["a", "b", "c"], ["d", "e", "f"]],
    "combined": [["g", "h", "i"], ["j", "k", "l"]]
  }
}

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

登录后复制

如果数据符合模型定义，Pydantic 将会成功验证数据并创建一个 Filter 实例。否则，将会抛出一个异常，指出哪些字段验证失败以及原因。

在 FastAPI 中使用 Pydantic 进行请求体验证

Pydantic 与 FastAPI 无缝集成，可以轻松地在 FastAPI 路由中使用 Pydantic 模型来定义请求体。

from fastapi import FastAPI
from pydantic import BaseModel, conlist
from typing import List

app = FastAPI()

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

@app.post("/validate")
async def validate_data(filter_data: Filter):
    return {"message": "数据验证成功!", "data": filter_data}

登录后复制

在这个例子中，validate_data 函数接收一个 Filter 类型的参数。FastAPI 会自动使用 Pydantic 来验证请求体是否符合 Filter 模型的定义。如果请求体无效，FastAPI 将会返回一个 HTTP 422 错误，并包含详细的错误信息。

注意事项

conlist 可以用于约束列表的长度和类型，但它不能约束列表中的元素的顺序。
Pydantic 提供了许多其他的验证器，可以用于执行更复杂的验证逻辑。
在定义数据模型时，应该尽可能地使用类型提示，以便 Pydantic 可以进行更精确的验证。

总结

Pydantic 是一个强大的 Python 库，可以帮助你轻松地验证复杂的数据结构。通过 conlist 和 BaseModel 的组合使用，你可以精确地定义和验证数据的类型、长度和内容，从而确保数据的有效性和一致性。这对于构建健壮的 API 和处理外部数据源至关重要。Pydantic 与 FastAPI 的无缝集成，更是简化了 API 开发过程，提高了开发效率。

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