Skip to content

hololinked.schema_validators.json_schema.JSONSchemaValidator

Bases: BaseSchemaValidator

JSON schema validator extending the standard python JSON schema package.

power_supply_output_schema = {
    "type": "object",
    "properties": {
        "current": {"type": "number", "minimum": 0},
        "power": {"type": "number", "minimum": 0, "maximum": 100},
    },
}
validator = JSONSchemaValidator(power_supply_output_schema)
validator.validate({"current": 50, "power": 75})  # valid
validator.validate({"current": 65, "power": 110})  # raises

This class is largely used internally and there is no need to explicitly instantiate it.

Consider FastJSONSchemaValidator (pip install fastjsonschema) or pydantic annotation based validation for performance if necessary.

Source code in repo/hololinked/hololinked/schema_validators/json_schema.py 
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
class JSONSchemaValidator(BaseSchemaValidator):
    """
    JSON schema validator extending the standard python JSON schema package.

    ```python
    power_supply_output_schema = {
        "type": "object",
        "properties": {
            "current": {"type": "number", "minimum": 0},
            "power": {"type": "number", "minimum": 0, "maximum": 100},
        },
    }
    validator = JSONSchemaValidator(power_supply_output_schema)
    validator.validate({"current": 50, "power": 75})  # valid
    validator.validate({"current": 65, "power": 110})  # raises
    ```

    This class is largely used internally and there is no need to explicitly instantiate it.

    Consider `FastJSONSchemaValidator` (`pip install fastjsonschema`) or
    pydantic annotation based validation for performance if necessary.
    """

    def __init__(self, schema: JSONSchemaType) -> None:
        """
        Initialize the validator.

        Parameters
        ----------
        schema: JSONSchemaType
            The JSON schema to validate against
        """
        self.check_schema(schema)
        super().__init__(schema)
        self.validator = jsonschema.Draft7Validator(schema)

    @classmethod
    def check_schema(cls, schema: JSONSchemaType) -> None:
        """
        Check that the given object is itself a valid JSON schema.

        Parameters
        ----------
        schema: JSONSchemaType
            the schema to check

        Raises
        ------
        jsonschema.SchemaError
            if the schema is not a valid JSON schema
        """
        jsonschema.Draft7Validator.check_schema(schema)

    def validate(self, data) -> None:  # noqa: D102
        self.validator.validate(data)

    def validate_method_call(self, args, kwargs) -> None:  # noqa: D102
        if len(args) > 0:
            kwargs = json_schema_merge_args_to_kwargs(self.schema, args, kwargs)
            # TODO fix type definition
        self.validate(kwargs)

    def json(self) -> JSONSchemaType:  # noqa: D102
        return self.schema

    def __get_state__(self) -> JSONSchemaType:
        return self.schema

    def __set_state__(self, schema: JSONSchemaType):
        return JSONSchemaValidator(schema)

Attributes

schema instance-attribute 

schema = schema

validator instance-attribute 

validator = Draft7Validator(schema)

Functions

__init__ 

__init__(schema: JSONSchemaType) -> None

Initialize the validator.

Parameters:

Name Type Description Default

schema

JSONSchemaType

The JSON schema to validate against

 required
Source code in repo/hololinked/hololinked/schema_validators/json_schema.py 
33
34
35
36
37
38
39
40
41
42
43
44
def __init__(self, schema: JSONSchemaType) -> None:
    """
    Initialize the validator.

    Parameters
    ----------
    schema: JSONSchemaType
        The JSON schema to validate against
    """
    self.check_schema(schema)
    super().__init__(schema)
    self.validator = jsonschema.Draft7Validator(schema)

json 

json() -> JSONSchemaType
Source code in repo/hololinked/hololinked/schema_validators/json_schema.py 
72
73
def json(self) -> JSONSchemaType:  # noqa: D102
    return self.schema

validate 

validate(data) -> None
Source code in repo/hololinked/hololinked/schema_validators/json_schema.py 
63
64
def validate(self, data) -> None:  # noqa: D102
    self.validator.validate(data)

validate_method_call 

validate_method_call(args, kwargs) -> None
Source code in repo/hololinked/hololinked/schema_validators/json_schema.py 
66
67
68
69
70
def validate_method_call(self, args, kwargs) -> None:  # noqa: D102
    if len(args) > 0:
        kwargs = json_schema_merge_args_to_kwargs(self.schema, args, kwargs)
        # TODO fix type definition
    self.validate(kwargs)

check_schema classmethod 

check_schema(schema: JSONSchemaType) -> None

Check that the given object is itself a valid JSON schema.

Parameters:

Name Type Description Default

schema

JSONSchemaType

the schema to check

 required

Raises:

Type Description
SchemaError

if the schema is not a valid JSON schema
Source code in repo/hololinked/hololinked/schema_validators/json_schema.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@classmethod
def check_schema(cls, schema: JSONSchemaType) -> None:
    """
    Check that the given object is itself a valid JSON schema.

    Parameters
    ----------
    schema: JSONSchemaType
        the schema to check

    Raises
    ------
    jsonschema.SchemaError
        if the schema is not a valid JSON schema
    """
    jsonschema.Draft7Validator.check_schema(schema)