comicbox.validate.json_validator

[docs] module comicbox.validate.json_validator 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
"""Custom jsonschema validator."""

from pathlib import Path
from typing import Any

import simplejson
from jsonschema.validators import Draft202012Validator
from referencing import Registry, Resource
from typing_extensions import override

from comicbox.validate.base import SCHEMA_PATH, BaseValidator

_SCHEMA_ID_ROOT = "https://github.com/ajslater/comicbox/blob/main/schemas/"


def _retrieve_from_filesystem(uri: str) -> Resource:
    """Resolve local $refs instead of trying the uri for development."""
    # https://python-jsonschema.readthedocs.io/en/latest/referencing/
    relative_path = Path(uri.removeprefix(_SCHEMA_ID_ROOT))
    path = SCHEMA_PATH / relative_path
    contents = simplejson.loads(path.read_text())
    return Resource.from_contents(contents)


_FILESYSTEM_RESOLVING_REGISTRY = Registry(retrieve=_retrieve_from_filesystem)


class JsonValidator(BaseValidator):
    """Validate json with jsonchema validator."""

    def __init__(self, *args: str, **kwargs: Any) -> None:
        """Create jsonchema validator."""
        super().__init__(*args, **kwargs)
        schema_str = self.schema_path.read_text()
        schema = simplejson.loads(schema_str)
        self._validator = Draft202012Validator(
            schema,
            registry=_FILESYSTEM_RESOLVING_REGISTRY,
            format_checker=Draft202012Validator.FORMAT_CHECKER,
        )

    @override
    def validate(self, data: str | bytes | Path) -> None:
        """Validate source."""
        data = self.get_data_str(data)
        data = simplejson.loads(data)
        self._validator.validate(data)