Skip to content

Configparser

The configparser module.

The module contains the configparser class. The configparser class is used to parse the configuration file and construct the configuration objects. It gives the ability to autosave the configuration file when the configuration objects are updated.

Configparser

The Configparser class.

The Configparser class is used to parse the configuration file and construct the configuration objects. It gives the ability to autosave the configuration file when the configuration objects are updated.

Source code in src/simple_config_builder/configparser.py 
 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
 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
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
137
138
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
class Configparser:
    """
    The Configparser class.

    The Configparser class is used to parse the configuration file and
    construct the configuration objects. It gives the ability to autosave
    the configuration file when the configuration objects are updated.
    """

    config_file: str
    config_type: ConfigTypes | None
    autosave: bool
    autoreload: bool
    config_data: dict | list | Configclass

    def __init__(
        self,
        config_file: str,
        config_type: ConfigTypes | None = None,
        autosave: bool = False,
        autoreload: bool = False,
    ):
        """
        Initialize the configparser.

        Parameters
        ----------
        config_file: The configuration file path.
        config_type: The configuration type. Defaults to None.
        autosave: Autosave the configuration file. Defaults to False.
        autoreload: Autoreload the configuration file. Defaults to False.

        Raises
        ------
        ValueError: If the configuration type is not recognized.
        ValueError: If the configuration type is not supported.
        """
        self.config_file = config_file
        self.config_type = config_type
        self.autosave = autosave
        self.autoreload = autoreload
        if self.autoreload and self.autosave:
            raise ValueError(
                "Autoreload and autosave cannot be enabled at the same time."
            )

        if self.config_type is None:
            self.config_type = self._get_config_type()
            if self.config_type is None:
                raise ValueError("The configuration type is not recognized.")
        if self.config_type is None:
            raise ValueError("The configuration type is not supported.")
        # first read
        self.config_data = parse_config(self.config_file, self.config_type)
        if self.autoreload:
            self._auto_reload_config()
        if self.autosave:
            self._auto_save_config()

    @classmethod
    def from_python(
        cls,
        data: dict | Configclass | list,
        config_file: str,
        config_type: ConfigTypes | None = None,
        autosave: bool = False,
        autoreload: bool = False,
    ) -> "Configparser":
        """
        Create a Configparser instance from Python data.

        Parameters
        ----------
        data: The configuration data as a dictionary, Configclass, or list.
        config_file: The configuration file path.
        config_type: The configuration type.
        autosave: Autosave the configuration file. Defaults to False.
        autoreload: Autoreload the configuration file. Defaults to False.

        Returns
        -------
            A Configparser instance with the given data.
        """
        configparser = cls(
            config_file=config_file,
            config_type=config_type,
            autosave=autosave,
            autoreload=autoreload,
        )
        configparser.config_data = data
        return configparser

    def _get_config_type(self) -> ConfigTypes:
        """
        Get the configuration type from the configuration file.

        Returns
        -------
            The configuration type.
        """
        if self.config_file.endswith(".json"):
            return ConfigTypes.JSON
        if self.config_file.endswith(".yaml"):
            return ConfigTypes.YAML
        if self.config_file.endswith(".toml"):
            return ConfigTypes.TOML
        raise ValueError("The configuration type is not supported.")

    def _auto_save_config(self):
        """Autosave the configuration file."""
        self._old_config_data = self.config_data

        def _save_config():
            if self.config_type is None:
                return
            if self._old_config_data != self.config_data:
                write_config(
                    self.config_file, self.config_data, self.config_type
                )
                self._old_config_data = self.config_data

        Timer(1, _save_config).start()

    def _auto_reload_config(self):
        """Autoreload the configuration file."""

        # Check for changes in the configuration file
        def _reload_config():
            if self.config_type is None:
                return
            new_config_data = parse_config(self.config_file, self.config_type)
            if new_config_data != self.config_data:
                self.config_data = new_config_data

        Timer(1, _reload_config).start()

    def contains(
        self, config_field_type: Any = None, config_field: str | None = None
    ) -> bool:
        """
        Check if the configuration data contains the given field or type.

        The method returns the first occurrence of the field or type in the
        configuration data. Either `config_field_type` or `config_field`
        must be provided, but not both.

        Parameters
        ----------
        config_field_type: The type to check for in the configuration data.
        config_field: The field to check for in the configuration data.

        Returns
        -------
        bool: True if the configuration data contains the field or type.

        Raises
        ------
        ValueError: If neither `config_field_type` nor `config_field` is
                    provided.
        ValueError: If both `config_field_type` and `config_field`
                    are provided.
        """

        def _contains_type(config_data, config_type: Any) -> bool:
            if isinstance(config_data, dict):
                for key, value in config_data.items():
                    if isinstance(value, config_type):
                        return True
                    if _contains_type(value, config_type):
                        return True
            elif isinstance(config_data, list):
                for item in config_data:
                    if isinstance(item, config_type):
                        return True
                    if _contains_type(item, config_type):
                        return True
            elif isinstance(config_data, Configclass):
                if isinstance(config_data, config_type):
                    return True
                for name in type(config_data).model_fields.keys():
                    if _contains_type(getattr(config_data, name), config_type):
                        return True
            elif isinstance(config_data, config_type):
                return True
            return False

        def _contains_field(config_data, field: str) -> bool:
            if isinstance(config_data, dict):
                if field in config_data:
                    return True
                for value in config_data.values():
                    if _contains_field(value, field):
                        return True
            elif isinstance(config_data, list):
                if field in config_data:
                    return True
                for item in config_data:
                    if _contains_field(item, field):
                        return True
            elif isinstance(config_data, Configclass):
                if field in list(type(config_data).model_fields.keys()):
                    return True
                for name in type(config_data).model_fields.keys():
                    if _contains_field(getattr(config_data, name), field):
                        return True
            return False

        if config_field_type is None and config_field is None:
            msg = (
                "Either config_field_type or config_field " "must be provided."
            )
            raise ValueError(msg)
        if config_field_type is not None and config_field is not None:
            msg = (
                "Only one of config_field_type or config_field"
                "can be provided."
            )
            raise ValueError(msg)
        if config_field is not None:
            return _contains_field(self.config_data, config_field)
        if config_field_type is not None:
            return _contains_type(self.config_data, config_field_type)
        return False

    def save(self):
        """Save the configuration data to the configuration file."""
        if self.config_type is None:
            return
        write_config(self.config_file, self.config_data, self.config_type)

    def reload(self):
        """Reload the configuration data from the configuration file."""
        if self.config_type is None:
            return
        self.config_data = parse_config(self.config_file, self.config_type)

