根据JSON模式设置默认值

Question

我正在使用 jsonschema python 中的软件包来验证我的jsons。我可以在 jsonschema 中设置默认。让我们假设以下架构：

from jsonschema import validate

schema = {
    "type": "object",
    "properties": {
        "key_1": {},
        "key_2": {
            "type": "string",
            "default": "do_not_overwrite_if_key_exists",
        },
        "key_3": {
            "type": "string",
            "default": "use_it_if_key_does_not_exist",
        },
    },
    "required": ["key_1"],
}

json_dict = {"key_1": "key_1_value", "key_2": "key_2_value"}

validate(json_dict, schema)

我的 JSON_DICT 是完全有效的。我有两个问题：

1. 默认关键字真的如此“无用”（请参见下文）？这就是你得到的吗？

“默认”关键字没有效果，但是对于架构的读者来说，可以更轻松地识别默认行为。

。

2. 我想拥有一种将我的 json_dict 转换为以下方法，根据默认关键字。你知道这样的包裹吗？

json_dict = {"key_1": "key_1_value", "key_2": "key_2_value", "key_3": "use_it_if_key_does_not_exist"}

谢谢！

Answer 1

您可以使用 jsonschema_default 链接下面链接的软件包，以从JSON架构中生成默认的JSON对象。
https://pypi.org/project/jsonschema-default/

JSON_DICT 中的丢失密钥

”默认

import jsonschema_default as jd

default_obj = jd.create_from("./data_schema_example.json")

for key in default_obj.keys():
    if key not in json_dict:
        json_dict[key] = default_obj[key]  

Answer 2

默认关键字在此处记录： https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.9.2.2

确实不是验证关键字作为注释。当通过模式评估生成时，决定如何使用此注释，这取决于单个应用程序。

Answer 3

@AJack的JSonschema_default解决方案无法与部分填充的嵌套对象一起使用：键将存在，因此不会添加默认值。

假设我有此默认值：

{
  "foo": {
    "bar_1": "value_1",
    "bar_2": "value_2"
  },
  "other": "something"
}

并提供此JSON：

{
  "foo": {
    "bar_1": "value_1"
  }
}

然后仅将“其他” 添加使用默认值。 “ bar_2” 不会添加，因为“ foo” 存在。

带有递归的一种解决方案是搜索所有默认的嵌套结构以填充。这是我的解决方案的尝试：

def fill_default(json_dict, schema):
    for key in schema["properties"]:
        if "properties" in schema["properties"][key].keys(): # Recursion
            if key not in json_dict.keys():
                json_dict[key] = fill_default(dict(), schema["properties"][key])
            else:
                json_dict[key] = fill_default(json_dict[key], schema["properties"][key])
            if len(json_dict[key]) == 0: #No default found inside
                del json_dict[key]
        elif key not in json_dict.keys() and "default" in schema["properties"][key].keys():
            json_dict[key] = schema["properties"][key]["default"]
    return json_dict

json_dict = fill_default(json_dict, schema)

Answer 4

您可以使用 fill_default 来自 /code> 用其模式填充现有实例中的所有缺失默认值：

pip install jsonschema-fill-default

from jsonschema_fill_default import fill_default

schema = {
    "type": "object",
    "properties": {
        "key_1": {},
        "key_2": {
            "type": "string",
            "default": "do_not_overwrite_if_key_exists",
        },
        "key_3": {
            "type": "string",
            "default": "use_it_if_key_does_not_exist",
        },
    },
    "required": ["key_1"],
}

json_dict = {"key_1": "key_1_value", "key_2": "key_2_value"}

fill_default(json_dict, schema)  # Mutates instance!

>>> json_dict

{"key_1": "key_1_value", "key_2": "key_2_value", "key_3": "use_it_if_key_does_not_exist"}

我创建了 jsonschema-fill-default ，tom-tbt的答案是 fill_default 的灵感来源。

填充是针对所有缺失和嵌套默认值的递归完成的。它与“ properties”的所有组合一起使用，，“ allof” ，“ anyof” ，“ oneof” ， “ depententsChemas” ，“ if-then（-else）” ，“ prefixItems” 和“关键字。

注意：

• 该实例必须已经有效对其架构有效。
• 架构本身必须是有效的草稿2020-12 json schema 。
• 填充的实例未自动验证。

参见示例在项目的github上，有关详细信息。