在验证期间设置JSON模式的默认值

Question

我尝试制作一个验证器，该验证器将在验证期间从JSON模式设置默认值。

我发现了一个问题： python中的JSON模式验证器设置默认值并将其调整了一点。 由于我使用“ jsonschema == 3.2.0”，所以我想出了这样的代码：

def _with_default_setter_extension(validator_class):
    """Extend validator class with defaults setter.

    With this extension, the validator class will set all defaults from a
    schema being validated to a validated instance.
    """

    def _set_defaults(validator, properties, instance, schema):
        if not validator.is_type(instance, "object"):
            return

        valid = True
        for prop, subschema in properties.items():
            if prop in instance:
                for error in validator.descend(
                    instance[prop],
                    subschema,
                    path=prop,
                    schema_path=prop,
                ):
                    valid = False
                    yield error

        # set defaults only when validation is successful
        if valid:
            # set root default when instance is empty
            if not instance and "default" in schema:
                instance.update(schema["default"])
                return

            for prop, subschema in properties.items():
                if "default" in subschema and not isinstance(instance, list):
                    instance.setdefault(prop, subschema["default"])

    return jsonschema.validators.extend(
        validator_class, {"properties": _set_defaults}
    )

它效果很好，除了一种对我很重要的情况。我写了这样的测试以证明它对我的情况不起作用：

def test_defaults_from_oneOf_only_defaults_from_valid_schema_are_set():
    """When oneOf is used, I expect only defaults from the valid subschema to be set."""
    schema = {
        "oneOf": [
            {
                "properties": {
                    "p": {"enum": ["one"]},
                    "params": {"properties": {"q": {"default": 1}}},
                }
            },
            {
                "properties": {
                    "p": {"enum": ["two"]},
                    "params": {"properties": {"w": {"default": 2}}},
                }
            },
        ],
    }
    assert _VALIDATOR.validate({"p": "two", "params": {}}, schema) == {
        "p": "two",
        "params": {"w": 2},
    }

由于此断言错误，测试失败了：

AssertionError: assert {'p': 'two', 'params': {'q': 1, 'w': 2}} == {'p': 'two', 'params': {'w': 2}}
  +{'p': 'two', 'params': {'q': 1, 'w': 2}}
  -{'p': 'two', 'params': {'w': 2}}
  Full diff:
  - {'p': 'two', 'params': {'w': 2}}
  + {'p': 'two', 'params': {'q': 1, 'w': 2}}
  ?

因此，我们可以看到，尽管第一个亚chema是无效的，但从其“ params”中的默认值（“ q”）是放。 通过一些调试，我发现当您仅覆盖“属性”验证器时，它就会缺乏上下文。因此，当第一个子场“参数”得到验证时，我没有上下文告诉我“ p”参数验证失败，我们仍处于同一子策略中。

请给我任何有关我可以尝试的东西的见解。

Answer 1

You can find the words in the original jsonschema

在此代码中，我们将默认属性添加到每个对象之前
属性已验证，因此默认值本身将需要
在模式下有效。

您正在使用扩展验证器运行验证和set_default。这就是为什么DICT仍会更新的原因。您可能需要使用分离的验证器来运行它们，仅首先进行验证。

Answer 2

您是否考虑过在实例中首先填写所有默认值然后验证它，而不是在验证期间设置默认值？

您可以使用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"}

您显示的函数仅填充“属性”中的默认值“ properties”的嵌套组合，“ allof”，“ anyof”，“ Oneof” ，“ DepententsChemas”，“ if-then（-else）”，“ prefixItems”和“ tocke>'items' << a href =“ https://json-schema.org/draft/2020-12” rel =“ nofollow noreferrer”>草稿2020-12 json schema 。