本文介绍了如何使用 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 的定义。
然后，我们定义了一个 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 开发中广泛使用。
