Revize 04a2b5a4

Re #7939
- pridana dokumentace metod a trid
- korekce chyb v jmenech promenych
- pridani informaci pro vygenerovane skripty

python-module/Utilities/ConfigureFunctions.py

@@ -1 +1 @@
 import yaml
 
+# Path to dataset configuration files
+CONFIG_FILES_PATH = "DatasetConfigs/"
+# Config file type
+CONFIG_FILE_TYPE = ".yaml"
 
-def load_configuration(configure_file_name):
 
-    with open(configure_file_name) as f:
+def load_configuration(dataset_name):
+    """
+    Loads yaml configuration file into memory
+
+    Args:
+        dataset_name: name of dataset that has existing configuration file
+
+    Returns:
+        yaml configuration file as dictionary
+    """
+    with open(CONFIG_FILES_PATH + dataset_name + CONFIG_FILE_TYPE, "r") as f:
         data = yaml.load(f, Loader=yaml.FullLoader)
 
     devices_dic = dict()
@@ -17 +30 @@
     return data
 
 
-def update_configuration(configure_file_name, new_devices):
+def update_configuration(dataset_name, new_devices):
+    """
+    Open dataset and appends new_devices to the end
 
-    with open(configure_file_name, "a") as file:
+    Args:
+        dataset_name: name of dataset that has existing configuration file
+        new_devices: list or set of new devices for dataset
+    """
+    with open(CONFIG_FILES_PATH + dataset_name + CONFIG_FILE_TYPE, "a") as file:
         for device in new_devices:
             file.write("  - "+device+":\n")
             file.write("      x: UNKNOWN!\n")