Misc cleanup (#3229)

* Misc cleanup

* Improve docstring

* Remove component spec path

* Replace zenml up with zenml login --local

Author: schustmi

src/zenml/artifacts/artifact_config.py

@@ -21,7 +21,6 @@
 from zenml.logger import get_logger
 from zenml.metadata.metadata_types import MetadataType
 from zenml.utils.pydantic_utils import before_validator_handler
-from zenml.utils.string_utils import format_name_template
 
 logger = get_logger(__name__)
 
@@ -118,16 +117,3 @@ def _remove_old_attributes(cls, data: Dict[str, Any]) -> Dict[str, Any]:
             data.setdefault("artifact_type", ArtifactType.SERVICE)
 
         return data
-
-    def _evaluated_name(self, substitutions: Dict[str, str]) -> Optional[str]:
-        """Evaluated name of the artifact.
-
-        Args:
-            substitutions: Extra placeholders to use in the name template.
-
-        Returns:
-            The evaluated name of the artifact.
-        """
-        if self.name:
-            return format_name_template(self.name, substitutions=substitutions)
-        return self.name

src/zenml/cli/server.py

@@ -469,7 +469,7 @@ def logs(
     if server is None:
         cli_utils.error(
             "The local ZenML dashboard is not running. Please call `zenml "
-            "up` first to start the ZenML dashboard locally."
+            "login --local` first to start the ZenML dashboard locally."
         )
 
     from zenml.zen_server.deploy.deployer import LocalServerDeployer

src/zenml/cli/stack.py

@@ -1129,14 +1129,12 @@ def export_stack(
 def _import_stack_component(
     component_type: StackComponentType,
     component_dict: Dict[str, Any],
-    component_spec_path: Optional[str] = None,
 ) -> UUID:
     """Import a single stack component with given type/config.
 
     Args:
         component_type: The type of component to import.
         component_dict: Dict representation of the component to import.
-        component_spec_path: Path to the component spec file.
 
     Returns:
         The ID of the imported component.
@@ -1172,7 +1170,6 @@ def _import_stack_component(
         component_type=component_type,
         flavor=flavor,
         configuration=config,
-        component_spec_path=component_spec_path,
     )
     return component.id
 

src/zenml/cli/stack_components.py

@@ -573,7 +573,6 @@ def copy_stack_component_command(
                 component_type=component_to_copy.type,
                 configuration=component_to_copy.configuration,
                 labels=component_to_copy.labels,
-                component_spec_path=component_to_copy.component_spec_path,
             )
             print_model_url(get_component_url(copied_component))
 

src/zenml/cli/utils.py

@@ -711,11 +711,6 @@ def print_stack_component_configuration(
 
         console.print(rich_table)
 
-    if component.component_spec_path:
-        declare(
-            f"Component spec path for `mlstacks`: {component.component_spec_path}"
-        )
-
 
 def expand_argument_value_from_file(name: str, value: str) -> str:
     """Expands the value of an argument pointing to a file into the contents of that file.

src/zenml/client.py

@@ -1979,15 +1979,13 @@ def create_stack_component(
         flavor: str,
         component_type: StackComponentType,
         configuration: Dict[str, str],
-        component_spec_path: Optional[str] = None,
         labels: Optional[Dict[str, Any]] = None,
     ) -> "ComponentResponse":
         """Registers a stack component.
 
         Args:
             name: The name of the stack component.
             flavor: The flavor of the stack component.
-            component_spec_path: The path to the stack spec file.
             component_type: The type of the stack component.
             configuration: The configuration of the stack component.
             labels: The labels of the stack component.
@@ -2016,7 +2014,6 @@ def create_stack_component(
             name=name,
             type=component_type,
             flavor=flavor,
-            component_spec_path=component_spec_path,
             configuration=configuration,
             user=self.active_user.id,
             workspace=self.active_workspace.id,
@@ -2033,7 +2030,6 @@ def update_stack_component(
         name_id_or_prefix: Optional[Union[UUID, str]],
         component_type: StackComponentType,
         name: Optional[str] = None,
-        component_spec_path: Optional[str] = None,
         configuration: Optional[Dict[str, Any]] = None,
         labels: Optional[Dict[str, Any]] = None,
         disconnect: Optional[bool] = None,
@@ -2047,7 +2043,6 @@ def update_stack_component(
                 update.
             component_type: The type of the stack component to update.
             name: The new name of the stack component.
-            component_spec_path: The new path to the stack spec file.
             configuration: The new configuration of the stack component.
             labels: The new labels of the stack component.
             disconnect: Whether to disconnect the stack component from its
@@ -2072,7 +2067,6 @@ def update_stack_component(
         update_model = ComponentUpdate(
             workspace=self.active_workspace.id,
             user=self.active_user.id,
-            component_spec_path=component_spec_path,
         )
 
         if name is not None:

src/zenml/model/model.py

@@ -537,7 +537,7 @@ def _get_or_create_model(self) -> "ModelResponse":
 
         zenml_client = Client()
         # backup logic, if the Model class is used directly from the code
-        self.name = format_name_template(self.name, substitutions={})
+        self.name = format_name_template(self.name)
         if self.model_version_id:
             mv = zenml_client.get_model_version(
                 model_version_name_or_number_or_id=self.model_version_id,
@@ -667,7 +667,7 @@ def _get_or_create_model_version(
 
         # backup logic, if the Model class is used directly from the code
         if isinstance(self.version, str):
-            self.version = format_name_template(self.version, substitutions={})
+            self.version = format_name_template(self.version)
 
         try:
             if self.version or self.model_version_id:

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

@@ -81,11 +81,6 @@ class ComponentBase(BaseModel):
         title="The stack component labels.",
     )
 
-    component_spec_path: Optional[str] = Field(
-        default=None,
-        title="The path to the component spec used for mlstacks deployments.",
-    )
-
 
 # ------------------ Request Model ------------------
 
@@ -155,10 +150,6 @@ class ComponentUpdate(BaseUpdate):
         title="The stack component labels.",
         default=None,
     )
-    component_spec_path: Optional[str] = Field(
-        title="The path to the component spec used for mlstacks deployments.",
-        default=None,
-    )
     connector: Optional[UUID] = Field(
         title="The service connector linked to this stack component.",
         default=None,
@@ -201,10 +192,6 @@ class ComponentResponseMetadata(WorkspaceScopedResponseMetadata):
         default=None,
         title="The stack component labels.",
     )
-    component_spec_path: Optional[str] = Field(
-        default=None,
-        title="The path to the component spec used for mlstacks deployments.",
-    )
     connector_resource_id: Optional[str] = Field(
         default=None,
         description="The ID of a specific resource instance to "
@@ -325,15 +312,6 @@ def labels(self) -> Optional[Dict[str, Any]]:
         """
         return self.get_metadata().labels
 
-    @property
-    def component_spec_path(self) -> Optional[str]:
-        """The `component_spec_path` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_metadata().component_spec_path
-
     @property
     def connector_resource_id(self) -> Optional[str]:
         """The `connector_resource_id` property.

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

@@ -237,7 +237,7 @@ class PipelineRunResponseMetadata(WorkspaceScopedResponseMetadata):
         default=False,
         description="Whether a template can be created from this run.",
     )
-    steps_substitutions: Dict[str, Dict[str, str]] = Field(
+    step_substitutions: Dict[str, Dict[str, str]] = Field(
         title="Substitutions used in the step runs of this pipeline run.",
         default_factory=dict,
     )

src/zenml/orchestrators/step_launcher.py

@@ -310,8 +310,8 @@ def _create_or_reuse_run(self) -> Tuple[PipelineRunResponse, bool]:
             and a boolean indicating whether the run was created or reused.
         """
         start_time = datetime.utcnow()
-        run_name = orchestrator_utils.get_run_name(
-            run_name_template=self._deployment.run_name_template,
+        run_name = string_utils.format_name_template(
+            name_template=self._deployment.run_name_template,
             substitutions=self._deployment.pipeline_configuration._get_full_substitutions(
                 start_time
             ),

src/zenml/orchestrators/step_runner.py

@@ -56,7 +56,7 @@
     parse_return_type_annotations,
     resolve_type_annotation,
 )
-from zenml.utils import materializer_utils, source_utils
+from zenml.utils import materializer_utils, source_utils, string_utils
 from zenml.utils.typing_utils import get_origin, is_union
 
 if TYPE_CHECKING:
@@ -292,16 +292,15 @@ def _evaluate_artifact_names_in_collections(
         """
         collections.append(output_annotations)
         for k, v in list(output_annotations.items()):
-            _evaluated_name = None
-            if v.artifact_config:
-                _evaluated_name = v.artifact_config._evaluated_name(
-                    step_run.config.substitutions
+            name = k
+            if v.artifact_config and v.artifact_config.name:
+                name = string_utils.format_name_template(
+                    v.artifact_config.name,
+                    substitutions=step_run.config.substitutions,
                 )
-            if _evaluated_name is None:
-                _evaluated_name = k
 
             for d in collections:
-                d[_evaluated_name] = d.pop(k)
+                d[name] = d.pop(k)
 
     def _load_step(self) -> "BaseStep":
         """Load the step instance.

src/zenml/orchestrators/utils.py

@@ -32,7 +32,6 @@
 from zenml.enums import AuthScheme, StackComponentType, StoreType
 from zenml.logger import get_logger
 from zenml.stack import StackComponent
-from zenml.utils.string_utils import format_name_template
 
 logger = get_logger(__name__)
 
@@ -196,29 +195,6 @@ def get_config_environment_vars(
     return environment_vars
 
 
-def get_run_name(run_name_template: str, substitutions: Dict[str, str]) -> str:
-    """Fill out the run name template to get a complete run name.
-
-    Args:
-        run_name_template: The run name template to fill out.
-        substitutions: The substitutions to use in the template.
-
-    Raises:
-        ValueError: If the run name is empty.
-
-    Returns:
-        The run name derived from the template.
-    """
-    run_name = format_name_template(
-        run_name_template, substitutions=substitutions
-    )
-
-    if run_name == "":
-        raise ValueError("Empty run names are not allowed.")
-
-    return run_name
-
-
 class register_artifact_store_filesystem:
     """Context manager for the artifact_store/filesystem_registry dependency.
 

src/zenml/pipelines/run_utils.py

@@ -23,9 +23,8 @@
     StackResponse,
 )
 from zenml.orchestrators.publish_utils import publish_failed_pipeline_run
-from zenml.orchestrators.utils import get_run_name
 from zenml.stack import Flavor, Stack
-from zenml.utils import code_utils, notebook_utils, source_utils
+from zenml.utils import code_utils, notebook_utils, source_utils, string_utils
 from zenml.zen_stores.base_zen_store import BaseZenStore
 
 if TYPE_CHECKING:
@@ -68,8 +67,8 @@ def create_placeholder_run(
         return None
     start_time = datetime.utcnow()
     run_request = PipelineRunRequest(
-        name=get_run_name(
-            run_name_template=deployment.run_name_template,
+        name=string_utils.format_name_template(
+            name_template=deployment.run_name_template,
             substitutions=deployment.pipeline_configuration._get_full_substitutions(
                 start_time
             ),

src/zenml/utils/string_utils.py

@@ -18,7 +18,7 @@
 import random
 import string
 from datetime import datetime
-from typing import Any, Callable, Dict, TypeVar, cast
+from typing import Any, Callable, Dict, Optional, TypeVar, cast
 
 from pydantic import BaseModel
 
@@ -147,24 +147,26 @@ def validate_name(model: BaseModel) -> None:
 
 def format_name_template(
     name_template: str,
-    substitutions: Dict[str, str],
+    substitutions: Optional[Dict[str, str]] = None,
 ) -> str:
     """Formats a name template with the given arguments.
 
-    By default, ZenML support Date and Time placeholders.
-    E.g. `my_run_{date}_{time}` will be formatted as `my_run_1970_01_01_00_00_00`.
-    Extra placeholders need to be explicitly passed in as kwargs.
+    Default substitutions for `{date}` and `{time}` placeholders will be used if
+    not included in the provided substitutions.
 
     Args:
         name_template: The name template to format.
-        substitutions: A dictionary of substitutions to use in the template.
+        substitutions: Substitutions to use in the template.
 
     Returns:
         The formatted name template.
 
     Raises:
-        KeyError: If a key in template is missing in the kwargs.
+        KeyError: If a key in template is missing in the substitutions.
+        ValueError: If the formatted name is empty.
     """
+    substitutions = substitutions or {}
+
     if ("date" not in substitutions and "{date}" in name_template) or (
         "time" not in substitutions and "{time}" in name_template
     ):
@@ -183,13 +185,18 @@ def format_name_template(
         substitutions.setdefault("time", start_time.strftime("%H_%M_%S_%f"))
 
     try:
-        return name_template.format(**substitutions)
+        formatted_name = name_template.format(**substitutions)
     except KeyError as e:
         raise KeyError(
             f"Could not format the name template `{name_template}`. "
             f"Missing key: {e}"
         )
 
+    if not formatted_name:
+        raise ValueError("Empty names are not allowed.")
+
+    return formatted_name
+
 
 def substitute_string(value: V, substitution_func: Callable[[str], str]) -> V:
     """Recursively substitute strings in objects.