__init__

Initialize the configparser.

Parameters

config_file: The configuration file path. config_type: The configuration type. Defaults to None. autosave: Autosave the configuration file. Defaults to False. autoreload: Autoreload the configuration file. Defaults to False.

Raises

ValueError: If the configuration type is not recognized. ValueError: If the configuration type is not supported.

Source code in src/simple_config_builder/configparser.py 
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
def __init__(
    self,
    config_file: str,
    config_type: ConfigTypes | None = None,
    autosave: bool = False,
    autoreload: bool = False,
):
    """
    Initialize the configparser.

    Parameters
    ----------
    config_file: The configuration file path.
    config_type: The configuration type. Defaults to None.
    autosave: Autosave the configuration file. Defaults to False.
    autoreload: Autoreload the configuration file. Defaults to False.

    Raises
    ------
    ValueError: If the configuration type is not recognized.
    ValueError: If the configuration type is not supported.
    """
    self.config_file = config_file
    self.config_type = config_type
    self.autosave = autosave
    self.autoreload = autoreload
    if self.autoreload and self.autosave:
        raise ValueError(
            "Autoreload and autosave cannot be enabled at the same time."
        )

    if self.config_type is None:
        self.config_type = self._get_config_type()
        if self.config_type is None:
            raise ValueError("The configuration type is not recognized.")
    if self.config_type is None:
        raise ValueError("The configuration type is not supported.")
    # first read
    self.config_data = parse_config(self.config_file, self.config_type)
    if self.autoreload:
        self._auto_reload_config()
    if self.autosave:
        self._auto_save_config()

contains

Check if the configuration data contains the given field or type.

The method returns the first occurrence of the field or type in the configuration data. Either config_field_type or config_field must be provided, but not both.

Parameters

config_field_type: The type to check for in the configuration data. config_field: The field to check for in the configuration data.

Returns

bool: True if the configuration data contains the field or type.

Raises

