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

zenml/models/v2/base/scoped.py

@@ -42,8 +42,8 @@ from zenml.models.v2.base.filter import AnyQuery, BaseFilter
 if TYPE_CHECKING:
     from sqlalchemy.sql.elements import ColumnElement
 
+    from zenml.models.v2.core.project import ProjectResponse
     from zenml.models.v2.core.user import UserResponse
-    from zenml.models.v2.core.workspace import WorkspaceResponse
     from zenml.zen_stores.schemas import BaseSchema
 
     AnySchema = TypeVar("AnySchema", bound=BaseSchema)
@@ -80,24 +80,22 @@ class UserScopedRequest(BaseRequest):
         return metadata
 
 
-class WorkspaceScopedRequest(UserScopedRequest):
-    """Base workspace-scoped request domain model.
+class ProjectScopedRequest(UserScopedRequest):
+    """Base project-scoped request domain model.
 
-    Used as a base class for all domain models that are workspace-scoped.
+    Used as a base class for all domain models that are project-scoped.
     """
 
-    workspace: UUID = Field(
-        title="The workspace to which this resource belongs."
-    )
+    project: UUID = Field(title="The project to which this resource belongs.")
 
     def get_analytics_metadata(self) -> Dict[str, Any]:
-        """Fetches the analytics metadata for workspace scoped models.
+        """Fetches the analytics metadata for project scoped models.
 
         Returns:
             The analytics metadata.
         """
         metadata = super().get_analytics_metadata()
-        metadata["workspace_id"] = self.workspace
+        metadata["project_id"] = self.project
         return metadata
 
 
@@ -285,79 +283,77 @@ class UserScopedFilter(BaseFilter):
         return query
 
 
-# Workspace-scoped models
+# Project-scoped models
 
 
-class WorkspaceScopedResponseBody(UserScopedResponseBody):
-    """Base workspace-scoped body."""
+class ProjectScopedResponseBody(UserScopedResponseBody):
+    """Base project-scoped body."""
 
 
-class WorkspaceScopedResponseMetadata(UserScopedResponseMetadata):
-    """Base workspace-scoped metadata."""
+class ProjectScopedResponseMetadata(UserScopedResponseMetadata):
+    """Base project-scoped metadata."""
 
