Rename 'name templates' to 'validation templates'.

Author: JoeZiminski

datashuttle/configs/canonical_configs.py

@@ -306,9 +306,9 @@ def get_tui_config_defaults() -> Dict:
     return settings
 
 
-def get_name_templates_defaults() -> Dict:
-    """Return the default values for name_templates."""
-    return {"name_templates": {"on": False, "sub": None, "ses": None}}
+def get_validation_templates_defaults() -> Dict:
+    """Return the default values for validation_templates."""
+    return {"validation_templates": {"on": False, "sub": None, "ses": None}}
 
 
 def get_persistent_settings_defaults() -> Dict:
@@ -320,7 +320,7 @@ def get_persistent_settings_defaults() -> Dict:
     """
     settings = {}
     settings.update(get_tui_config_defaults())
-    settings.update(get_name_templates_defaults())
+    settings.update(get_validation_templates_defaults())
 
     return settings
 

datashuttle/datashuttle_class.py

@@ -209,13 +209,13 @@ def create_folders(
         utils.log("\nFormatting Names...")
         ds_logger.log_names(["sub_names", "ses_names"], [sub_names, ses_names])
 
-        name_templates = self.get_name_templates()
+        validation_templates = self.get_validation_templates()
 
         format_sub, format_ses = self._format_and_validate_names(
             top_level_folder,
             sub_names,
             ses_names,
-            name_templates,
+            validation_templates,
             bypass_validation,
             log=True,
         )
@@ -251,18 +251,18 @@ def _format_and_validate_names(
         top_level_folder: TopLevelFolder,
         sub_names: Union[str, List[str]],
         ses_names: Optional[Union[str, List[str]]],
-        name_templates: Dict,
+        validation_templates: Dict,
         bypass_validation: bool,
         log: bool = True,
     ) -> Tuple[List[str], List[str]]:
         """Central method to format and validate subject and session names."""
         format_sub = formatting.check_and_format_names(
-            sub_names, "sub", name_templates, bypass_validation
+            sub_names, "sub", validation_templates, bypass_validation
         )
 
         if ses_names is not None:
             format_ses = formatting.check_and_format_names(
-                ses_names, "ses", name_templates, bypass_validation
+                ses_names, "ses", validation_templates, bypass_validation
             )
         else:
             format_ses = []
@@ -276,7 +276,7 @@ def _format_and_validate_names(
                 include_central=False,
                 display_mode="error",
                 log=log,
-                name_templates=name_templates,
+                validation_templates=validation_templates,
             )
 
         return format_sub, format_ses
@@ -1147,9 +1147,9 @@ def get_next_sub(
         The next subject ID.
 
         """