ValueError: If neither config_field_type nor config_field is provided. ValueError: If both config_field_type and config_field are provided.

Source code in src/simple_config_builder/configparser.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
def contains(
    self, config_field_type: Any = None, config_field: str | None = None
) -> bool:
    """
    Check if the configuration data contains the given field or type.

    The method returns the first occurrence of the field or type in the
    configuration data. Either `config_field_type` or `config_field`
    must be provided, but not both.

    Parameters
    ----------
    config_field_type: The type to check for in the configuration data.
    config_field: The field to check for in the configuration data.

    Returns
    -------
    bool: True if the configuration data contains the field or type.

    Raises
    ------
    ValueError: If neither `config_field_type` nor `config_field` is
                provided.
    ValueError: If both `config_field_type` and `config_field`
                are provided.
    """

    def _contains_type(config_data, config_type: Any) -> bool:
        if isinstance(config_data, dict):
            for key, value in config_data.items():
                if isinstance(value, config_type):
                    return True
                if _contains_type(value, config_type):
                    return True
        elif isinstance(config_data, list):
            for item in config_data:
                if isinstance(item, config_type):
                    return True
                if _contains_type(item, config_type):
                    return True
        elif isinstance(config_data, Configclass):
            if isinstance(config_data, config_type):
                return True
            for name in type(config_data).model_fields.keys():
                if _contains_type(getattr(config_data, name), config_type):
                    return True
        elif isinstance(config_data, config_type):
            return True
        return False

    def _contains_field(config_data, field: str) -> bool:
        if isinstance(config_data, dict):
            if field in config_data:
                return True
            for value in config_data.values():
                if _contains_field(value, field):
                    return True
        elif isinstance(config_data, list):
            if field in config_data:
                return True
            for item in config_data:
                if _contains_field(item, field):
                    return True
        elif isinstance(config_data, Configclass):
            if field in list(type(config_data).model_fields.keys()):
                return True
            for name in type(config_data).model_fields.keys():
                if _contains_field(getattr(config_data, name), field):
                    return True
        return False

    if config_field_type is None and config_field is None:
        msg = (
            "Either config_field_type or config_field " "must be provided."
        )
        raise ValueError(msg)
    if config_field_type is not None and config_field is not None:
        msg = (
            "Only one of config_field_type or config_field"
            "can be provided."
        )
        raise ValueError(msg)
    if config_field is not None:
        return _contains_field(self.config_data, config_field)
    if config_field_type is not None:
        return _contains_type(self.config_data, config_field_type)
    return False

from_python classmethod

Create a Configparser instance from Python data.

Parameters

data: The configuration data as a dictionary, Configclass, or list. config_file: The configuration file path. config_type: The configuration type. autosave: Autosave the configuration file. Defaults to False. autoreload: Autoreload the configuration file. Defaults to False.

Returns
A Configparser instance with the given data.
Source code in src/simple_config_builder/configparser.py 
 77
 78
 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
108
@classmethod
def from_python(
    cls,
    data: dict | Configclass | list,
    config_file: str,
    config_type: ConfigTypes | None = None,
    autosave: bool = False,
    autoreload: bool = False,
) -> "Configparser":
    """
    Create a Configparser instance from Python data.

    Parameters
    ----------
    data: The configuration data as a dictionary, Configclass, or list.
    config_file: The configuration file path.
    config_type: The configuration type.
    autosave: Autosave the configuration file. Defaults to False.
    autoreload: Autoreload the configuration file. Defaults to False.

    Returns
    -------
        A Configparser instance with the given data.
    """
    configparser = cls(
        config_file=config_file,
        config_type=config_type,
        autosave=autosave,
        autoreload=autoreload,
    )
    configparser.config_data = data
    return configparser

reload

Reload the configuration data from the configuration file.

Source code in src/simple_config_builder/configparser.py 
248
249
250
251
252
def reload(self):
    """Reload the configuration data from the configuration file."""
    if self.config_type is None:
        return
    self.config_data = parse_config(self.config_file, self.config_type)

save

Save the configuration data to the configuration file.

Source code in src/simple_config_builder/configparser.py 
242
243
244
245
246
def save(self):
    """Save the configuration data to the configuration file."""
    if self.config_type is None:
        return
    write_config(self.config_file, self.config_data, self.config_type)