Merge pull request #129 from automl/bug/group-name-visbility-enhancement

Bug/group name visbility enhancement

Author: sarah-segel

CHANGELOG.md

@@ -45,6 +45,10 @@
 - Major overhaul of docstrings in various files
 - Removed unused imports and variables
 
+## Groups
+- Groups now get a default name, if no name was entered by the user.
+- Groups get sorted alphabetically to appear more ordered.
+
 ## Additional Changes
 - Added a "make install examples" in Makefile
 

deepcave/layouts/general.py

@@ -337,6 +337,7 @@ def get_layout(
 
             # Load from cache if page is loaded
             children = []
+
             for name, paths in groups.items():
                 if name is None:
                     continue
@@ -368,10 +369,29 @@ def callback(group_names: List[str], all_run_paths, i):
                 self._refresh_groups = False
                 raise PreventUpdate()
 
+            # For the default group names, if no name was entered
+            group_counter = 0
+
             groups = {}
             for group_name, run_paths in zip(group_names, all_run_paths):
                 if group_name is None or group_name == "":
-                    continue
+                    # Set the default group name with a counter,
+                    # so the groups dont overwrite themselves
+                    group_name_unavailable = True
+
+                    groups_cache = c.get("groups")
+                    if groups_cache is None:
+                        continue
+
+                    # Check to see that no group name that already exists
+                    # gets picked
+                    while group_name_unavailable:
+                        group_name = f"Group {group_counter}"
+                        assert groups_cache is not None
+                        if group_name not in groups_cache.keys():
+                            group_name_unavailable = False
+                        else:
+                            group_counter += 1
 
                 if run_paths is None or len(run_paths) == 0:
                     continue
@@ -386,16 +406,20 @@ def callback(group_names: List[str], all_run_paths, i):
 
                 groups[group_name] = valid_run_paths
 
+            # Sort the groups alphabetically, so when added
+            # they appear ordered
+            sorted_groups = dict(sorted(groups.items()))
+
             try:
                 # Now save it
-                run_handler.update_groups(groups)
+                run_handler.update_groups(sorted_groups)
             except NotMergeableError:
                 notification.update("The selected runs are not mergeable.")
 
                 # This will automatically trigger the group display s.t. the selection is redo.
                 return i + 1
 
-            self.logger.debug(f"Groups: {groups}")
+            self.logger.debug(f"Groups: {sorted_groups}")
 
             raise PreventUpdate()