pi_portal.modules.configuration.user_config.UserConfiguration

class pi_portal.modules.configuration.user_config.UserConfiguration

Bases: JSONFileReader

User configuration.

load(file_path: str = 'config.json') → None

Load and validate the end user’s configuration file.

Parameters:

file_path (str) – The path to the file to load.

load_json_file(json_file_location: Path | str) → Any

Load a JSON file from the filesystem and return it as a Python object.

Parameters:

json_file_location (Path | str) – The path to the source file.

Returns:

The loaded JSON object.

Return type:

Any

validate() → None

Validate the end user’s configuration file.

Raises:

UserConfigurationException