-        name_template = self.get_name_templates()
-        name_template_regexp = (
-            name_template["sub"] if name_template["on"] else None
+        validation_template = self.get_validation_templates()
+        validation_template_regexp = (
+            validation_template["sub"] if validation_template["on"] else None
         )
 
         if self.is_local_project():
@@ -1162,7 +1162,7 @@ def get_next_sub(
             include_central=include_central,
             return_with_prefix=return_with_prefix,
             search_str="sub-*",
-            name_template_regexp=name_template_regexp,
+            validation_template_regexp=validation_template_regexp,
         )
 
     @check_configs_set
@@ -1196,9 +1196,9 @@ def get_next_ses(
         The next session ID.
 
         """
-        name_template = self.get_name_templates()
-        name_template_regexp = (
-            name_template["ses"] if name_template["on"] else None
+        validation_template = self.get_validation_templates()
+        validation_template_regexp = (
+            validation_template["ses"] if validation_template["on"] else None
         )
 
         if self.is_local_project():
@@ -1211,7 +1211,7 @@ def get_next_ses(
             include_central=include_central,
             return_with_prefix=return_with_prefix,
             search_str="ses-*",
-            name_template_regexp=name_template_regexp,
+            validation_template_regexp=validation_template_regexp,
         )
 
     @check_configs_set
@@ -1226,36 +1226,38 @@ def is_local_project(self) -> bool:
     # Name Templates
     # -------------------------------------------------------------------------
 
-    def get_name_templates(self) -> Dict:
+    def get_validation_templates(self) -> Dict:
         """Return the regexp templates used for validation.
 
         If the "on" key is set to `False`, template validation is not performed.
 
         Returns
         -------
-        name_templates
-            e.g. {"name_templates": {"on": False, "sub": None, "ses": None}}
+        validation_templates
+            e.g. {"validation_templates": {"on": False, "sub": None, "ses": None}}
 
         """
         settings = self._load_persistent_settings()
-        return settings["name_templates"]
+        return settings["validation_templates"]
 
-    def set_name_templates(self, new_name_templates: Dict) -> None:
+    def set_validation_templates(self, new_validation_templates: Dict) -> None:
         """Update the persistent settings with new name templates.
 
-        Name templates are regexp for that, when ``name_templates["on"]`` is
+        Name templates are regexp for that, when ``validation_templates["on"]`` is
         set to ``True``, ``"sub"`` and ``"ses"`` names are validated against
         the regexp contained in the dict.
 
         Parameters
         ----------
-        new_name_templates
-            e.g. ``{"name_templates": {"on": False, "sub": None, "ses": None}}``
+        new_validation_templates
+            e.g. ``{"validation_templates": {"on": False, "sub": None, "ses": None}}``
             where ``"sub"`` or ``"ses"`` can be a regexp that subject and session
             names respectively are validated against.
 
         """
-        self._update_persistent_setting("name_templates", new_name_templates)
+        self._update_persistent_setting(
+            "validation_templates", new_validation_templates
+        )
 
     # -------------------------------------------------------------------------
     # Showers
@@ -1328,7 +1330,7 @@ def validate_project(
             local_vars=locals(),
         )
 
-        name_templates = self.get_name_templates()
+        validation_templates = self.get_validation_templates()
 
         if self.is_local_project():
             include_central = False
@@ -1342,7 +1344,7 @@ def validate_project(
             top_level_folder_to_validate,
             include_central=include_central,
             display_mode=display_mode,
-            name_templates=name_templates,
+            validation_templates=validation_templates,
             strict_mode=strict_mode,
         )
 
@@ -1624,8 +1626,15 @@ def _update_settings_with_new_canonical_keys(self, settings: Dict) -> None:
         Added keys:
             v0.4.0: tui "overwrite_existing_files" and "dry_run"
         """
-        if "name_templates" not in settings:
-            settings.update(canonical_configs.get_name_templates_defaults())
+        if "validation_template" not in settings:
+            if "validation_template" in settings:
+                settings["validation_template"] = settings.pop(
+                    "validation_template"
+                )
+            else:
+                settings.update(
+                    canonical_configs.get_validation_templates_defaults()
+                )
 
         canonical_tui_configs = canonical_configs.get_tui_config_defaults()
 

datashuttle/datashuttle_functions.py

@@ -27,7 +27,7 @@ def quick_validate_project(
     top_level_folder: Optional[TopLevelFolder] = "rawdata",
     display_mode: DisplayMode = "warn",
     strict_mode: bool = False,
-    name_templates: Optional[Dict] = None,
+    validation_templates: Optional[Dict] = None,
 ) -> List[str]:
     """Perform validation on a NeuroBlueprint-formatted project.
 
@@ -53,9 +53,9 @@ def quick_validate_project(
         any folder not prefixed with sub-, ses- or a valid datatype will
         raise a validation issue.
 
-    name_templates
+    validation_templates
         A dictionary of templates for subject and session name
-        to validate against. See ``DataShuttle.set_name_templates()``
+        to validate against. See ``DataShuttle.set_validation_templates()``
         for details.
 
     Returns
@@ -93,7 +93,7 @@ def quick_validate_project(
         top_level_folder_list=top_level_folders_to_validate,
         include_central=False,
         display_mode=display_mode,
-        name_templates=name_templates,
+        validation_templates=validation_templates,
         strict_mode=strict_mode,
     )
 

datashuttle/tui/interface.py

@@ -35,7 +35,7 @@ class Interface:
     def __init__(self) -> None:
         """Initialise the Interface class."""
         self.project: DataShuttle
-        self.name_templates: Dict = {}
+        self.validation_templates: Dict = {}
         self.tui_settings: Dict = {}
 
         self.gdrive_rclone_setup_process: subprocess.Popen | None = None
@@ -171,7 +171,7 @@ def validate_names(
                 top_level_folder,
                 sub_names,
                 ses_names,
-                self.get_name_templates(),
+                self.get_validation_templates(),
                 bypass_validation=False,
             )
 
@@ -352,28 +352,30 @@ def transfer_custom_selection(
     # Name templates
     # ----------------------------------------------------------------------------------
 
-    def get_name_templates(self) -> Dict:
-        """Return the `name_templates` defining templates to validate against.
+    def get_validation_templates(self) -> Dict:
+        """Return the `validation_templates` defining templates to validate against.
 
         These are stored in a variable to avoid constantly
         reading these values from disk where they are stored in
         `persistent_settings`. It is critical this variable
         and the file contents are in sync, so when changed
         on the TUI side they are updated also, in `get_tui_settings`.
         """
-        if not self.name_templates:
-            self.name_templates = self.project.get_name_templates()
+        if not self.validation_templates:
+            self.validation_templates = self.project.get_validation_templates()
 
-        return self.name_templates
+        return self.validation_templates
 
-    def set_name_templates(self, name_templates: Dict) -> InterfaceOutput:
-        """Set the `name_templates` here and on disk.
+    def set_validation_templates(
+        self, validation_templates: Dict
+    ) -> InterfaceOutput:
+        """Set the `validation_templates` here and on disk.
 
-        See `get_name_templates` for more information.
+        See `get_validation_templates` for more information.
         """
         try:
-            self.project.set_name_templates(name_templates)
-            self.name_templates = name_templates
+            self.project.set_validation_templates(validation_templates)
+            self.validation_templates = validation_templates
             return True, None
 
         except BaseException as e:
@@ -382,7 +384,7 @@ def set_name_templates(self, name_templates: Dict) -> InterfaceOutput:
     def get_tui_settings(self) -> Dict:
         """Return the "tui" field of `persistent_settings`.
 
-        Similar to `get_name_templates`, there are held on the
+        Similar to `get_validation_templates`, there are held on the
         class to avoid constantly reading from disk.
         """
         if not self.tui_settings:

datashuttle/tui/screens/create_folder_settings.py

@@ -29,24 +29,24 @@
 class CreateFoldersSettingsScreen(ModalScreen):
     """Settings for the Create Folders tab.
 
-    Handles setting datashuttle's `name_template`, as well
+    Handles setting datashuttle's `validation_template`, as well
     as the top-level-folder select and option to bypass all validation.
 
     Name Templates
     --------------
     These are regexp templates that can be validated against
     during folder creation / project validation.
 
-    An input is provided to input a `name_template` for validation. When
-    the window is closed, the `name_template` is stored in datashuttle's
+    An input is provided to input a `validation_template` for validation. When
+    the window is closed, the `validation_template` is stored in datashuttle's
     persistent settings.
 
     The Create tab validation of input widgets is immediately updated
     on closing of this screen.
 
     Attributes
     ----------
-    Because the Input for `name_templates` is shared between subject
+    Because the Input for `validation_templates` is shared between subject
     and session, the values are held in the `input_values` attribute.
     These are loaded from `persistent_settings` on init.
 
@@ -131,7 +131,9 @@ def compose(self) -> ComposeResult:
                         Checkbox(
                             "Template validation",
                             id="template_settings_validation_on_checkbox",
-                            value=self.interface.get_name_templates()["on"],
+                            value=self.interface.get_validation_templates()[
+                                "on"
+                            ],
                         ),
                         id="template_inner_horizontal_container",
                     ),
@@ -181,9 +183,9 @@ def on_mount(self) -> None:
 
     def init_input_values_holding_variable(self) -> None:
         """Add the project Name Templates to the relevant Inputs."""
-        name_templates = self.interface.get_name_templates()
-        self.input_values["sub"] = name_templates["sub"]
-        self.input_values["ses"] = name_templates["ses"]
+        validation_templates = self.interface.get_validation_templates()
+        self.input_values["sub"] = validation_templates["sub"]
+        self.input_values["ses"] = validation_templates["ses"]
 
     def switch_template_container_disabled(self) -> None:
         """Switch the name template widgets disabled / enabled."""
@@ -193,7 +195,7 @@ def switch_template_container_disabled(self) -> None:
         self.query_one("#template_inner_container").disabled = not is_on
 
     def fill_input_from_template(self) -> None:
-        """Fill the `name_templates` Input.
+        """Fill the `validation_templates` Input.
 
         The Input is shared between subject and session,
         depending on the current RadioSet value.
@@ -210,15 +212,15 @@ def fill_input_from_template(self) -> None:
     def on_button_pressed(self, event: Button.Pressed) -> None:
         """Handle button press on the screen.
 
-        On close, update the `name_templates` stored in
+        On close, update the `validation_templates` stored in
         `persistent_settings` with those set on the TUI.
 
         Setting may error if templates are turned on but
         no template exists for either subject or session.
         """
         if event.button.id == "create_folders_settings_close_button":
-            success, output = self.interface.set_name_templates(
-                self.make_name_templates_from_widgets()
+            success, output = self.interface.set_validation_templates(
+                self.make_validation_templates_from_widgets()
             )
             if success:
                 self.dismiss(True)
@@ -228,8 +230,8 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
         elif event.button.id == "create_settings_bypass_validation_button":
             self.interface.save_tui_settings(False, "bypass_validation")
 
-    def make_name_templates_from_widgets(self) -> Dict:
-        """Return a canonical `name_templates` entry based on the current widget settings."""
+    def make_validation_templates_from_widgets(self) -> Dict:
+        """Return a canonical `validation_templates` entry based on the current widget settings."""
         return {
             "on": self.query_one(
                 "#template_settings_validation_on_checkbox"
@@ -239,7 +241,7 @@ def make_name_templates_from_widgets(self) -> Dict:
         }
 
     def on_checkbox_changed(self, event: Checkbox.Changed) -> None:
-        """Turn `name_templates` on or off and update the TUI accordingly."""
+        """Turn `validation_templates` on or off and update the TUI accordingly."""
         is_on = event.value
 
         if event.checkbox.id == "template_settings_validation_on_checkbox":