jsonschema.Draft7Validator

最新推荐文章于 2024-06-26 18:30:53 发布

小李不吃绿皮青椒

最新推荐文章于 2024-06-26 18:30:53 发布

阅读量592

点赞数

分类专栏：记录漫漫学习旅程文章标签： python

本文链接：https://blog.csdn.net/qq_45841233/article/details/130786253

版权

记录漫漫学习旅程专栏收录该内容

2 篇文章 0 订阅

订阅专栏

欢迎来到猫子酱的学习之旅

jsonschema.Draft7Validator

jsonschema.Draft7Validator

你好！这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

比较官方的解释（不太看得懂）

Draft7Validator是JSON Schema（Schema可能看了python的jsonmodels过后会清晰一点点）规范的一种实现。它是一个用于验证JSON数据是否符合指定模式的Python类。Draft7Validator可以验证字符串、数字、布尔值、数组和对象等各种JSON数据类型，并且具有高度的可扩展性。

使用Draft7Validator，可以构建JSON Schema表达式，并将其应用于需要验证的JSON数据。Draft7Validator会根据表达式定义的规则对JSON数据进行验证，并返回任何违反规则的错误消息。Draft7Validator不仅可以验证数据是否符合给定的模式，还可以实现数据的完整性和一致性，在许多场景中非常有用。例如，在API开发中，开发人员可以使用Draft7Validator来验证用户输入的数据是否符合API指定的结构要求。
总之，Draft7Validator提供了简单而强大的JSON数据验证工具，使得开发人员能够更容易地确保他们的程序接收到符合特定格式的数据。

例子

json数据：

假设这样的一个json数据：

{
    "name": "John",
    "age": 30,
    "is_student": true,
    "courses": [
        {
            "id": 1,
            "name": "Math"
        },
        {
            "id": 2,
            "name": "Science"
        }
    ]
}

需求

我们希望确保这个JSON数据符合以下规则：name是一个字符串，长度不超过50个字符；age是一个整数，在18到65之间；is_student是一个布尔值；courses是一个包含至少一个元素的数组，其中每个元素都包含id和name属性，且它们都是整数和字符串。

代码例子：

可以使用Draft7Validator来实现这个验证：

from jsonschema import Draft7Validator

schema = {
    "type": "object",
    "properties": {
        "name": {"type": "string", "maxLength": 50},
        "age": {"type": "integer", "minimum": 18, "maximum": 65},
        "is_student": {"type": "boolean"},
        "courses": {
            "type": "array",
            "minItems": 1,
            "items": {
                "type": "object",
                "properties": {
                    "id": {"type": "integer"},
                    "name": {"type": "string"}
                },
                "required": ["id", "name"]
            }
        }
    },
    "required": ["name", "age", "is_student", "courses"]
}

data = {...} # 上述JSON数据

validator = Draft7Validator(schema)
errors = list(validator.iter_errors(data))

if errors:
    print(errors)
else:
    print("Data is valid according to schema.")

解释：在这个例子中，我们首先定义了一个包含规则的JSON Schema表达式。然后我们将它传递给Draft7Validator类的构造函数来创建一个验证器。最后，我们使用**iter_errors()**方法（在JSON Schema的验证中，iter_errors()是一个用于迭代所有错误的方法）对数据进行验证，并将其返回的所有错误存储在一个列表中。
如果JSON数据符合规则，则验证器将不会返回任何错误，否则就会返回一个包含所有错误的列表。通过这种方式，我们可以轻松地确保输入给我们的JSON数据一定是满足我们要求的。

附 iter_errors()例子

from jsonschema import Draft7Validator

schema = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "age": {"type": "integer", "minimum": 18}
    },
    "required": ["name"]
}

data = {"age": 15}

validator = Draft7Validator(schema)
errors = validator.iter_errors(data)

for error in errors:
    print(error.message)