Rename name templates to validation templates (#594)

* Rename 'name templates' to 'validation templates'.

* Update docs.

* Fix tests.

* Rename 'Template validation' to 'Validation templates'.

* Update images with tui renaming.

* Update backwards compatability tests.

* Improve explaination of templates and add missing closing bracket in docs.

Author: JoeZiminski

datashuttle/configs/canonical_configs.py

@@ -292,9 +292,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:
@@ -306,7 +306,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

@@ -217,13 +217,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,
             allow_letters_in_sub_ses_values,
             log=True,
@@ -260,7 +260,7 @@ 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,
         allow_letters_in_sub_ses_values: bool,
         log: bool = True,
@@ -269,7 +269,7 @@ def _format_and_validate_names(
         format_sub = formatting.check_and_format_names(
             sub_names,
             "sub",
-            name_templates,
+            validation_templates,
             bypass_validation,
             allow_letters_in_sub_ses_values,
         )
@@ -278,7 +278,7 @@ def _format_and_validate_names(
             format_ses = formatting.check_and_format_names(
                 ses_names,
                 "ses",
-                name_templates,
+                validation_templates,
                 bypass_validation,
                 allow_letters_in_sub_ses_values,
             )
@@ -294,7 +294,7 @@ def _format_and_validate_names(
                 include_central=False,
                 display_mode="error",
                 log=log,
-                name_templates=name_templates,
+                validation_templates=validation_templates,
                 allow_letters_in_sub_ses_values=allow_letters_in_sub_ses_values,
             )
 
@@ -1166,9 +1166,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():
@@ -1181,7 +1181,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
@@ -1215,9 +1215,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():
@@ -1230,7 +1230,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
@@ -1245,36 +1245,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
@@ -1355,7 +1357,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
@@ -1369,7 +1371,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,
             allow_letters_in_sub_ses_values=allow_letters_in_sub_ses_values,
         )
@@ -1669,8 +1671,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_templates" not in settings:
+            if "name_templates" in settings:
+                settings["validation_templates"] = settings.pop(
+                    "name_templates"
+                )
+            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 validate_project_from_path(
     top_level_folder: Optional[TopLevelFolder] = "rawdata",
     display_mode: DisplayMode = "warn",
     strict_mode: bool = False,
-    name_templates: Optional[Dict] = None,
+    validation_templates: Optional[Dict] = None,
     allow_letters_in_sub_ses_values: bool = False,
 ) -> List[str]:
     """Perform validation on a NeuroBlueprint-formatted project.
@@ -54,9 +54,9 @@ def validate_project_from_path(
         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.
 
     allow_letters_in_sub_ses_values
@@ -101,7 +101,7 @@ def validate_project_from_path(
         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,
         allow_letters_in_sub_ses_values=allow_letters_in_sub_ses_values,
     )

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
@@ -182,7 +182,7 @@ def validate_names(
                 top_level_folder,
                 sub_names,
                 ses_names,
-                self.get_name_templates(),
+                self.get_validation_templates(),
                 bypass_validation=False,
                 allow_letters_in_sub_ses_values=allow_letters_in_sub_ses_values,
             )
@@ -368,28 +368,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:
@@ -398,7 +400,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: