Skip to content

# Loader

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides the configuration loader.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## `ConfigLoader`

Provides the interface which loads and updates the configuration (if needed).

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`merge_upstream` | `Optional[bool]` | Authorizes the merging of the upstream configuration. .. note:: If value is set to class:`None` (default), we fallback to the :code:`PYFUNCEBLE_AUTO_CONFIGURATION` environment variable. | `None`

Source code in `PyFunceble/config/loader.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
    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
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468

    class ConfigLoader:
        """
        Provides the interface which loads and updates the configuration (if needed).

        :param merge_upstream:
            Authorizes the merging of the upstream configuration.

            .. note::
                If value is set to :py:class:`None` (default), we fallback to the
                :code:`PYFUNCEBLE_AUTO_CONFIGURATION` environment variable.
        """

        path_to_config: Optional[str] = None
        path_to_default_config: Optional[str] = None
        path_to_overwrite_config: Optional[str] = None

        _custom_config: dict = {}
        _merge_upstream: bool = False

        file_helper: FileHelper = FileHelper()
        dict_helper: DictHelper = DictHelper()

        def __init__(self, merge_upstream: Optional[bool] = None) -> None:
            with package_resources.path(
                "PyFunceble.data.infrastructure",
                PyFunceble.storage.DISTRIBUTED_CONFIGURATION_FILENAME,
            ) as file_path:
                self.path_to_default_config = str(file_path)

            self.path_to_config = os.path.join(
                PyFunceble.storage.CONFIG_DIRECTORY,
                PyFunceble.storage.CONFIGURATION_FILENAME,
            )

            self.path_to_overwrite_config = os.path.join(
                PyFunceble.storage.CONFIG_DIRECTORY,
                PyFunceble.storage.CONFIGURATION_OVERWRITE_FILENAME,
            )

            if merge_upstream is not None:
                self.merge_upstream = merge_upstream
            elif EnvironmentVariableHelper("PYFUNCEBLE_AUTO_CONFIGURATION").exists():
                self.merge_upstream = True

        def __del__(self) -> None:
            self.destroy()

        def reload_config(func):  # pylint: disable=no-self-argument
            """
            Reload the configuration (if it was already loaded) after launching the
            decorated method.
            """

            @functools.wraps(func)
            def wrapper(self, *args, **kwargs):
                result = func(self, *args, **kwargs)  # pylint: disable=not-callable

                if self.is_already_loaded():
                    self.start()

                return result

            return wrapper

        @staticmethod
        def conditional_switch(config: dict) -> dict:
            """
            Given the configuration that we are going to load, switches some of
            setting.

            :param config:
                The configuration we are going to load.
            """

            # pylint: disable=too-many-boolean-expressions
            if (
                "cli_testing" in config
                and "ci" in config["cli_testing"]
                and "active" in config["cli_testing"]["ci"]
                and "autocontinue" in config["cli_testing"]
                and bool(config["cli_testing"]["ci"]["active"])
                and not bool(config["cli_testing"]["autocontinue"])
            ):
                # Conditional autocontinue.
                # If we are under continuous integration, the autocontinue should be
                # activated.

                config["cli_testing"]["autocontinue"] = True

            if (
                "lookup" in config
                and "timeout" in config["lookup"]
                and config["lookup"]["timeout"]
                and config["lookup"]["timeout"] < 0
            ):
                # If timeout is set to a negative digit, switch to the default one.
                config["lookup"]["timeout"] = 5

            if (
                "cli_testing" in config
                and "testing_mode" in config["cli_testing"]
                and "platform_contribution" in config["cli_testing"]["testing_mode"]
                and config["cli_testing"]["testing_mode"]["platform_contribution"]
            ):
                # If we are under a special testing mode. We shouldn't generate
                # any files
                config["cli_testing"]["file_generation"]["no_file"] = True
                config["cli_testing"]["display_mode"]["dots"] = True
                config["cli_testing"]["autocontinue"] = False
                config["cli_testing"]["inactive_db"] = False
                config["cli_testing"]["mining"] = False
                config["cli_testing"]["local_network"] = False
                config["cli_testing"]["preload_file"] = False
                config["cli_testing"]["display_mode"]["percentage"] = False
                config["lookup"]["platform"] = False

            return config

        @staticmethod
        def is_already_loaded() -> bool:
            """
            Checks if the configuration was already loaded.
            """

            return bool(PyFunceble.storage.CONFIGURATION)

        @property
        def custom_config(self) -> dict:
            """
            Provides the current state of the :code:`_custom_config` attribute.
            """

            return self._custom_config

        @custom_config.setter
        @reload_config
        def custom_config(self, value: dict) -> None:
            """
            Sets the custom configuration to set after loading.

            Side Effect:
                Directly inject into the configuration variables if it was already
                loaded.

            :raise TypeError:
                When :code:`value` is not a :py:class:`dict`.
            """

            if not isinstance(value, dict):
                raise TypeError(f"<value> should be {dict}, {type(value)} given.")

            if not self._custom_config:
                self._custom_config = value
            else:
                self._custom_config.update(value)

        def set_custom_config(self, value: dict) -> "ConfigLoader":
            """
            Sets the custom configuration to set after loading.

            Side Effect:
                Directly inject into the configuration variables if it was already
                loaded.
            """

            self.custom_config = value

            return self

        @property
        def merge_upstream(self) -> bool:
            """
            Provides the current state of the :code:`_merge_upstream` attribute.
            """

            return self._merge_upstream

        @merge_upstream.setter
        def merge_upstream(self, value: bool) -> None:
            """
            Updates the value of :code:`_merge_upstream` attribute.

            :raise TypeError:
                When :code:`value` is not a :py:class:`bool`.
            """

            if not isinstance(value, bool):
                raise TypeError(f"<value> should be {bool}, {type(value)} given.")

            self._merge_upstream = value

        def set_merge_upstream(self, value: bool) -> "ConfigLoader":
            """
            Updates the value of :code:`_merge_upstream` attribute.
            """

            self.merge_upstream = value

            return self

        def config_file_exist(
            self,
        ) -> bool:  # pragma: no cover ## Existance checker already tested.
            """
            Checks if the config file exists.
            """

            return FileHelper(self.path_to_config).exists()

        def default_config_file_exist(
            self,
        ) -> bool:  # pragma: no cover ## Existance checker already tested.
            """
            Checks if the default configuration file exists.
            """

            return self.file_helper.set_path(self.path_to_default_config).exists()

        def install_missing_infrastructure_files(
            self,
        ) -> "ConfigLoader":  # pragma: no cover ## Copy method already tested
            """
            Installs the missing files (when needed).

            .. note::
                Installed if missing:
                    - The configuration file.
                    - The directory structure file.
            """

            if not self.is_already_loaded():
                if not self.file_helper.set_path(self.path_to_config).exists():
                    self.file_helper.set_path(self.path_to_default_config).copy(
                        self.path_to_config
                    )

            return self

        @classmethod
        def download_dynamic_infrastructure_files(
            cls,
        ) -> "ConfigLoader":
            """
            Downloads all the dynamicly (generated) infrastructure files.

            .. note::
                Downloaded if missing:
                    - The IANA dump file.
                    - The Public Suffix dump file.
            """

            ## pragma: no cover ## Underlying download methods already tested.

            if not cls.is_already_loaded():
                IANADownloader().start()
                PublicSuffixDownloader().start()
                UserAgentsDownloader().start()

        def get_config_file_content(self) -> dict:
            """
            Provides the content of the configuration file or the one already loaded.
            """

            def is_3_x_version(config: dict) -> bool:
                """
                Checks if the given configuration is an old one.

                :param config:
                    The config to work with.
                """

                return config and "days_between_inactive_db_clean" in config

            if not self.is_already_loaded():
                self.install_missing_infrastructure_files()
                self.download_dynamic_infrastructure_files()

            try:
                config = self.dict_helper.from_yaml_file(self.path_to_config)
            except MarkedYAMLError:
                self.file_helper.set_path(self.path_to_default_config).copy(
                    self.path_to_config
                )
                config = self.dict_helper.from_yaml_file(self.path_to_config)

            config_comparer = ConfigComparison(
                local_config=config,
                upstream_config=self.dict_helper.from_yaml_file(
                    self.path_to_default_config
                ),
            )

            if (
                not config
                or not isinstance(config, dict)
                or self.merge_upstream
                or is_3_x_version(config)
                or not config_comparer.is_local_identical()
            ):  # pragma: no cover ## Testing the underlying comparison method is sufficent
                config = config_comparer.get_merged()

                self.dict_helper.set_subject(config).to_yaml_file(self.path_to_config)

            if self.file_helper.set_path(self.path_to_overwrite_config).exists():
                overwrite_data = self.dict_helper.from_yaml_file(
                    self.path_to_overwrite_config
                )

                if isinstance(overwrite_data, dict):
                    config = Merge(
                        self.dict_helper.from_yaml_file(self.path_to_overwrite_config)
                    ).into(config)
            else:  # pragma: no cover  ## Just make it visible to end-user.
                self.file_helper.write("")

            return config

        def get_configured_value(self, entry: str) -> Any:
            """
            Provides the currently configured value.

            :param entry:
                An entry to check.

                multilevel should be separated with a point.

            :raise RuntimeError:
                When the configuration is not loaded yet.

            :raise ValueError:
                When the given :code:`entry` is not found.
            """

            if not self.is_already_loaded():
                raise RuntimeError("Configuration not loaded, yet.")

            if entry not in PyFunceble.storage.FLATTEN_CONFIGURATION:
                raise ValueError(f"<entry> ({entry!r}) not in loaded configuration.")

            return PyFunceble.storage.FLATTEN_CONFIGURATION[entry]

        def start(self) -> "ConfigLoader":
            """
            Starts the loading processIs.
            """

            config = self.get_config_file_content()

            if self.custom_config:
                config = Merge(self.custom_config).into(config)

            config = self.conditional_switch(config)

            PyFunceble.storage.CONFIGURATION = Box(
                config,
            )
            PyFunceble.storage.FLATTEN_CONFIGURATION = DictHelper(
                PyFunceble.storage.CONFIGURATION
            ).flatten()
            PyFunceble.storage.HTTP_CODES = Box(
                config["http_codes"],
            )
            if "platform" in config and config["platform"]:
                PyFunceble.storage.PLATFORM = Box(config["platform"])
            PyFunceble.storage.LINKS = Box(config["links"])

            if "proxy" in config and config["proxy"]:
                PyFunceble.storage.PROXY = Box(config["proxy"])

            return self

        def destroy(self) -> "ConfigLoader":
            """
            Destroys everything loaded.
            """

            try:
                PyFunceble.storage.CONFIGURATION = Box(
                    {},
                )
                PyFunceble.storage.FLATTEN_CONFIGURATION = {}
                PyFunceble.storage.HTTP_CODES = Box({})
                PyFunceble.storage.PLATFORM = Box({})
                PyFunceble.storage.LINKS = Box({})
                PyFunceble.storage.PROXY = Box({})
            except (AttributeError, TypeError):  # pragma: no cover ## Safety.
                pass

            # This is not a mistake.
            self._custom_config = {}

            return self

### `custom_config: dict` `property` `writable`

Provides the current state of the :code:`_custom_config` attribute.

### `merge_upstream: bool` `property` `writable`

Provides the current state of the :code:`_merge_upstream` attribute.

### `conditional_switch(config)` `staticmethod`

Given the configuration that we are going to load, switches some of setting.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`config` | `dict` | The configuration we are going to load. | required

Source code in `PyFunceble/config/loader.py`

    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

    @staticmethod
    def conditional_switch(config: dict) -> dict:
        """
        Given the configuration that we are going to load, switches some of
        setting.

        :param config:
            The configuration we are going to load.
        """

        # pylint: disable=too-many-boolean-expressions
        if (
            "cli_testing" in config
            and "ci" in config["cli_testing"]
            and "active" in config["cli_testing"]["ci"]
            and "autocontinue" in config["cli_testing"]
            and bool(config["cli_testing"]["ci"]["active"])
            and not bool(config["cli_testing"]["autocontinue"])
        ):
            # Conditional autocontinue.
            # If we are under continuous integration, the autocontinue should be
            # activated.

            config["cli_testing"]["autocontinue"] = True

        if (
            "lookup" in config
            and "timeout" in config["lookup"]
            and config["lookup"]["timeout"]
            and config["lookup"]["timeout"] < 0
        ):
            # If timeout is set to a negative digit, switch to the default one.
            config["lookup"]["timeout"] = 5

        if (
            "cli_testing" in config
            and "testing_mode" in config["cli_testing"]
            and "platform_contribution" in config["cli_testing"]["testing_mode"]
            and config["cli_testing"]["testing_mode"]["platform_contribution"]
        ):
            # If we are under a special testing mode. We shouldn't generate
            # any files
            config["cli_testing"]["file_generation"]["no_file"] = True
            config["cli_testing"]["display_mode"]["dots"] = True
            config["cli_testing"]["autocontinue"] = False
            config["cli_testing"]["inactive_db"] = False
            config["cli_testing"]["mining"] = False
            config["cli_testing"]["local_network"] = False
            config["cli_testing"]["preload_file"] = False
            config["cli_testing"]["display_mode"]["percentage"] = False
            config["lookup"]["platform"] = False

        return config

### `config_file_exist()`

Checks if the config file exists.

Source code in `PyFunceble/config/loader.py`

    277
    278
    279
    280
    281
    282
    283
    284

    def config_file_exist(
        self,
    ) -> bool:  # pragma: no cover ## Existance checker already tested.
        """
        Checks if the config file exists.
        """

        return FileHelper(self.path_to_config).exists()

### `default_config_file_exist()`

Checks if the default configuration file exists.

Source code in `PyFunceble/config/loader.py`

    286
    287
    288
    289
    290
    291
    292
    293

    def default_config_file_exist(
        self,
    ) -> bool:  # pragma: no cover ## Existance checker already tested.
        """
        Checks if the default configuration file exists.
        """

        return self.file_helper.set_path(self.path_to_default_config).exists()

### `destroy()`

Destroys everything loaded.

Source code in `PyFunceble/config/loader.py`

    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468

    def destroy(self) -> "ConfigLoader":
        """
        Destroys everything loaded.
        """

        try:
            PyFunceble.storage.CONFIGURATION = Box(
                {},
            )
            PyFunceble.storage.FLATTEN_CONFIGURATION = {}
            PyFunceble.storage.HTTP_CODES = Box({})
            PyFunceble.storage.PLATFORM = Box({})
            PyFunceble.storage.LINKS = Box({})
            PyFunceble.storage.PROXY = Box({})
        except (AttributeError, TypeError):  # pragma: no cover ## Safety.
            pass

        # This is not a mistake.
        self._custom_config = {}

        return self

### `download_dynamic_infrastructure_files()` `classmethod`

Downloads all the dynamicly (generated) infrastructure files.

.. note:: Downloaded if missing: - The IANA dump file. - The Public Suffix dump file.

Source code in `PyFunceble/config/loader.py`

    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333

    @classmethod
    def download_dynamic_infrastructure_files(
        cls,
    ) -> "ConfigLoader":
        """
        Downloads all the dynamicly (generated) infrastructure files.

        .. note::
            Downloaded if missing:
                - The IANA dump file.
                - The Public Suffix dump file.
        """

        ## pragma: no cover ## Underlying download methods already tested.

        if not cls.is_already_loaded():
            IANADownloader().start()
            PublicSuffixDownloader().start()
            UserAgentsDownloader().start()

### `get_config_file_content()`

Provides the content of the configuration file or the one already loaded.

Source code in `PyFunceble/config/loader.py`

    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392

    def get_config_file_content(self) -> dict:
        """
        Provides the content of the configuration file or the one already loaded.
        """

        def is_3_x_version(config: dict) -> bool:
            """
            Checks if the given configuration is an old one.

            :param config:
                The config to work with.
            """

            return config and "days_between_inactive_db_clean" in config

        if not self.is_already_loaded():
            self.install_missing_infrastructure_files()
            self.download_dynamic_infrastructure_files()

        try:
            config = self.dict_helper.from_yaml_file(self.path_to_config)
        except MarkedYAMLError:
            self.file_helper.set_path(self.path_to_default_config).copy(
                self.path_to_config
            )
            config = self.dict_helper.from_yaml_file(self.path_to_config)

        config_comparer = ConfigComparison(
            local_config=config,
            upstream_config=self.dict_helper.from_yaml_file(
                self.path_to_default_config
            ),
        )

        if (
            not config
            or not isinstance(config, dict)
            or self.merge_upstream
            or is_3_x_version(config)
            or not config_comparer.is_local_identical()
        ):  # pragma: no cover ## Testing the underlying comparison method is sufficent
            config = config_comparer.get_merged()

            self.dict_helper.set_subject(config).to_yaml_file(self.path_to_config)

        if self.file_helper.set_path(self.path_to_overwrite_config).exists():
            overwrite_data = self.dict_helper.from_yaml_file(
                self.path_to_overwrite_config
            )

            if isinstance(overwrite_data, dict):
                config = Merge(
                    self.dict_helper.from_yaml_file(self.path_to_overwrite_config)
                ).into(config)
        else:  # pragma: no cover  ## Just make it visible to end-user.
            self.file_helper.write("")

        return config

### `get_configured_value(entry)`

Provides the currently configured value.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`entry` | `str` | An entry to check. multilevel should be separated with a point. | required

Raises:

Type | Description
--- | ---
`RuntimeError` | When the configuration is not loaded yet.
`ValueError` | When the given :code:`entry` is not found.

Source code in `PyFunceble/config/loader.py`

    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416

    def get_configured_value(self, entry: str) -> Any:
        """
        Provides the currently configured value.

        :param entry:
            An entry to check.

            multilevel should be separated with a point.

        :raise RuntimeError:
            When the configuration is not loaded yet.

        :raise ValueError:
            When the given :code:`entry` is not found.
        """

        if not self.is_already_loaded():
            raise RuntimeError("Configuration not loaded, yet.")

        if entry not in PyFunceble.storage.FLATTEN_CONFIGURATION:
            raise ValueError(f"<entry> ({entry!r}) not in loaded configuration.")

        return PyFunceble.storage.FLATTEN_CONFIGURATION[entry]

### `install_missing_infrastructure_files()`

Installs the missing files (when needed).

.. note:: Installed if missing: - The configuration file. - The directory structure file.

Source code in `PyFunceble/config/loader.py`

    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313

    def install_missing_infrastructure_files(
        self,
    ) -> "ConfigLoader":  # pragma: no cover ## Copy method already tested
        """
        Installs the missing files (when needed).

        .. note::
            Installed if missing:
                - The configuration file.
                - The directory structure file.
        """

        if not self.is_already_loaded():
            if not self.file_helper.set_path(self.path_to_config).exists():
                self.file_helper.set_path(self.path_to_default_config).copy(
                    self.path_to_config
                )

        return self

### `is_already_loaded()` `staticmethod`

Checks if the configuration was already loaded.

Source code in `PyFunceble/config/loader.py`

    195
    196
    197
    198
    199
    200
    201

    @staticmethod
    def is_already_loaded() -> bool:
        """
        Checks if the configuration was already loaded.
        """

        return bool(PyFunceble.storage.CONFIGURATION)

### `reload_config(func)`

Reload the configuration (if it was already loaded) after launching the decorated method.

Source code in `PyFunceble/config/loader.py`

    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139

    def reload_config(func):  # pylint: disable=no-self-argument
        """
        Reload the configuration (if it was already loaded) after launching the
        decorated method.
        """

        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            result = func(self, *args, **kwargs)  # pylint: disable=not-callable

            if self.is_already_loaded():
                self.start()

            return result

        return wrapper

### `set_custom_config(value)`

Sets the custom configuration to set after loading.

Side Effect: Directly inject into the configuration variables if it was already loaded.

Source code in `PyFunceble/config/loader.py`

    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244

    def set_custom_config(self, value: dict) -> "ConfigLoader":
        """
        Sets the custom configuration to set after loading.

        Side Effect:
            Directly inject into the configuration variables if it was already
            loaded.
        """

        self.custom_config = value

        return self

### `set_merge_upstream(value)`

Updates the value of :code:`_merge_upstream` attribute.

Source code in `PyFunceble/config/loader.py`

    268
    269
    270
    271
    272
    273
    274
    275

    def set_merge_upstream(self, value: bool) -> "ConfigLoader":
        """
        Updates the value of :code:`_merge_upstream` attribute.
        """

        self.merge_upstream = value

        return self

### `start()`

Starts the loading processIs.

Source code in `PyFunceble/config/loader.py`

    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446

    def start(self) -> "ConfigLoader":
        """
        Starts the loading processIs.
        """

        config = self.get_config_file_content()

        if self.custom_config:
            config = Merge(self.custom_config).into(config)

        config = self.conditional_switch(config)

        PyFunceble.storage.CONFIGURATION = Box(
            config,
        )
        PyFunceble.storage.FLATTEN_CONFIGURATION = DictHelper(
            PyFunceble.storage.CONFIGURATION
        ).flatten()
        PyFunceble.storage.HTTP_CODES = Box(
            config["http_codes"],
        )
        if "platform" in config and config["platform"]:
            PyFunceble.storage.PLATFORM = Box(config["platform"])
        PyFunceble.storage.LINKS = Box(config["links"])

        if "proxy" in config and config["proxy"]:
            PyFunceble.storage.PROXY = Box(config["proxy"])

        return self