Source code for ocrd_validators.json_validator

"""
Validating JSON-Schema
"""
import json

from jsonschema import Draft201909Validator, ValidationError, validators # pylint: disable=import-error

from ocrd_models import ValidationReport



class JsonSchemaDeprecationWarning(ValidationError):
    pass


# http://python-jsonschema.readthedocs.io/en/latest/faq/


def extend_with_default(validator_class):
    """
    Add a default-setting mechanism to a ``jsonschema`` validation class.
    """
    validate_properties = validator_class.VALIDATORS["properties"]

    def set_defaults_and_handle_deprecate(validator, properties, instance, schema):
        """
        Set defaults in subschemas
        """
        for prop, subschema in properties.items():
            if "default" in subschema:
                instance.setdefault(prop, subschema["default"])
            if subschema.get('deprecated', False) and instance.get(prop):
                yield JsonSchemaDeprecationWarning(f"Property {prop} has been deprecated, ocrd-tool.json should be updated.")

        yield from validate_properties(validator, properties, instance, schema)

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



DefaultValidatingDraft20199Validator = extend_with_default(Draft201909Validator)

#
# -------------------------------------------------
#



class JsonValidator():
    """
    JSON Schema validator.
    """



    @staticmethod
    def validate(obj, schema):
        """
        Validate an object against a schema

        Args:
            obj (dict):
            schema (dict):
        """
        if isinstance(obj, str):
            obj = json.loads(obj)
        return JsonValidator(schema)._validate(obj) # pylint: disable=protected-access


    def __init__(self, schema, validator_class=Draft201909Validator):
        """
        Construct a JsonValidator.

        Args:
            schema (dict):
            validator_class (Draft20199Validator|DefaultValidatingDraft20199Validator):
        """
        self.validator = validator_class(schema)

    def _validate(self, obj):
        """
        Do the actual validation

        Arguments:
            obj (dict): object to validate

        Returns: ValidationReport
        """
        report = ValidationReport()
        if not self.validator.is_valid(obj):
            for v in self.validator.iter_errors(obj):
                meth = f'add_{"warning" if isinstance(v, JsonSchemaDeprecationWarning) else "error"}'
                #  print(">>>>>>>>> v='%s', obj='%s'" % (v, obj))
                getattr(report, meth)("[%s] %s" % ('.'.join(str(vv) for vv in v.path), v.message))
        return report