From 0f460b7d0249b1b25c7e7bbecf6e217448bf051e Mon Sep 17 00:00:00 2001 From: CPD Date: Tue, 25 Feb 2025 12:11:13 +0100 Subject: [PATCH] Docstring --- cpdctrl/utility/config_file.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/cpdctrl/utility/config_file.py b/cpdctrl/utility/config_file.py index bad300c..3291564 100644 --- a/cpdctrl/utility/config_file.py +++ b/cpdctrl/utility/config_file.py @@ -2,6 +2,13 @@ from os import environ, makedirs, path import yaml class ConfigFile: + """ + Class managing a yaml config file. + The file is loaded on creation and can be saved with .save(). + + You may initialize an instance with empty string as filepath, + in this case no file will not be loaded or saved. + """ def __init__(self, filepath: str, init_values = None): self.values = {} if init_values: @@ -19,10 +26,14 @@ class ConfigFile: with open(self.filepath, "w") as file: yaml.dump(self.values, file) - def get(self, name: str, default=None): + def get_or(self, name: str, default): if name in self.values: return self.values[name] return default + def get(self, name: str): + if name in self.values: return self.values[name] + raise KeyError(f"Key '{name}' not found in config file '{self.filepath}'") + def set(self, name: str, value): self.values[name] = value