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

zenml/models/v2/core/tag.py

@@ -14,12 +14,12 @@
 """Models representing tags."""
 
 import random
-from typing import Optional
+from typing import TYPE_CHECKING, ClassVar, List, Optional, Type, TypeVar
 
-from pydantic import Field
+from pydantic import Field, field_validator
 
 from zenml.constants import STR_FIELD_MAX_LENGTH
-from zenml.enums import ColorVariants
+from zenml.enums import ColorVariants, TaggableResourceTypes
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
     UserScopedFilter,
@@ -29,6 +29,14 @@ from zenml.models.v2.base.scoped import (
     UserScopedResponseMetadata,
     UserScopedResponseResources,
 )
+from zenml.utils.uuid_utils import is_valid_uuid
+
+if TYPE_CHECKING:
+    from sqlalchemy.sql.elements import ColumnElement
+
+    from zenml.zen_stores.schemas import BaseSchema
+
+    AnySchema = TypeVar("AnySchema", bound="BaseSchema")
 
 # ------------------ Request Model ------------------
 
@@ -49,6 +57,28 @@ class TagRequest(UserScopedRequest):
         default_factory=lambda: random.choice(list(ColorVariants)),
     )
 
+    @field_validator("name")
+    @classmethod
+    def validate_name_not_uuid(cls, value: str) -> str:
+        """Validates that the tag name is not a UUID.
+
+        Args:
+            value: The tag name to validate.
+
+        Returns:
+            The validated tag name.
+
+        Raises:
+            ValueError: If the tag name can be converted
+                to a UUID.
+        """
+        if is_valid_uuid(value):
+            raise ValueError(
+                "Tag names cannot be UUIDs or strings that "
+                "can be converted to UUIDs."
+            )
+        return value
+
 
 # ------------------ Update Model ------------------
 
@@ -60,6 +90,27 @@ class TagUpdate(BaseUpdate):
     exclusive: Optional[bool] = None
     color: Optional[ColorVariants] = None
 
+    @field_validator("name")
+    @classmethod
+    def validate_name_not_uuid(cls, value: Optional[str]) -> Optional[str]:
+        """Validates that the tag name is not a UUID.
+
+        Args:
+            value: The tag name to validate.
+
+        Returns:
+            The validated tag name.
+
+        Raises:
+            ValueError: If the tag name can be converted to a UUID.
+        """
+        if value is not None and is_valid_uuid(value):
+            raise ValueError(
+                "Tag names cannot be UUIDs or strings that "
+                "can be converted to UUIDs."
+            )
+        return value
+
 
 # ------------------ Response Model ------------------
 
@@ -143,6 +194,11 @@ class TagResponse(
 class TagFilter(UserScopedFilter):
     """Model to enable advanced filtering of all tags."""
 
+    FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
+        *UserScopedFilter.FILTER_EXCLUDE_FIELDS,
+        "resource_type",
+    ]
+
     name: Optional[str] = Field(
         description="The unique title of the tag.", default=None
     )
@@ -153,3 +209,40 @@ class TagFilter(UserScopedFilter):
         description="The flag signifying whether the tag is an exclusive tag.",
         default=None,
     )
+    resource_type: Optional[TaggableResourceTypes] = Field(
+        description="Filter tags associated with a specific resource type.",
+        default=None,
+    )
+
+    def get_custom_filters(
+        self, table: Type["AnySchema"]
+    ) -> List["ColumnElement[bool]"]:
+        """Get custom filters.
+
+        Args:
+            table: The query table.
+
+        Returns:
+            A list of custom filters.
+        """
+        custom_filters = super().get_custom_filters(table)
+
+        from sqlmodel import exists, select
+
+        from zenml.zen_stores.schemas import (
+            TagResourceSchema,
+            TagSchema,
+        )
+
+        if self.resource_type:
+            # Filter for tags that have at least one association with the specified resource type
+            resource_type_filter = exists(
+                select(TagResourceSchema).where(
+                    TagResourceSchema.tag_id == TagSchema.id,
+                    TagResourceSchema.resource_type
+                    == self.resource_type.value,
+                )
+            )
+            custom_filters.append(resource_type_filter)
+
+        return custom_filters

