Skip to content

Validator Exporter

Warning

This section is a work in progress

CSVExporter

Bases: Exporter

CSVExporter is a subclass of Exporter that provides functionality to export data to a CSV file. Methods

init(): Initializes the CSVExporter by registering the "csv" export format and its handler. staticmethod _export(data, file): Exports the provided data to a CSV file. Parameters ---------- data : list or dict The data to be exported, typically a list of dictionaries or a dictionary. file : str or file-like object The file path or file-like object where the CSV will be written. Returns ------- str A message indicating the file has been exported.

Source code in datachecker/checks_loaders_and_exporters/validator_exporter.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class CSVExporter(Exporter):
    """
    CSVExporter is a subclass of Exporter that provides functionality to export data to a CSV file.
    Methods
    -------
    __init__():
        Initializes the CSVExporter by registering the "csv" export format and its handler.
    _staticmethod_ _export(data, file):
        Exports the provided data to a CSV file.
        Parameters
        ----------
        data : list or dict
            The data to be exported, typically a list of dictionaries or a dictionary.
        file : str or file-like object
            The file path or file-like object where the CSV will be written.
        Returns
        -------
        str
            A message indicating the file has been exported.
    """

    def __init__(self):
        Exporter.__init__(self, "csv", self._export)

    @staticmethod
    def _export(data, file):
        data[0] = {"timestamp": "", "description": data[0]}
        df = pd.DataFrame(data)
        df.to_csv(file, index=False)
        return f"{file} exported"

Exporter

Exporter class for registering and exporting data in various formats. This class allows you to register exporter functions for different formats and use them to export data. Exporter functions should accept two arguments: data (the data to export) and file (the file or file-like object to write to). Attributes: format_dictionary (dict): A class-level dictionary mapping format names to exporter functions. Methods: init(self, format, exporter_function): Registers a new exporter function for the specified format. export(cls, data, format, file): Exports the given data using the exporter function registered for the specified format. Raises: ValueError: If the specified format is not supported.

Source code in datachecker/checks_loaders_and_exporters/validator_exporter.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
class Exporter:
    """
    Exporter class for registering and exporting data in various formats.
    This class allows you to register exporter functions for different formats and use them
    to export data.
    Exporter functions should accept two arguments: `data` (the data to export) and `file`
    (the file or file-like object to write to).
    Attributes:
        format_dictionary (dict): A class-level dictionary mapping format names to
        exporter functions.
    Methods:
        __init__(self, format, exporter_function):
            Registers a new exporter function for the specified format.
        export(cls, data, format, file):
            Exports the given data using the exporter function registered for the specified format.
            Raises:
                ValueError: If the specified format is not supported.
    """

    format_dictionary = {}

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

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

JSONExporter

Bases: Exporter

JSONExporter is a subclass of Exporter that handles exporting validation logs to a JSON file. Methods

init(): Initializes the JSONExporter by registering the "json" export format and the associated export method. _export(data, file): Static method that writes the provided data to a file in JSON format. Parameters: data (Any): The validation log data to be exported. file (str): The path to the file where the data will be written. Returns: str: A message indicating the file has been exported.

Source code in datachecker/checks_loaders_and_exporters/validator_exporter.py 
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
class JSONExporter(Exporter):
    """
    JSONExporter is a subclass of Exporter that handles exporting validation logs to a JSON file.
    Methods
    -------
    __init__():
        Initializes the JSONExporter by registering the "json" export format and the associated
        export method.
    _export(data, file):
        Static method that writes the provided data to a file in JSON format.
        Parameters:
            data (Any): The validation log data to be exported.
            file (str): The path to the file where the data will be written.
        Returns:
            str: A message indicating the file has been exported.
    """

    def __init__(self):
        Exporter.__init__(self, "json", self._export)

    @staticmethod
    def _export(data, file):
        data = {"validation_log": data}
        with open(file, "w") as f:
            json.dump(data, f, indent=4)
        return f"{file} exported"

TXTExporter

Bases: Exporter

TXTExporter is a subclass of Exporter that handles exporting data to a plain text (.txt) file. Methods

init(): Initializes the TXTExporter by registering the "txt" format and its export method. staticmethod _export(data, file): Exports the provided data to a text file, writing each item on a new line. Parameters

data : iterable The data to be exported, where each item will be written as a separate line in the file. file : str or PathLike The path to the file where the data will be exported. Returns

str A message indicating the file has been exported.

Source code in datachecker/checks_loaders_and_exporters/validator_exporter.py 
102
103
104
105
106
107
108
109
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
class TXTExporter(Exporter):
    """
    TXTExporter is a subclass of Exporter that handles exporting data to a plain text
    (.txt) file.
    Methods
    -------
    __init__():
        Initializes the TXTExporter by registering the "txt" format and its export method.
    _staticmethod_ _export(data, file):
        Exports the provided data to a text file, writing each item on a new line.
    Parameters
    ----------
    data : iterable
        The data to be exported, where each item will be written as a separate line in the file.
    file : str or PathLike
        The path to the file where the data will be exported.
    Returns
    -------
    str
        A message indicating the file has been exported.
    """

    def __init__(self):
        Exporter.__init__(self, "txt", self._export)

    @staticmethod
    def _export(data, file):
        with open(file, "w") as f:
            for item in data:
                if isinstance(item, (dict, list)):
                    formatted = json.dumps(item, indent=4)
                    f.write(f"{formatted}\n")
                else:
                    f.write(f"{item}\n")
        return f"{file} exported"

YAMLExporter

Bases: Exporter

YAMLExporter is a subclass of Exporter that handles exporting data to a YAML file. Methods

init(): Initializes the YAMLExporter by setting the export format to 'yaml' and assigning the export method. _export(data, file): Static method that writes the provided data to the specified file in YAML format. Parameters

data : Any The data to be exported to YAML. file : str The path to the file where the YAML data will be written. Returns

str A message indicating the file has been exported.

Source code in datachecker/checks_loaders_and_exporters/validator_exporter.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
class YAMLExporter(Exporter):
    """
    YAMLExporter is a subclass of Exporter that handles exporting data to a YAML file.
    Methods
    -------
    __init__():
        Initializes the YAMLExporter by setting the export format to 'yaml' and assigning the
        export method.
    _export(data, file):
        Static method that writes the provided data to the specified file in YAML format.
    Parameters
    ----------
    data : Any
        The data to be exported to YAML.
    file : str
        The path to the file where the YAML data will be written.
    Returns
    -------
    str
        A message indicating the file has been exported.
    """

    def __init__(self):
        Exporter.__init__(self, "yaml", self._export)

    @staticmethod
    def _export(data, file):
        with open(file, "w") as f:
            yaml.dump(data, f, sort_keys=False)
        return f"{file} exported"