-    workspace: "WorkspaceResponse" = Field(
-        title="The workspace of this resource."
-    )
+    project: "ProjectResponse" = Field(title="The project of this resource.")
 
 
-class WorkspaceScopedResponseResources(UserScopedResponseResources):
-    """Base workspace-scoped resources."""
+class ProjectScopedResponseResources(UserScopedResponseResources):
+    """Base project-scoped resources."""
 
 
-WorkspaceBody = TypeVar("WorkspaceBody", bound=WorkspaceScopedResponseBody)
-WorkspaceMetadata = TypeVar(
-    "WorkspaceMetadata", bound=WorkspaceScopedResponseMetadata
+ProjectBody = TypeVar("ProjectBody", bound=ProjectScopedResponseBody)
+ProjectMetadata = TypeVar(
+    "ProjectMetadata", bound=ProjectScopedResponseMetadata
 )
-WorkspaceResources = TypeVar(
-    "WorkspaceResources", bound=WorkspaceScopedResponseResources
+ProjectResources = TypeVar(
+    "ProjectResources", bound=ProjectScopedResponseResources
 )
 
 
-class WorkspaceScopedResponse(
-    UserScopedResponse[WorkspaceBody, WorkspaceMetadata, WorkspaceResources],
-    Generic[WorkspaceBody, WorkspaceMetadata, WorkspaceResources],
+class ProjectScopedResponse(
+    UserScopedResponse[ProjectBody, ProjectMetadata, ProjectResources],
+    Generic[ProjectBody, ProjectMetadata, ProjectResources],
 ):
-    """Base workspace-scoped domain model.
+    """Base project-scoped domain model.
 
-    Used as a base class for all domain models that are workspace-scoped.
+    Used as a base class for all domain models that are project-scoped.
     """
 
     # Analytics
     def get_analytics_metadata(self) -> Dict[str, Any]:
-        """Fetches the analytics metadata for workspace scoped models.
+        """Fetches the analytics metadata for project scoped models.
 
         Returns:
             The analytics metadata.
         """
         metadata = super().get_analytics_metadata()
-        if self.workspace is not None:
-            metadata["workspace_id"] = self.workspace.id
+        if self.project is not None:
+            metadata["project_id"] = self.project.id
         return metadata
 
     # Body and metadata properties
     @property
-    def workspace(self) -> "WorkspaceResponse":
-        """The workspace property.
+    def project(self) -> "ProjectResponse":
+        """The project property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().workspace
+        return self.get_metadata().project
 
 
 # ---------------------- Filter Models ----------------------
 
 
-class WorkspaceScopedFilter(UserScopedFilter):
-    """Model to enable advanced scoping with workspace."""
+class ProjectScopedFilter(UserScopedFilter):
+    """Model to enable advanced scoping with project."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *UserScopedFilter.FILTER_EXCLUDE_FIELDS,
-        "workspace",
+        "project",
     ]
-    workspace: Optional[Union[UUID, str]] = Field(
+    project: Optional[Union[UUID, str]] = Field(
         default=None,
-        description="Name/ID of the workspace which the search is scoped to. "
+        description="Name/ID of the project which the search is scoped to. "
         "This field must always be set and is always applied in addition to "
         "the other filters, regardless of the value of the "
         "logical_operator field.",
@@ -379,30 +375,30 @@ class WorkspaceScopedFilter(UserScopedFilter):
             The query with filter applied.
 
         Raises:
-            ValueError: If the workspace scope is missing from the filter.
+            ValueError: If the project scope is missing from the filter.
         """
         query = super().apply_filter(query=query, table=table)
 
-        # The workspace scope must always be set and must be a UUID. If the
+        # The project scope must always be set and must be a UUID. If the
         # client sets this to a string, the server will try to resolve it to a
-        # workspace ID.
+        # project ID.
         #
         # If not set by the client, the server will fall back to using the
-        # user's default workspace or even the server's default workspace, if
-        # they are configured. If this also fails to yield a workspace, this
+        # user's default project or even the server's default project, if
+        # they are configured. If this also fails to yield a project, this
         # method will raise a ValueError.
         #
-        # See: SqlZenStore._set_filter_workspace_id
+        # See: SqlZenStore._set_filter_project_id
 
-        if not self.workspace:
-            raise ValueError("Workspace scope missing from the filter.")
+        if not self.project:
+            raise ValueError("Project scope missing from the filter.")
 
-        if not isinstance(self.workspace, UUID):
+        if not isinstance(self.project, UUID):
             raise ValueError(
-                f"Workspace scope must be a UUID, got {type(self.workspace)}."
+                f"Project scope must be a UUID, got {type(self.project)}."
             )
 
-        scope_filter = getattr(table, "workspace_id") == self.workspace
+        scope_filter = getattr(table, "project_id") == self.project
         query = query.where(scope_filter)
 
         return query
@@ -470,7 +466,7 @@ class TaggableFilter(BaseFilter):
 
         query = super().apply_filter(query=query, table=table)
 
-        if self.tags is not None:
+        if self.tags:
             query = query.join(
                 TagResourceSchema,
                 TagResourceSchema.resource_id == getattr(table, "id"),
@@ -491,7 +487,7 @@ class TaggableFilter(BaseFilter):
         """
         custom_filters = super().get_custom_filters(table)
 
-        if self.tags is not None:
+        if self.tags:
             from sqlmodel import exists, select
 
             from zenml.zen_stores.schemas import TagResourceSchema, TagSchema

zenml/models/v2/core/action.py

@@ -29,12 +29,12 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import PluginSubType
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.models.v2.core.user import UserResponse
 
@@ -47,7 +47,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class ActionRequest(WorkspaceScopedRequest):
+class ActionRequest(ProjectScopedRequest):
     """Model for creating a new action."""
 
     name: str = Field(
@@ -131,7 +131,7 @@ class ActionUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ActionResponseBody(WorkspaceScopedResponseBody):
+class ActionResponseBody(ProjectScopedResponseBody):
     """Response body for actions."""
 
     flavor: str = Field(
@@ -144,7 +144,7 @@ class ActionResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class ActionResponseMetadata(WorkspaceScopedResponseMetadata):
+class ActionResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for actions."""
 
     description: str = Field(
@@ -161,7 +161,7 @@ class ActionResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ActionResponseResources(WorkspaceScopedResponseResources):
+class ActionResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the action entity."""
 
     service_account: UserResponse = Field(
@@ -170,7 +170,7 @@ class ActionResponseResources(WorkspaceScopedResponseResources):
 
 
 class ActionResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ActionResponseBody, ActionResponseMetadata, ActionResponseResources
     ]
 ):
@@ -259,7 +259,7 @@ class ActionResponse(
 # ------------------ Filter Model ------------------
 
 
-class ActionFilter(WorkspaceScopedFilter):
+class ActionFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all actions."""
 
     name: Optional[str] = Field(

zenml/models/v2/core/artifact.py

@@ -30,13 +30,13 @@ from pydantic import Field
 from zenml.constants import SORT_BY_LATEST_VERSION_KEY, STR_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
     TaggableFilter,
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
 )
 from zenml.models.v2.core.tag import TagResponse
 
@@ -51,7 +51,7 @@ AnyQuery = TypeVar("AnyQuery", bound=Any)
 # ------------------ Request Model ------------------
 
 
-class ArtifactRequest(WorkspaceScopedRequest):
+class ArtifactRequest(ProjectScopedRequest):
     """Artifact request model."""
 
     name: str = Field(
@@ -84,7 +84,7 @@ class ArtifactUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ArtifactResponseBody(WorkspaceScopedResponseBody):
+class ArtifactResponseBody(ProjectScopedResponseBody):
     """Response body for artifacts."""
 
     tags: List[TagResponse] = Field(
@@ -94,7 +94,7 @@ class ArtifactResponseBody(WorkspaceScopedResponseBody):
     latest_version_id: Optional[UUID] = None
 
 
-class ArtifactResponseMetadata(WorkspaceScopedResponseMetadata):
+class ArtifactResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for artifacts."""
 
     has_custom_name: bool = Field(
@@ -103,12 +103,12 @@ class ArtifactResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ArtifactResponseResources(WorkspaceScopedResponseResources):
+class ArtifactResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the Artifact Entity."""
 
 
 class ArtifactResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ArtifactResponseBody,
         ArtifactResponseMetadata,
         ArtifactResponseResources,
@@ -185,22 +185,22 @@ class ArtifactResponse(
 # ------------------ Filter Model ------------------
 
 
-class ArtifactFilter(WorkspaceScopedFilter, TaggableFilter):
+class ArtifactFilter(ProjectScopedFilter, TaggableFilter):
     """Model to enable advanced filtering of artifacts."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
     ]
 
     CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
         SORT_BY_LATEST_VERSION_KEY,
     ]
 
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
     ]
 

zenml/models/v2/core/artifact_version.py

@@ -41,13 +41,13 @@ from zenml.metadata.metadata_types import MetadataType
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.filter import FilterGenerator
 from zenml.models.v2.base.scoped import (
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
     TaggableFilter,
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
 )
 from zenml.models.v2.core.artifact import ArtifactResponse
 from zenml.models.v2.core.tag import TagResponse
@@ -71,7 +71,7 @@ logger = get_logger(__name__)
 # ------------------ Request Model ------------------
 
 
-class ArtifactVersionRequest(WorkspaceScopedRequest):
+class ArtifactVersionRequest(ProjectScopedRequest):
     """Request model for artifact versions."""
 
     artifact_id: Optional[UUID] = Field(
@@ -176,7 +176,7 @@ class ArtifactVersionUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ArtifactVersionResponseBody(WorkspaceScopedResponseBody):
+class ArtifactVersionResponseBody(ProjectScopedResponseBody):
     """Response body for artifact versions."""
 
     artifact: ArtifactResponse = Field(
@@ -230,7 +230,7 @@ class ArtifactVersionResponseBody(WorkspaceScopedResponseBody):
         return value
 
 
-class ArtifactVersionResponseMetadata(WorkspaceScopedResponseMetadata):
+class ArtifactVersionResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for artifact versions."""
 
     producer_step_run_id: Optional[UUID] = Field(
@@ -245,12 +245,12 @@ class ArtifactVersionResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ArtifactVersionResponseResources(WorkspaceScopedResponseResources):
+class ArtifactVersionResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the artifact version entity."""
 
 
 class ArtifactVersionResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ArtifactVersionResponseBody,
         ArtifactVersionResponseMetadata,
         ArtifactVersionResponseResources,
@@ -470,11 +470,11 @@ class ArtifactVersionResponse(
 # ------------------ Filter Model ------------------
 
 
-class ArtifactVersionFilter(WorkspaceScopedFilter, TaggableFilter):
+class ArtifactVersionFilter(ProjectScopedFilter, TaggableFilter):
     """Model to enable advanced filtering of artifact versions."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
         "artifact_id",
         "artifact",
@@ -486,11 +486,11 @@ class ArtifactVersionFilter(WorkspaceScopedFilter, TaggableFilter):
         "run_metadata",
     ]
     CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
     ]
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
         "artifact_id",
     ]

zenml/models/v2/core/code_repository.py

@@ -21,18 +21,18 @@ from zenml.config.source import Source, SourceWithValidator
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 
 # ------------------ Request Model ------------------
 
 
-class CodeRepositoryRequest(WorkspaceScopedRequest):
+class CodeRepositoryRequest(ProjectScopedRequest):
     """Request model for code repositories."""
 
     name: str = Field(
@@ -88,7 +88,7 @@ class CodeRepositoryUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class CodeRepositoryResponseBody(WorkspaceScopedResponseBody):
+class CodeRepositoryResponseBody(ProjectScopedResponseBody):
     """Response body for code repositories."""
 
     source: Source = Field(description="The code repository source.")
@@ -99,7 +99,7 @@ class CodeRepositoryResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class CodeRepositoryResponseMetadata(WorkspaceScopedResponseMetadata):
+class CodeRepositoryResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for code repositories."""
 
     config: Dict[str, Any] = Field(
@@ -112,12 +112,12 @@ class CodeRepositoryResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class CodeRepositoryResponseResources(WorkspaceScopedResponseResources):
+class CodeRepositoryResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the code repository entity."""
 
 
 class CodeRepositoryResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         CodeRepositoryResponseBody,
         CodeRepositoryResponseMetadata,
         CodeRepositoryResponseResources,
@@ -181,7 +181,7 @@ class CodeRepositoryResponse(
 # ------------------ Filter Model ------------------
 
 
-class CodeRepositoryFilter(WorkspaceScopedFilter):
+class CodeRepositoryFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all code repositories."""
 
     name: Optional[str] = Field(

zenml/models/v2/core/event_source.py

@@ -23,19 +23,19 @@ from zenml.enums import PluginSubType
 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 import TriggerResponse
 
 # ------------------ Request Model ------------------
 
 
-class EventSourceRequest(WorkspaceScopedRequest):
+class EventSourceRequest(ProjectScopedRequest):
     """BaseModel for all event sources."""
 
     name: str = Field(
@@ -108,7 +108,7 @@ class EventSourceUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class EventSourceResponseBody(WorkspaceScopedResponseBody):
+class EventSourceResponseBody(ProjectScopedResponseBody):
     """ResponseBody for event sources."""
 
     flavor: str = Field(
@@ -123,7 +123,7 @@ class EventSourceResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class EventSourceResponseMetadata(WorkspaceScopedResponseMetadata):
+class EventSourceResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for event sources."""
 
     description: str = Field(
@@ -136,7 +136,7 @@ class EventSourceResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class EventSourceResponseResources(WorkspaceScopedResponseResources):
+class EventSourceResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the code repository entity."""
 
     triggers: Page[TriggerResponse] = Field(
@@ -145,7 +145,7 @@ class EventSourceResponseResources(WorkspaceScopedResponseResources):
 
 
 class EventSourceResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         EventSourceResponseBody,
         EventSourceResponseMetadata,
         EventSourceResponseResources,
@@ -226,7 +226,7 @@ class EventSourceResponse(
 # ------------------ Filter Model ------------------
 
 
-class EventSourceFilter(WorkspaceScopedFilter):
+class EventSourceFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all EventSourceModels."""
 
     name: Optional[str] = Field(