zenml/models/v2/core/trigger.py

@@ -33,12 +33,12 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.page import Page
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.models.v2.core.trigger_execution import TriggerExecutionResponse
 
@@ -57,7 +57,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class TriggerRequest(WorkspaceScopedRequest):
+class TriggerRequest(ProjectScopedRequest):
     """Model for creating a new trigger."""
 
     name: str = Field(
@@ -145,7 +145,7 @@ class TriggerUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class TriggerResponseBody(WorkspaceScopedResponseBody):
+class TriggerResponseBody(ProjectScopedResponseBody):
     """Response body for triggers."""
 
     action_flavor: str = Field(
@@ -172,7 +172,7 @@ class TriggerResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class TriggerResponseMetadata(WorkspaceScopedResponseMetadata):
+class TriggerResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for triggers."""
 
     description: str = Field(
@@ -192,7 +192,7 @@ class TriggerResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class TriggerResponseResources(WorkspaceScopedResponseResources):
+class TriggerResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the trigger entity."""
 
     action: "ActionResponse" = Field(
@@ -209,7 +209,7 @@ class TriggerResponseResources(WorkspaceScopedResponseResources):
 
 
 class TriggerResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         TriggerResponseBody, TriggerResponseMetadata, TriggerResponseResources
     ]
 ):
@@ -324,11 +324,11 @@ class TriggerResponse(
 # ------------------ Filter Model ------------------
 
 
-class TriggerFilter(WorkspaceScopedFilter):
+class TriggerFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all triggers."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         "action_flavor",
         "action_subtype",
         "event_source_flavor",

zenml/models/v2/core/trigger_execution.py

@@ -27,7 +27,7 @@ from zenml.models.v2.base.base import (
     BaseDatedResponseBody,
     BaseResponseResources,
 )
-from zenml.models.v2.base.scoped import WorkspaceScopedFilter
+from zenml.models.v2.base.scoped import ProjectScopedFilter
 
 if TYPE_CHECKING:
     from zenml.models.v2.core.trigger import TriggerResponse
@@ -109,7 +109,7 @@ class TriggerExecutionResponse(
 # ------------------ Filter Model ------------------
 
 
-class TriggerExecutionFilter(WorkspaceScopedFilter):
+class TriggerExecutionFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all trigger executions."""
 
     trigger_id: Optional[Union[UUID, str]] = Field(

zenml/models/v2/core/user.py

@@ -81,10 +81,6 @@ 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":
@@ -283,10 +279,6 @@ 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):
@@ -403,15 +395,6 @@ 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/server_models.py

@@ -131,16 +131,16 @@ class ServerModel(BaseModel):
         "connected. Only set if the server is a ZenML Pro server.",
     )
 
-    pro_tenant_id: Optional[UUID] = Field(
+    pro_workspace_id: Optional[UUID] = Field(
         None,
-        title="The ID of the ZenML Pro tenant to which the server is connected. "
-        "Only set if the server is a ZenML Pro server.",
+        title="The ID of the ZenML Pro workspace to which the server is "
+        "connected. Only set if the server is a ZenML Pro server.",
     )
 
-    pro_tenant_name: Optional[str] = Field(
+    pro_workspace_name: Optional[str] = Field(
         None,
-        title="The name of the ZenML Pro tenant to which the server is connected. "
-        "Only set if the server is a ZenML Pro server.",
+        title="The name of the ZenML Pro workspace to which the server is "
+        "connected. Only set if the server is a ZenML Pro server.",
     )
 
     def is_local(self) -> bool:

zenml/models/v2/misc/statistics.py

@@ -20,8 +20,8 @@ from zenml.models.v2.base.base import (
 )
 
 
-class WorkspaceStatistics(BaseZenModel):
-    """Workspace statistics."""
+class ProjectStatistics(BaseZenModel):
+    """Project statistics."""
 
     pipelines: int = Field(
         title="The number of pipelines.",
@@ -40,6 +40,6 @@ class ServerStatistics(BaseZenModel):
     components: int = Field(
         title="The number of components.",
     )
-    workspaces: int = Field(
-        title="The number of workspaces.",
+    projects: int = Field(
+        title="The number of projects.",
     )

zenml/orchestrators/cache_utils.py

@@ -34,7 +34,7 @@ def generate_cache_key(
     step: "Step",
     input_artifact_ids: Dict[str, "UUID"],
     artifact_store: "BaseArtifactStore",
-    workspace_id: "UUID",
+    project_id: "UUID",
 ) -> str:
     """Generates a cache key for a step run.
 
@@ -42,7 +42,7 @@ def generate_cache_key(
     runs are identical and can be cached.
 
     The cache key is a MD5 hash of:
-    - the workspace ID,
+    - the project ID,
     - the artifact store ID and path,
     - the source code that defines the step,
     - the parameters of the step,
@@ -55,15 +55,15 @@ def generate_cache_key(
         step: The step to generate the cache key for.
         input_artifact_ids: The input artifact IDs for the step.
         artifact_store: The artifact store of the active stack.
-        workspace_id: The ID of the active workspace.
+        project_id: The ID of the active project.
 
     Returns:
         A cache key.
     """
     hash_ = hashlib.md5()  # nosec
 
-    # Workspace ID
-    hash_.update(workspace_id.bytes)
+    # Project ID
+    hash_.update(project_id.bytes)
 
     # Artifact store ID and path
     hash_.update(artifact_store.id.bytes)
@@ -106,7 +106,7 @@ def get_cached_step_run(cache_key: str) -> Optional["StepRunResponse"]:
     """If a given step can be cached, get the corresponding existing step run.
 
     A step run can be cached if there is an existing step run in the same
-    workspace which has the same cache key and was successfully executed.
+    project which has the same cache key and was successfully executed.
 
     Args:
         cache_key: The cache key of the step.
@@ -117,7 +117,7 @@ def get_cached_step_run(cache_key: str) -> Optional["StepRunResponse"]:
     client = Client()
 
     cache_candidates = client.list_run_steps(
-        workspace=client.active_workspace.id,
+        project=client.active_project.id,
         cache_key=cache_key,
         status=ExecutionStatus.COMPLETED,
         sort_by=f"{SorterOps.DESCENDING}:created",

zenml/orchestrators/input_utils.py

@@ -55,7 +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,
+            project=pipeline_run.project.id,
         )
     }
 

zenml/orchestrators/step_launcher.py

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

zenml/orchestrators/step_run_utils.py

@@ -75,7 +75,7 @@ class StepRunRequestFactory:
             pipeline_run_id=self.pipeline_run.id,
             status=ExecutionStatus.RUNNING,
             start_time=utc_now(),
-            workspace=Client().active_workspace.id,
+            project=Client().active_project.id,
         )
 
     def populate_request(self, request: StepRunRequest) -> None:
@@ -102,7 +102,7 @@ class StepRunRequestFactory:
             step=step,
             input_artifact_ids=input_artifact_ids,
             artifact_store=self.stack.artifact_store,
-            workspace_id=Client().active_workspace.id,
+            project_id=Client().active_project.id,
         )
         request.cache_key = cache_key
 
@@ -344,7 +344,7 @@ def log_model_version_dashboard_url(
 ) -> None:
     """Log the dashboard URL for a model version.
 
-    If the current server is not a ZenML Pro tenant, a fallback message is
+    If the current server is not a ZenML Pro workspace, a fallback message is
     logged instead.
 
     Args:

zenml/orchestrators/utils.py

@@ -23,8 +23,8 @@ from zenml.config.global_config import (
     GlobalConfiguration,
 )
 from zenml.constants import (
+    ENV_ZENML_ACTIVE_PROJECT_ID,
     ENV_ZENML_ACTIVE_STACK_ID,
-    ENV_ZENML_ACTIVE_WORKSPACE_ID,
     ENV_ZENML_DISABLE_CREDENTIALS_DISK_CACHING,
     ENV_ZENML_PIPELINE_RUN_API_TOKEN_EXPIRATION,
     ENV_ZENML_SERVER,
@@ -211,13 +211,13 @@ def get_config_environment_vars(
     # in the pipeline run environment
     environment_vars[ENV_ZENML_DISABLE_CREDENTIALS_DISK_CACHING] = "true"
 
-    # Make sure to use the correct active stack/workspace which might come
+    # Make sure to use the correct active stack/project which might come
     # from a .zen repository and not the global config
     environment_vars[ENV_ZENML_ACTIVE_STACK_ID] = str(
         Client().active_stack_model.id
     )
-    environment_vars[ENV_ZENML_ACTIVE_WORKSPACE_ID] = str(
-        Client().active_workspace.id
+    environment_vars[ENV_ZENML_ACTIVE_PROJECT_ID] = str(
+        Client().active_project.id
     )
 
     return environment_vars

zenml/pipelines/build_utils.py

@@ -215,7 +215,7 @@ def reuse_or_create_pipeline_build(
         build_model = Client().zen_store.get_build(build_id=build)
     else:
         build_request = PipelineBuildRequest(
-            workspace=Client().active_workspace.id,
+            project=Client().active_project.id,
             stack=Client().active_stack_model.id,
             pipeline=pipeline_id,
             **build.model_dump(),
@@ -418,7 +418,7 @@ def create_pipeline_build(
     )
     stack_checksum = compute_stack_checksum(stack=stack_model)
     build_request = PipelineBuildRequest(
-        workspace=client.active_workspace.id,
+        project=client.active_project.id,
         stack=stack_model.id,
         pipeline=pipeline_id,
         is_local=is_local,

zenml/pipelines/pipeline_definition.py

@@ -684,7 +684,7 @@ To avoid this consider setting pipeline parameters only in one place (config or
             components = Client().active_stack_model.components
             orchestrator = components[StackComponentType.ORCHESTRATOR][0]
             schedule_model = ScheduleRequest(
-                workspace=Client().active_workspace.id,
+                project=Client().active_project.id,
                 pipeline_id=pipeline_id,
                 orchestrator_id=orchestrator.id,
                 name=schedule_name,
@@ -770,7 +770,7 @@ 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(
-            workspace=Client().active_workspace.id,
+            project=Client().active_project.id,
             stack=stack.id,
             pipeline=pipeline_id,
             build=build_id,
@@ -1013,7 +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,
+            "project_id": deployment.project.id,
             "store_type": Client().zen_store.type.value,
             **stack_metadata,
             "total_steps": len(self.invocations),
@@ -1094,7 +1094,7 @@ To avoid this consider setting pipeline parameters only in one place (config or
             return _get()
         except RuntimeError:
             request = PipelineRequest(
-                workspace=client.active_workspace.id,
+                project=client.active_project.id,
                 name=self.name,
             )
 
@@ -1233,7 +1233,7 @@ To avoid this consider setting pipeline parameters only in one place (config or
             return id_
 
         if not allow_suffix:
-            raise RuntimeError("Duplicate step ID")
+            raise RuntimeError(f"Duplicate step ID `{id_}`")
 
         for index in range(2, 10000):
             id_ = f"{base_id}_{index}"

zenml/pipelines/run_utils.py

@@ -81,7 +81,7 @@ def create_placeholder_run(
         # running.
         start_time=start_time,
         orchestrator_run_id=None,
-        workspace=deployment.workspace.id,
+        project=deployment.project.id,
         deployment=deployment.id,
         pipeline=deployment.pipeline.id if deployment.pipeline else None,
         status=ExecutionStatus.INITIALIZING,

zenml/service_connectors/service_connector.py

@@ -705,7 +705,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
 
     def to_model(
         self,
-        workspace: UUID,
         name: Optional[str] = None,
         description: str = "",
         labels: Optional[Dict[str, str]] = None,
@@ -714,7 +713,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
 
         Args:
             name: The name of 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.
 
@@ -737,7 +735,6 @@ class ServiceConnector(BaseModel, metaclass=ServiceConnectorMeta):
             connector_type=spec.connector_type,
             name=name,
             description=description,
-            workspace=workspace,
             auth_method=self.auth_method,
             expires_at=self.expires_at,
             expires_skew_tolerance=self.expires_skew_tolerance,

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(
-                workspace=client.active_workspace.id,
                 name="fake",
                 connector_type=connector_details.type,
                 auth_method=connector_details.auth_method,

zenml/stack/stack.py

@@ -756,7 +756,6 @@ class Stack:
                 type=flavor.type,
                 config=LocalImageBuilderConfig(),
                 user=Client().active_user.id,
-                workspace=Client().active_workspace.id,
                 created=now,
                 updated=now,
             )

zenml/steps/base_step.py

@@ -432,7 +432,9 @@ class BaseStep:
         self,
         *args: Any,
         id: Optional[str] = None,
-        after: Union[str, Sequence[str], None] = None,
+        after: Union[
+            str, StepArtifact, Sequence[Union[str, StepArtifact]], None
+        ] = None,
         **kwargs: Any,
     ) -> Any:
         """Handle a call of the step.
@@ -497,8 +499,14 @@ class BaseStep:
         }
         if isinstance(after, str):
             upstream_steps.add(after)
+        elif isinstance(after, StepArtifact):
+            upstream_steps.add(after.invocation_id)
         elif isinstance(after, Sequence):
-            upstream_steps = upstream_steps.union(after)
+            for item in after:
+                if isinstance(item, str):
+                    upstream_steps.add(item)
+                elif isinstance(item, StepArtifact):
+                    upstream_steps.add(item.invocation_id)
 
         invocation_id = Pipeline.ACTIVE_PIPELINE.add_step_invocation(
             step=self,

zenml/utils/dashboard_utils.py

@@ -33,7 +33,7 @@ logger = get_logger(__name__)
 
 
 def get_cloud_dashboard_url() -> Optional[str]:
-    """Get the base url of the cloud dashboard if the server is a cloud tenant.
+    """Get the base url of the cloud dashboard if the server is a ZenML Pro workspace.
 
     Returns:
         The base url of the cloud dashboard.

zenml/utils/tag_utils.py

@@ -379,18 +379,6 @@ def add_tags(
             else:
                 tag_model = client.create_tag(name=tag)
 
-        if tag_model.exclusive and resource_type not in [
-            TaggableResourceTypes.PIPELINE_RUN,
-            TaggableResourceTypes.ARTIFACT_VERSION,
-            TaggableResourceTypes.RUN_TEMPLATE,
-        ]:
-            logger.warning(
-                "The tag will be added, however, please keep in mind that "
-                "the functionality of having exclusive tags is only "
-                "applicable for pipeline runs, artifact versions and run "
-                f"templates, not {resource_type.value}s."
-            )
-
         if resource_id:
             client.attach_tag(
                 tag_name_or_id=tag_model.name,

zenml/zen_server/cloud_utils.py

@@ -267,6 +267,6 @@ def cloud_connection() -> ZenMLCloudConnection:
     return _cloud_connection
 
 
-def send_pro_tenant_status_update() -> None:
-    """Send a tenant status update to the Cloud API."""
-    cloud_connection().patch("/tenant_status")
+def send_pro_workspace_status_update() -> None:
+    """Send a workspace status update to the Cloud API."""
+    cloud_connection().patch("/workspace_status")

zenml/zen_server/feature_gate/endpoint_utils.py

@@ -20,7 +20,7 @@ from zenml.zen_server.utils import feature_gate, server_config
 
 
 def check_entitlement(resource_type: ResourceType) -> None:
-    """Queries the feature gate to see if the operation falls within the tenants entitlements.
+    """Queries the feature gate to see if the operation falls within the Pro workspaces entitlements.
 
     Raises an exception if the user is not entitled to create an instance of the
     resource. Otherwise, simply returns.

zenml/zen_server/feature_gate/zenml_cloud_feature_gate.py

@@ -110,7 +110,7 @@ class ZenMLCloudFeatureGateInterface(FeatureGateInterface):
             feature=resource,
             total=1 if not is_decrement else -1,
             metadata={
-                "tenant_id": str(server_config.get_external_server_id()),
+                "workspace_id": str(server_config.get_external_server_id()),
                 "resource_id": str(resource_id),
             },
         ).model_dump()