feat: separate private section in configuration

The generated configuration file is now divided in two sections: the first one, at the beginning of the file, contains user defined items and global parameters, while the second part, below a specific comment that warns about modification, contains all the private items (the ones whose names begin with `__When__private__` and should not be modified), so that the configuration file itself becomes more manageable

Author: almostearthling

lib/configurator/writer.py

@@ -4,31 +4,61 @@
 from tomlkit import document, comment, item, aot
 from time import strftime
 
+from ..utility import is_private_item_name
 from ..i18n.strings import UI_APP
 
 
+# the comment text constants for the configuration file are defined here
+COMMENT_PUBLIC_SECTION = "global parameters and user defined items"
+COMMENT_PRIVATE_ITEMS = "private items: please do not modify below this line"
+
+
 # all items have an `as_table()` utility that converts them to TOML tables
+# this writer separates private items from user created ones
 def write_whenever_config(filename, tasks, conditions, events, globals) -> None:
+    head = document()
     doc = document()
+    priv = document()
     mod_time = strftime("%Y-%m-%d @%H:%M:%S")
-    doc.add(comment(f"{UI_APP}: {mod_time}"))
+    head.add(comment(f"{UI_APP}: {mod_time}"))
+    head.add(comment(COMMENT_PUBLIC_SECTION))
     for k in globals:
         if globals[k] is not None:
             doc.add(k, item(globals[k]))
+    priv.add(comment(COMMENT_PRIVATE_ITEMS))
+    p = aot()
     t = aot()
     for elem in tasks:
-        t.append(elem.as_table())
+        if is_private_item_name(elem.name):
+            p.append(elem.as_table())
+        else:
+            t.append(elem.as_table())
     doc.append("task", t)
+    priv.append("task", p)
+    p = aot()
     t = aot()
     for elem in conditions:
-        t.append(elem.as_table())
+        if is_private_item_name(elem.name):
+            p.append(elem.as_table())
+        else:
+            t.append(elem.as_table())
     doc.append("condition", t)
+    priv.append("condition", p)
+    p = aot()
     t = aot()
     for elem in events:
-        t.append(elem.as_table())
+        if is_private_item_name(elem.name):
+            p.append(elem.as_table())
+        else:
+            t.append(elem.as_table())
     doc.append("event", t)
+    priv.append("event", p)
     with open(filename, "w") as f:
+        f.write(head.as_string())
+        f.write("\n")
         f.write(doc.as_string())
+        f.write("\n")
+        f.write(priv.as_string())
 
 
 # end.