Skip to content

Schema Loader

Warning

This section is a work in progress

JSONSchemaLoader

Bases: SchemaLoader

A schema loader for JSON files. This class extends the SchemaLoader to provide functionality for loading schemas defined in JSON format. It registers itself with the identifier "json" and uses the json.load method to parse JSON files.

Methods

init(): Initializes the loader and registers the JSON loading function. _load(schema: str) -> dict: Static method that loads and parses a JSON schema file. Parameters ---------- schema : str The file path to the JSON schema. Returns ------- dict The parsed schema as a Python dictionary.

Source code in datachecker/checks_loaders_and_exporters/schema_loader.py 
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
class JSONSchemaLoader(SchemaLoader):
    """
    A schema loader for JSON files.
    This class extends the `SchemaLoader` to provide functionality for loading
    schemas defined in JSON format. It registers itself with the identifier "json"
    and uses the `json.load` method to parse JSON files.

    Methods
    -------
    __init__():
        Initializes the loader and registers the JSON loading function.
    _load(schema: str) -> dict:
        Static method that loads and parses a JSON schema file.
        Parameters
        ----------
        schema : str
            The file path to the JSON schema.
        Returns
        -------
        dict
            The parsed schema as a Python dictionary.
    """

    def __init__(self):
        SchemaLoader.__init__(self, "json", self._load)

    @staticmethod
    def _load(schema):
        with open(schema, "r") as f:
            return json.load(f)

SchemaLoader

SchemaLoader is a class for registering and loading schema parsing functions based on format. Class Attributes: format_dictionary (dict): A mapping from format names (str) to schema loader functions. Methods

init(self, format, schema_loader_function): Registers a schema loader function for a given format. load(cls, schema, format): Loads and parses a schema using the registered loader function for the specified format. Parameters ---------- schema : str The file path to the schema. format : str The format identifier (e.g., "json", "yaml"). Returns ------- dict The parsed schema as a Python dictionary. Raises ------ ValueError If the requested format is not registered in format_dictionary.

Source code in datachecker/checks_loaders_and_exporters/schema_loader.py 
 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
class SchemaLoader:
    """
    SchemaLoader is a class for registering and loading schema parsing functions based on format.
    Class Attributes:
        format_dictionary (dict): A mapping from format names (str) to schema loader functions.
    Methods
    -------
    __init__(self, format, schema_loader_function):
        Registers a schema loader function for a given format.
    load(cls, schema, format):
        Loads and parses a schema using the registered loader function for the specified format.
        Parameters
        ----------
        schema : str
            The file path to the schema.
        format : str
            The format identifier (e.g., "json", "yaml").
        Returns
        -------
        dict
            The parsed schema as a Python dictionary.
        Raises
        ------
        ValueError
            If the requested format is not registered in format_dictionary.
    """

    format_dictionary = {}

    def __init__(self, format, schema_loader_function):
        type(self).format_dictionary[format] = schema_loader_function

    @classmethod
    def load(cls, schema, format):
        if format not in cls.format_dictionary:
            raise ValueError(f"Format '{format}' is not supported.")
        output_function = cls.format_dictionary[format]
        return output_function(schema)

TOMLSchemaLoader

Bases: SchemaLoader

A schema loader for TOML files. This class extends the SchemaLoader to provide functionality for loading schemas defined in TOML format. It registers itself with the identifier "toml" and uses the tomli.load method to parse TOML files. Methods

init(): Initializes the loader and registers the TOML loading function. _load(schema: str) -> dict: Static method that loads and parses a TOML schema file. Parameters ---------- schema : str The file path to the TOML schema. Returns ------- dict The parsed schema as a Python dictionary.

Source code in datachecker/checks_loaders_and_exporters/schema_loader.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class TOMLSchemaLoader(SchemaLoader):
    """
    A schema loader for TOML files.
    This class extends the `SchemaLoader` to provide functionality for loading
    schemas defined in TOML format. It registers itself with the identifier "toml"
    and uses the `tomli.load` method to parse TOML files.
    Methods
    -------
    __init__():
        Initializes the loader and registers the TOML loading function.
    _load(schema: str) -> dict:
        Static method that loads and parses a TOML schema file.
        Parameters
        ----------
        schema : str
            The file path to the TOML schema.
        Returns
        -------
        dict
            The parsed schema as a Python dictionary.
    """

    def __init__(self):
        SchemaLoader.__init__(self, "toml", self._load)

    @staticmethod
    def _load(schema):
        with open(schema, "rb") as f:
            return tomli.load(f)

YAMLSchemaLoader

Bases: SchemaLoader

A schema loader for YAML files. This class extends the SchemaLoader to provide functionality for loading schemas defined in YAML format. It registers itself with the identifier "yaml" and uses the yaml.safe_load method to parse YAML files. Methods

init(): Initializes the loader and registers the YAML loading function. _load(schema: str) -> dict: Static method that loads and parses a YAML schema file. Parameters ---------- schema : str The file path to the YAML schema. Returns ------- dict The parsed schema as a Python dictionary.

Source code in datachecker/checks_loaders_and_exporters/schema_loader.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
class YAMLSchemaLoader(SchemaLoader):
    """
    A schema loader for YAML files.
    This class extends the `SchemaLoader` to provide functionality for loading
    schemas defined in YAML format. It registers itself with the identifier "yaml"
    and uses the `yaml.safe_load` method to parse YAML files.
    Methods
    -------
    __init__():
        Initializes the loader and registers the YAML loading function.
    _load(schema: str) -> dict:
        Static method that loads and parses a YAML schema file.
        Parameters
        ----------
        schema : str
            The file path to the YAML schema.
        Returns
        -------
        dict
            The parsed schema as a Python dictionary.
    """

    def __init__(self):
        SchemaLoader.__init__(self, "yaml", self._load)

    @staticmethod
    def _load(schema):
        with open(schema, "r") as f:
            return yaml.safe_load(f)