deprecate and remove ScriptTemplate

Author: tcjennings

alembic/versions/cef0ebaa8241_deprecate_scripttemplates.py

@@ -0,0 +1,27 @@
+"""Deprecate ScriptTemplates
+
+Revision ID: cef0ebaa8241
+Revises: fb13f1f4ea21
+Create Date: 2025-03-18 20:22:38.960167+00:00
+
+"""
+
+from collections.abc import Sequence
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "cef0ebaa8241"
+down_revision: str | None = "fb13f1f4ea21"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.drop_index(op.f("ix_script_template_name"), table_name="script_template", if_exists=True)
+    op.drop_table("script_template", if_exists=True)
+
+
+def downgrade() -> None:
+    # There is no going back.
+    pass

alembic/versions/d2a05fd9869c_script_template_for_v0_1_4.py

@@ -30,4 +30,4 @@ def upgrade() -> None:
 
 
 def downgrade() -> None:
-    op.drop_table("script_template")
+    op.drop_table("script_template", if_exists=True)

alembic/versions/fb13f1f4ea21_script_template_indices_for_v0_1_4.py

@@ -22,4 +22,4 @@ def upgrade() -> None:
 
 
 def downgrade() -> None:
-    op.drop_index(op.f("ix_script_template_name"), table_name="script_template")
+    op.drop_index(op.f("ix_script_template_name"), table_name="script_template", if_exists=True)

src/lsst/cmservice/cli/client.py

@@ -14,7 +14,6 @@
 from .script import script_group
 from .script_dependency import script_dependency_group
 from .script_error import script_error_group
-from .script_template import script_template_group
 from .spec_block import spec_block_group
 from .specification import specification_group
 from .step import step_group
@@ -40,7 +39,6 @@
         script_group,
         script_dependency_group,
         script_error_group,
-        script_template_group,
         spec_block_group,
         specification_group,
         step_dependency_group,

src/lsst/cmservice/cli/load.py

@@ -28,7 +28,6 @@ def specification(
     result = client.load.specification_cl(**kwargs)
     specifications = result.get("Specification", [])
     spec_blocks = result.get("SpecBlock", [])
-    script_templates = result.get("ScriptTemplate", [])
 
     do_print = output not in [options.OutputEnum.json, options.OutputEnum.yaml]
     if do_print:
@@ -37,9 +36,6 @@ def specification(
     if do_print:
         print("SpecBlocks: -----")
         output_pydantic_list(spec_blocks, output, db.SpecBlock.col_names_for_table)
-    if do_print:
-        print("ScriptTemplates: -----")
-        output_pydantic_list(script_templates, output, db.ScriptTemplate.col_names_for_table)
 
 
 @load_group.command(name="campaign")

src/lsst/cmservice/cli/options.py

@@ -48,7 +48,6 @@
     "rematch",
     "row_id",
     "script_id",
-    "script_template_name",
     "script_name",
     "scripts",
     "spec_aliases",
@@ -184,7 +183,7 @@ class OutputEnum(Enum):
     "--alias",
     type=str,
     default=None,
-    help="Alias for a ScriptTemplate or SpecBlock association",
+    help="Alias for a SpecBlock association",
 )
 
 
@@ -391,13 +390,6 @@ class OutputEnum(Enum):
 )
 
 
