Add hidden option for run templates (#3500)

* Add hidden option for run templates

* Improve filtering and updating via client

Author: schustmi

src/zenml/client.py

@@ -3574,6 +3574,7 @@ def list_run_templates(
         updated: Optional[Union[datetime, str]] = None,
         id: Optional[Union[UUID, str]] = None,
         name: Optional[str] = None,
+        hidden: Optional[bool] = False,
         tag: Optional[str] = None,
         project: Optional[Union[str, UUID]] = None,
         pipeline_id: Optional[Union[str, UUID]] = None,
@@ -3596,6 +3597,7 @@ def list_run_templates(
             updated: Filter by the last updated date.
             id: Filter by run template ID.
             name: Filter by run template name.
+            hidden: Filter by run template hidden status.
             tag: Filter by run template tags.
             project: Filter by project name/ID.
             pipeline_id: Filter by pipeline ID.
@@ -3620,6 +3622,7 @@ def list_run_templates(
             updated=updated,
             id=id,
             name=name,
+            hidden=hidden,
             tag=tag,
             project=project,
             pipeline_id=pipeline_id,
@@ -3640,6 +3643,7 @@ def update_run_template(
         name_id_or_prefix: Union[str, UUID],
         name: Optional[str] = None,
         description: Optional[str] = None,
+        hidden: Optional[bool] = None,
         add_tags: Optional[List[str]] = None,
         remove_tags: Optional[List[str]] = None,
         project: Optional[Union[str, UUID]] = None,
@@ -3650,6 +3654,7 @@ def update_run_template(
             name_id_or_prefix: Name/ID/ID prefix of the template to update.
             name: The new name of the run template.
             description: The new description of the run template.
+            hidden: The new hidden status of the run template.
             add_tags: Tags to add to the run template.
             remove_tags: Tags to remove from the run template.
             project: The project name/ID to filter by.
@@ -3675,6 +3680,7 @@ def update_run_template(
             template_update=RunTemplateUpdate(
                 name=name,
                 description=description,
+                hidden=hidden,
                 add_tags=add_tags,
                 remove_tags=remove_tags,
             ),

src/zenml/models/v2/core/run_template.py

@@ -79,6 +79,10 @@ class RunTemplateRequest(ProjectScopedRequest):
     source_deployment_id: UUID = Field(
         title="The deployment that should be the base of the created template."
     )
+    hidden: bool = Field(
+        default=False,
+        title="Whether the run template is hidden.",
+    )
     tags: Optional[List[str]] = Field(
         default=None,
         title="Tags of the run template.",
@@ -101,6 +105,10 @@ class RunTemplateUpdate(BaseUpdate):
         title="The description of the run template.",
         max_length=TEXT_FIELD_MAX_LENGTH,
     )
+    hidden: Optional[bool] = Field(
+        default=None,
+        title="Whether the run template is hidden.",
+    )
     add_tags: Optional[List[str]] = Field(
         default=None, title="New tags to add to the run template."
     )
@@ -118,6 +126,10 @@ class RunTemplateResponseBody(ProjectScopedResponseBody):
     runnable: bool = Field(
         title="If a run can be started from the template.",
     )
+    hidden: bool = Field(
+        default=False,
+        title="Whether the run template is hidden.",
+    )
     latest_run_id: Optional[UUID] = Field(
         default=None,
         title="The ID of the latest run of the run template.",
@@ -205,6 +217,15 @@ def runnable(self) -> bool:
         """
         return self.get_body().runnable
 
+    @property
+    def hidden(self) -> bool:
+        """The `hidden` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().hidden
+
     @property
     def latest_run_id(self) -> Optional[UUID]:
         """The `latest_run_id` property.
@@ -320,6 +341,7 @@ class RunTemplateFilter(ProjectScopedFilter, TaggableFilter):
         "pipeline_id",
         "pipeline",
         "stack",
+        "hidden",
     ]
     CUSTOM_SORTING_OPTIONS = [
         *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
@@ -334,6 +356,10 @@ class RunTemplateFilter(ProjectScopedFilter, TaggableFilter):
         default=None,
         description="Name of the run template.",
     )
+    hidden: Optional[bool] = Field(
+        default=None,
+        description="Whether the run template is hidden.",
+    )
     pipeline_id: Optional[Union[UUID, str]] = Field(
         default=None,
         description="Pipeline associated with the template.",
@@ -376,7 +402,7 @@ def get_custom_filters(
         """
         custom_filters = super().get_custom_filters(table)
 
-        from sqlmodel import and_
+        from sqlmodel import and_, col
 
         from zenml.zen_stores.schemas import (
             CodeReferenceSchema,
@@ -386,6 +412,11 @@ def get_custom_filters(
             StackSchema,
         )
 
+        if self.hidden is not None:
+            custom_filters.append(
+                col(RunTemplateSchema.hidden).is_(self.hidden)
+            )
+
         if self.code_repository_id:
             code_repo_filter = and_(
                 RunTemplateSchema.source_deployment_id

src/zenml/zen_stores/migrations/versions/6611d4bcc95b_add_hidden_option_for_templates.py

@@ -0,0 +1,47 @@
+"""Add hidden option for templates [6611d4bcc95b].
+
+Revision ID: 6611d4bcc95b
+Revises: 0.80.1
+Create Date: 2025-04-07 10:29:26.130057
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "6611d4bcc95b"
+down_revision = "0.80.1"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade database schema and/or data, creating a new revision."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("run_template", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("hidden", sa.Boolean(), nullable=True))
+
+    op.execute(
+        """
+        UPDATE `run_template` 
+        SET hidden = 0
+        """
+    )
+
+    with op.batch_alter_table("run_template", schema=None) as batch_op:
+        batch_op.alter_column(
+            "hidden",
+            existing_type=sa.Boolean(),
+            nullable=False,
+        )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade database schema and/or data back to the previous revision."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("run_template", schema=None) as batch_op:
+        batch_op.drop_column("hidden")
+
+    # ### end Alembic commands ###

src/zenml/zen_stores/schemas/run_template_schemas.py

@@ -57,6 +57,11 @@ class RunTemplateSchema(NamedSchema, table=True):
         ),
     )
 
+    hidden: bool = Field(
+        default=False,
+        title="Whether the run template is hidden.",
+    )
+
     description: Optional[str] = Field(
         sa_column=Column(
             String(length=MEDIUMTEXT_MAX_LENGTH).with_variant(
@@ -166,6 +171,7 @@ def from_request(
             project_id=request.project,
             name=request.name,
             description=request.description,
+            hidden=request.hidden,
             source_deployment_id=request.source_deployment_id,
         )
 
@@ -221,6 +227,7 @@ def to_model(
             created=self.created,
             updated=self.updated,
             runnable=runnable,
+            hidden=self.hidden,
             latest_run_id=latest_run.id if latest_run else None,
             latest_run_status=latest_run.status if latest_run else None,
         )