mvtsdatatoolkit.configs package

Submodules

mvtsdatatoolkit.configs.config_reader module

class mvtsdatatoolkit.configs.config_reader.ConfigReader(path_to_config: str)

Bases: object

This is a simple class to read the configuration file and meanwhile verifies its content. This class must be used whenever the configuration file is needed, instead of the direct reading of the configuration file.

Note: If any new entry be added to the main structure of the configuration file, this class or the constants provided in this module must be carefully reviewed and likely modified.

instruction()

read() → dict

Reads the configuration file and returns a dictionary. It evaluates the file before reading it in the following steps:

• 1. checks if the file exists,

• 2. checks if it is a ‘yml’ file,

• 3. checks if it has all of the keys and nothing extra.

Module contents