-script_template_name = PartialOption(
-    "--script_template_name",
-    type=str,
-    help="Name of a ScriptTemplate",
-)
-
-
 scripts = PartialOption(
     "--scripts",
     type=DictParamType(),

src/lsst/cmservice/cli/script_template.py

@@ -31,7 +31,6 @@
 from .queues import CMQueueClient
 from .script_dependencies import CMScriptDependencyClient
 from .script_errors import CMScriptErrorClient
-from .script_templates import CMScriptTemplateClient
 from .scripts import CMScriptClient
 from .spec_blocks import CMSpecBlockClient
 from .specifications import CMSpecificationClient
@@ -54,7 +53,6 @@
     "CMQueueClient",
     "CMScriptDependencyClient",
     "CMScriptErrorClient",
-    "CMScriptTemplateClient",
     "CMScriptClient",
     "CMSpecBlockClient",
     "CMSpecificationClient",

src/lsst/cmservice/client/__init__.py

@@ -19,7 +19,6 @@
 from .queues import CMQueueClient
 from .script_dependencies import CMScriptDependencyClient
 from .script_errors import CMScriptErrorClient
-from .script_templates import CMScriptTemplateClient
 from .scripts import CMScriptClient
 from .spec_blocks import CMSpecBlockClient
 from .specifications import CMSpecificationClient
@@ -59,7 +58,6 @@ def __init__(self: CMClient) -> None:
 
         self.specification = CMSpecificationClient(self)
         self.spec_block = CMSpecBlockClient(self)
-        self.script_template = CMScriptTemplateClient(self)
 
         self.pipetask_error_type = CMPipetaskErrorTypeClient(self)
         self.pipetask_error = CMPipetaskErrorClient(self)

src/lsst/cmservice/client/client.py

@@ -115,51 +115,6 @@ def _upsert_spec_block(
             steps=block_data.get("steps"),
         )
 
-    def _upsert_script_template(
-        self,
-        config_values: dict,
-        *,
-        allow_update: bool = False,
-    ) -> models.ScriptTemplate:
-        """Upsert and return a ScriptTemplate
-
-        This will create a new ScriptTemplate, or update an existing one
-
-        Parameters
-        ----------
-        config_values: dict
-            Values for the ScriptTemplate
-
-        allow_update: bool
-            Allow updating existing templates
-
-        Returns
-        -------
-        script_template: ScriptTemplate
-            Newly created or updated ScriptTemplate
-        """
-        key = config_values.pop("name")
-        script_template = self._parent.script_template.get_row_by_name(key)
-        if script_template and not allow_update:
-            return script_template
-
-        file_path = config_values["file_path"]
-        full_file_path = os.path.abspath(os.path.expandvars(file_path))
-        with open(full_file_path, encoding="utf-8") as fin:
-            data = yaml.safe_load(fin)
-
-        if script_template is None:
-            return self._parent.script_template.create(
-                name=key,
-                data=data,
-            )
-
-        return self._parent.script_template.update(
-            row_id=script_template.id,
-            name=key,
-            data=data,
-        )
-
     def _upsert_specification(
         self,
         config_values: dict,
@@ -173,7 +128,7 @@ def _upsert_specification(
         Parameters
         ----------
         config_values: dict
-            Values for the ScriptTemplate
+            Values for the Specification
 
         allow_update: bool
             Allow updating existing templates
@@ -232,7 +187,6 @@ def specification_cl(
         out_dict: dict[str, list[BaseModel]] = dict(
             Specification=[],
             SpecBlock=[],
-            ScriptTemplate=[],
         )
 
         for config_item in spec_data:
@@ -253,20 +207,14 @@ def specification_cl(
                     allow_update=allow_update,
                 )
                 out_dict["SpecBlock"].append(spec_block)
-            elif "ScriptTemplate" in config_item:
-                script_template = self._upsert_script_template(
-                    config_item["ScriptTemplate"],
-                    allow_update=allow_update,
-                )
-                out_dict["ScriptTemplate"].append(script_template)
             elif "Specification" in config_item:
                 specification = self._upsert_specification(
                     config_item["Specification"],
                     allow_update=allow_update,
                 )
                 out_dict["Specification"].append(specification)
             else:  # pragma: no cover
-                good_keys = "ScriptTemplate | SpecBlock | Specification | Imports"
+                good_keys = "SpecBlock | Specification | Imports"
                 raise CMYamlParseError(f"Expecting one of {good_keys} not: {spec_data.keys()})")
 
         return out_dict