zenml-nightly 0.75.0.dev20250312__py3-none-any.whl → 0.75.0.dev20250313__py3-none-any.whl

zenml/models/v2/core/tag.py

@@ -16,29 +16,34 @@
 import random
 from typing import Optional
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import ColorVariants
-from zenml.models.v2.base.base import (
-    BaseDatedResponseBody,
-    BaseIdentifiedResponse,
-    BaseRequest,
-    BaseResponseMetadata,
-    BaseResponseResources,
+from zenml.models.v2.base.base import BaseUpdate
+from zenml.models.v2.base.scoped import (
+    UserScopedFilter,
+    UserScopedRequest,
+    UserScopedResponse,
+    UserScopedResponseBody,
+    UserScopedResponseMetadata,
+    UserScopedResponseResources,
 )
-from zenml.models.v2.base.filter import BaseFilter
 
 # ------------------ Request Model ------------------
 
 
-class TagRequest(BaseRequest):
+class TagRequest(UserScopedRequest):
     """Request model for tags."""
 
     name: str = Field(
         description="The unique title of the tag.",
         max_length=STR_FIELD_MAX_LENGTH,
     )
+    exclusive: bool = Field(
+        description="The flag signifying whether the tag is an exclusive tag.",
+        default=False,
+    )
     color: ColorVariants = Field(
         description="The color variant assigned to the tag.",
         default_factory=lambda: random.choice(list(ColorVariants)),
@@ -48,35 +53,43 @@ class TagRequest(BaseRequest):
 # ------------------ Update Model ------------------
 
 
-class TagUpdate(BaseModel):
+class TagUpdate(BaseUpdate):
     """Update model for tags."""
 
     name: Optional[str] = None
+    exclusive: Optional[bool] = None
     color: Optional[ColorVariants] = None
 
 
 # ------------------ Response Model ------------------
 
 
-class TagResponseBody(BaseDatedResponseBody):
+class TagResponseBody(UserScopedResponseBody):
     """Response body for tags."""
 
     color: ColorVariants = Field(
         description="The color variant assigned to the tag.",
         default_factory=lambda: random.choice(list(ColorVariants)),
     )
+    exclusive: bool = Field(
+        description="The flag signifying whether the tag is an exclusive tag."
+    )
     tagged_count: int = Field(
         description="The count of resources tagged with this tag."
     )
 
 
-class TagResponseResources(BaseResponseResources):
+class TagResponseMetadata(UserScopedResponseMetadata):
+    """Response metadata for tags."""
+
+
+class TagResponseResources(UserScopedResponseResources):
     """Class for all resource models associated with the tag entity."""
 
 
 class TagResponse(
-    BaseIdentifiedResponse[
-        TagResponseBody, BaseResponseMetadata, TagResponseResources
+    UserScopedResponse[
+        TagResponseBody, TagResponseMetadata, TagResponseResources
     ]
 ):
     """Response model for tags."""
@@ -105,6 +118,15 @@ class TagResponse(
         """
         return self.get_body().color
 
+    @property
+    def exclusive(self) -> bool:
+        """The `exclusive` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().exclusive
+
     @property
     def tagged_count(self) -> int:
         """The `tagged_count` property.
@@ -118,7 +140,7 @@ class TagResponse(
 # ------------------ Filter Model ------------------
 
 
-class TagFilter(BaseFilter):
+class TagFilter(UserScopedFilter):
     """Model to enable advanced filtering of all tags."""
 
     name: Optional[str] = Field(
@@ -127,3 +149,7 @@ class TagFilter(BaseFilter):
     color: Optional[ColorVariants] = Field(
         description="The color variant assigned to the tag.", default=None
     )
+    exclusive: Optional[bool] = Field(
+        description="The flag signifying whether the tag is an exclusive tag.",
+        default=None,
+    )

zenml/models/v2/core/user.py

@@ -36,7 +36,7 @@ from zenml.models.v2.base.base import (
     BaseRequest,
     BaseResponseMetadata,
     BaseResponseResources,
-    BaseZenModel,
+    BaseUpdate,
 )
 from zenml.models.v2.base.filter import AnyQuery, BaseFilter
 
@@ -81,6 +81,10 @@ class UserBase(BaseModel):
         default=None,
         title="The metadata associated with the user.",
     )
+    default_workspace_id: Optional[UUID] = Field(
+        default=None,
+        title="The default workspace ID for the user.",
+    )
 
     @classmethod
     def _get_crypt_context(cls) -> "CryptContext":
@@ -176,7 +180,7 @@ class UserRequest(UserBase, BaseRequest):
 # ------------------ Update Model ------------------
 
 
-class UserUpdate(UserBase, BaseZenModel):
+class UserUpdate(UserBase, BaseUpdate):
     """Update model for users."""
 
     name: Optional[str] = Field(
@@ -279,6 +283,10 @@ class UserResponseBody(BaseDatedResponseBody):
     is_admin: bool = Field(
         title="Whether the account is an administrator.",
     )
+    default_workspace_id: Optional[UUID] = Field(
+        default=None,
+        title="The default workspace ID for the user.",
+    )
 
 
 class UserResponseMetadata(BaseResponseMetadata):
@@ -395,6 +403,15 @@ class UserResponse(
         """
         return self.get_body().is_admin
 
+    @property
+    def default_workspace_id(self) -> Optional[UUID]:
+        """The `default_workspace_id` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().default_workspace_id
+
     @property
     def email(self) -> Optional[str]:
         """The `email` property.

zenml/models/v2/misc/statistics.py

@@ -0,0 +1,45 @@
+#  Copyright (c) ZenML GmbH 2023. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+"""Models representing statistics."""
+
+from pydantic import Field
+
+from zenml.models.v2.base.base import (
+    BaseZenModel,
+)
+
+
+class WorkspaceStatistics(BaseZenModel):
+    """Workspace statistics."""
+
+    pipelines: int = Field(
+        title="The number of pipelines.",
+    )
+    runs: int = Field(
+        title="The number of pipeline runs.",
+    )
+
+
+class ServerStatistics(BaseZenModel):
+    """Server statistics."""
+
+    stacks: int = Field(
+        title="The number of stacks.",
+    )
+    components: int = Field(
+        title="The number of components.",
+    )
+    workspaces: int = Field(
+        title="The number of workspaces.",
+    )

zenml/models/v2/misc/tag.py

@@ -0,0 +1,27 @@
+#  Copyright (c) ZenML GmbH 2025. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+"""Utility models for tags."""
+
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+
+from zenml.enums import TaggableResourceTypes
+
+
+class TagResource(BaseModel):
+    """Utility class to help identify resources to tag."""
+
+    id: UUID = Field(title="The ID of the resource.")
+    type: TaggableResourceTypes = Field(title="The type of the resource.")

zenml/orchestrators/cache_utils.py

@@ -117,7 +117,7 @@ def get_cached_step_run(cache_key: str) -> Optional["StepRunResponse"]:
     client = Client()
 
     cache_candidates = client.list_run_steps(
-        workspace_id=client.active_workspace.id,
+        workspace=client.active_workspace.id,
         cache_key=cache_key,
         status=ExecutionStatus.COMPLETED,
         sort_by=f"{SorterOps.DESCENDING}:created",

zenml/orchestrators/input_utils.py

@@ -55,6 +55,7 @@ def resolve_step_inputs(
         for run_step in pagination_utils.depaginate(
             Client().list_run_steps,
             pipeline_run_id=pipeline_run.id,
+            workspace=pipeline_run.workspace.id,
         )
     }
 

zenml/orchestrators/step_launcher.py

@@ -319,7 +319,6 @@ class StepLauncher:
         pipeline_run = PipelineRunRequest(
             name=run_name,
             orchestrator_run_id=self._orchestrator_run_id,
-            user=client.active_user.id,
             workspace=client.active_workspace.id,
             deployment=self._deployment.id,
             pipeline=(

zenml/orchestrators/step_run_utils.py

@@ -73,10 +73,8 @@ class StepRunRequestFactory:
         return StepRunRequest(
             name=invocation_id,
             pipeline_run_id=self.pipeline_run.id,
-            deployment=self.deployment.id,
             status=ExecutionStatus.RUNNING,
             start_time=utc_now(),
-            user=Client().active_user.id,
             workspace=Client().active_workspace.id,
         )
 

zenml/orchestrators/step_runner.py

@@ -56,7 +56,12 @@ from zenml.steps.utils import (
     parse_return_type_annotations,
     resolve_type_annotation,
 )
-from zenml.utils import materializer_utils, source_utils, string_utils
+from zenml.utils import (
+    materializer_utils,
+    source_utils,
+    string_utils,
+    tag_utils,
+)
 from zenml.utils.typing_utils import get_origin, is_union
 
 if TYPE_CHECKING:
@@ -637,6 +642,10 @@ class StepRunner:
 
             # Get full set of tags
             tags = step_context.get_output_tags(output_name)
+            if step_context.pipeline_run.config.tags is not None:
+                for tag in step_context.pipeline_run.config.tags:
+                    if isinstance(tag, tag_utils.Tag) and tag.cascade is True:
+                        tags.append(tag.name)
 
             artifact_request = _store_artifact_data_and_prepare_request(
                 name=artifact_name,

zenml/pipelines/build_utils.py

@@ -215,7 +215,6 @@ def reuse_or_create_pipeline_build(
         build_model = Client().zen_store.get_build(build_id=build)
     else:
         build_request = PipelineBuildRequest(
-            user=Client().active_user.id,
             workspace=Client().active_workspace.id,
             stack=Client().active_stack_model.id,
             pipeline=pipeline_id,
@@ -419,7 +418,6 @@ def create_pipeline_build(
     )
     stack_checksum = compute_stack_checksum(stack=stack_model)
     build_request = PipelineBuildRequest(
-        user=client.active_user.id,
         workspace=client.active_workspace.id,
         stack=stack_model.id,
         pipeline=pipeline_id,

zenml/pipelines/pipeline_decorator.py

@@ -32,6 +32,7 @@ if TYPE_CHECKING:
     from zenml.model.model import Model
     from zenml.pipelines.pipeline_definition import Pipeline
     from zenml.types import HookSpecification
+    from zenml.utils.tag_utils import Tag
 
     F = TypeVar("F", bound=Callable[..., None])
 
@@ -50,7 +51,7 @@ def pipeline(
     enable_artifact_metadata: Optional[bool] = None,
     enable_step_logs: Optional[bool] = None,
     settings: Optional[Dict[str, "SettingsOrDict"]] = None,
-    tags: Optional[List[str]] = None,
+    tags: Optional[List[Union[str, "Tag"]]] = None,
     extra: Optional[Dict[str, Any]] = None,
     on_failure: Optional["HookSpecification"] = None,
     on_success: Optional["HookSpecification"] = None,
@@ -67,7 +68,7 @@ def pipeline(
     enable_artifact_metadata: Optional[bool] = None,
     enable_step_logs: Optional[bool] = None,
     settings: Optional[Dict[str, "SettingsOrDict"]] = None,
-    tags: Optional[List[str]] = None,
+    tags: Optional[List[Union[str, "Tag"]]] = None,
     extra: Optional[Dict[str, Any]] = None,
     on_failure: Optional["HookSpecification"] = None,
     on_success: Optional["HookSpecification"] = None,

zenml/pipelines/pipeline_definition.py

@@ -93,6 +93,7 @@ from zenml.utils import (
     yaml_utils,
 )
 from zenml.utils.string_utils import format_name_template
+from zenml.utils.tag_utils import Tag
 
 if TYPE_CHECKING:
     from zenml.artifacts.external_artifact import ExternalArtifact
@@ -130,7 +131,7 @@ class Pipeline:
         enable_artifact_visualization: Optional[bool] = None,
         enable_step_logs: Optional[bool] = None,
         settings: Optional[Mapping[str, "SettingsOrDict"]] = None,
-        tags: Optional[List[str]] = None,
+        tags: Optional[List[Union[str, "Tag"]]] = None,
         extra: Optional[Dict[str, Any]] = None,
         on_failure: Optional["HookSpecification"] = None,
         on_success: Optional["HookSpecification"] = None,
@@ -293,7 +294,7 @@ class Pipeline:
         enable_artifact_visualization: Optional[bool] = None,
         enable_step_logs: Optional[bool] = None,
         settings: Optional[Mapping[str, "SettingsOrDict"]] = None,
-        tags: Optional[List[str]] = None,
+        tags: Optional[List[Union[str, "Tag"]]] = None,
         extra: Optional[Dict[str, Any]] = None,
         on_failure: Optional["HookSpecification"] = None,
         on_success: Optional["HookSpecification"] = None,
@@ -684,7 +685,6 @@ To avoid this consider setting pipeline parameters only in one place (config or
             orchestrator = components[StackComponentType.ORCHESTRATOR][0]
             schedule_model = ScheduleRequest(
                 workspace=Client().active_workspace.id,
-                user=Client().active_user.id,
                 pipeline_id=pipeline_id,
                 orchestrator_id=orchestrator.id,
                 name=schedule_name,
@@ -770,7 +770,6 @@ To avoid this consider setting pipeline parameters only in one place (config or
             code_path = code_utils.upload_code_if_necessary(code_archive)
 
         request = PipelineDeploymentRequest(
-            user=Client().active_user.id,
             workspace=Client().active_workspace.id,
             stack=stack.id,
             pipeline=pipeline_id,
@@ -1014,6 +1013,7 @@ To avoid this consider setting pipeline parameters only in one place (config or
             for component_type, component in stack.components.items()
         }
         return {
+            "workspace_id": deployment.workspace.id,
             "store_type": Client().zen_store.type.value,
             **stack_metadata,
             "total_steps": len(self.invocations),
@@ -1095,7 +1095,6 @@ To avoid this consider setting pipeline parameters only in one place (config or
         except RuntimeError:
             request = PipelineRequest(
                 workspace=client.active_workspace.id,
-                user=client.active_user.id,
                 name=self.name,
             )
 

zenml/pipelines/run_utils.py

@@ -81,14 +81,14 @@ def create_placeholder_run(
         # running.
         start_time=start_time,
         orchestrator_run_id=None,
-        user=deployment.user.id,
         workspace=deployment.workspace.id,
         deployment=deployment.id,
         pipeline=deployment.pipeline.id if deployment.pipeline else None,
         status=ExecutionStatus.INITIALIZING,
         tags=deployment.pipeline_configuration.tags,
     )
-    return Client().zen_store.create_run(run_request)
+    run, _ = Client().zen_store.get_or_create_run(run_request)
+    return run
 
 
 def get_placeholder_run(
@@ -213,7 +213,7 @@ def validate_stack_is_runnable_from_server(
         assert len(flavors) == 1
         flavor_model = flavors[0]
 
-        if flavor_model.workspace is not None:
+        if flavor_model.is_custom:
             raise ValueError("No custom stack component flavors allowed.")
 
         flavor = Flavor.from_model(flavor_model)

zenml/service_connectors/service_connector.py

@@ -53,7 +53,6 @@ from zenml.models import (
     ServiceConnectorTypedResourcesModel,
     ServiceConnectorTypeModel,
     UserResponse,
-    WorkspaceResponse,
 )
 from zenml.utils.time_utils import utc_now
 
@@ -706,7 +705,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
 
     def to_model(
         self,
-        user: UUID,
         workspace: UUID,
         name: Optional[str] = None,
         description: str = "",
@@ -716,7 +714,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
 
         Args:
             name: The name of the connector.
-            user: The ID of the user that created the connector.
             workspace: The ID of the workspace that the connector belongs to.
             description: The description of the connector.
             labels: The labels of the connector.
@@ -740,7 +737,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
             connector_type=spec.connector_type,
             name=name,
             description=description,
-            user=user,
             workspace=workspace,
             auth_method=self.auth_method,
             expires_at=self.expires_at,
@@ -762,7 +758,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
 
     def to_response_model(
         self,
-        workspace: WorkspaceResponse,
         user: Optional[UserResponse] = None,
         name: Optional[str] = None,
         id: Optional[UUID] = None,
@@ -772,7 +767,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
         """Convert the connector instance to a service connector response model.
 
         Args:
-            workspace: The workspace that the connector belongs to.
             user: The user that created the connector.
             name: The name of the connector.
             id: The ID of the connector.
@@ -810,7 +804,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
                 expires_skew_tolerance=self.expires_skew_tolerance,
             ),
             metadata=ServiceConnectorResponseMetadata(
-                workspace=workspace,
                 expiration_seconds=self.expiration_seconds,
                 labels=labels or {},
             ),

zenml/service_connectors/service_connector_utils.py

@@ -184,7 +184,6 @@ def get_resources_options_from_resource_model_for_full_stack(
     else:
         resource_model = zen_store.verify_service_connector_config(
             service_connector=ServiceConnectorRequest(
-                user=client.active_user.id,
                 workspace=client.active_workspace.id,
                 name="fake",
                 connector_type=connector_details.type,

zenml/stack/authentication_mixin.py

@@ -71,7 +71,7 @@ class AuthenticationMixin(StackComponent):
 
         # Try to resolve the secret using the secret store
         try:
-            return Client().get_secret_by_name_and_scope(
+            return Client().get_secret_by_name_and_private_status(
                 name=self.config.authentication_secret,
             )
         except (KeyError, NotImplementedError):

zenml/stack/flavor.py

@@ -17,7 +17,6 @@ import os
 from abc import abstractmethod
 from typing import Any, Dict, Optional, Type, cast
 
-from zenml.client import Client
 from zenml.enums import StackComponentType
 from zenml.exceptions import CustomFlavorImportError
 from zenml.models import (
@@ -25,7 +24,6 @@ from zenml.models import (
     FlavorResponse,
     ServiceConnectorRequirements,
 )
-from zenml.models.v2.core.flavor import InternalFlavorRequest
 from zenml.stack.stack_component import StackComponent, StackComponentConfig
 from zenml.utils import source_utils
 from zenml.utils.package_utils import is_latest_zenml_version
@@ -167,8 +165,7 @@ class Flavor:
 
         Args:
             integration: The integration to use for the model.
-            is_custom: Whether the flavor is a custom flavor. Custom flavors
-                are then scoped by user and workspace
+            is_custom: Whether the flavor is a custom flavor.
 
         Returns:
             The model.
@@ -189,16 +186,8 @@ class Flavor:
             if connector_requirements
             else None
         )
-        user = None
-        workspace = None
-        if is_custom:
-            user = Client().active_user.id
-            workspace = Client().active_workspace.id
-
-        model_class = FlavorRequest if is_custom else InternalFlavorRequest
-        model = model_class(
-            user=user,
-            workspace=workspace,
+
+        model = FlavorRequest(
             name=self.name,
             type=self.type,
             source=source_utils.resolve(self.__class__).import_path,

zenml/stack/stack_component.py

@@ -215,7 +215,7 @@ class StackComponentConfig(BaseModel, ABC):
 
         # Try to resolve the secret using the secret store
         try:
-            secret = Client().get_secret_by_name_and_scope(
+            secret = Client().get_secret_by_name_and_private_status(
                 name=secret_ref.name,
             )
         except (KeyError, NotImplementedError):
@@ -333,7 +333,6 @@ class StackComponent:
         flavor: str,
         type: StackComponentType,
         user: Optional[UUID],
-        workspace: UUID,
         created: datetime,
         updated: datetime,
         labels: Optional[Dict[str, Any]] = None,
@@ -352,7 +351,6 @@ class StackComponent:
             flavor: The flavor of the component.
             type: The type of the component.
             user: The ID of the user who created the component.
-            workspace: The ID of the workspace the component belongs to.
             created: The creation time of the component.
             updated: The last update time of the component.
             labels: The labels of the component.
@@ -378,7 +376,6 @@ class StackComponent:
         self.flavor = flavor
         self.type = type
         self.user = user
-        self.workspace = workspace
         self.created = created
         self.updated = updated
         self.labels = labels
@@ -417,7 +414,6 @@ class StackComponent:
         try:
             return flavor.implementation_class(
                 user=user_id,
-                workspace=component_model.workspace.id,
                 name=component_model.name,
                 id=component_model.id,
                 config=configuration,

zenml/steps/step_context.py

@@ -384,6 +384,25 @@ class StepContext(metaclass=SingletonMetaClass):
             output.tags = []
         output.tags += tags
 
+    def remove_output_tags(
+        self,
+        tags: List[str],
+        output_name: Optional[str] = None,
+    ) -> None:
+        """Removes tags for a given step output.
+
+        Args:
+            tags: The tags to remove.
+            output_name: Optional name of the output for which to remove the
+                tags. If no name is given and the step only has a single
+                output, the tags of this output will be removed. If the
+                step has multiple outputs, an exception will be raised.
+        """
+        output = self._get_output(output_name)
+        if not output.tags:
+            return
+        output.tags = [tag for tag in output.tags if tag not in tags]
+
 
 class StepContextOutput:
     """Represents a step output in the step context."""

zenml/utils/string_utils.py

@@ -101,7 +101,7 @@ def b64_decode(input_: str) -> str:
 
 
 def random_str(length: int) -> str:
-    """Generate a random human readable string of given length.
+    """Generate a random human-readable string of given length.
 
     Args:
         length: Length of string