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

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/api_key.py

@@ -97,7 +97,7 @@ class APIKeyRequest(BaseRequest):
     )
 
 
-class APIKeyRotateRequest(BaseModel):
+class APIKeyRotateRequest(BaseRequest):
     """Request model for API key rotation."""
 
     retain_period_minutes: int = Field(

zenml/models/v2/core/artifact.py

@@ -25,17 +25,19 @@ from typing import (
 )
 from uuid import UUID
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 
 from zenml.constants import SORT_BY_LATEST_VERSION_KEY, STR_FIELD_MAX_LENGTH
-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 (
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
+    TaggableFilter,
 )
-from zenml.models.v2.base.scoped import TaggableFilter
 from zenml.models.v2.core.tag import TagResponse
 
 if TYPE_CHECKING:
@@ -49,7 +51,7 @@ AnyQuery = TypeVar("AnyQuery", bound=Any)
 # ------------------ Request Model ------------------
 
 
-class ArtifactRequest(BaseRequest):
+class ArtifactRequest(ProjectScopedRequest):
     """Artifact request model."""
 
     name: str = Field(
@@ -70,7 +72,7 @@ class ArtifactRequest(BaseRequest):
 # ------------------ Update Model ------------------
 
 
-class ArtifactUpdate(BaseModel):
+class ArtifactUpdate(BaseUpdate):
     """Artifact update model."""
 
     name: Optional[str] = None
@@ -82,7 +84,7 @@ class ArtifactUpdate(BaseModel):
 # ------------------ Response Model ------------------
 
 
-class ArtifactResponseBody(BaseDatedResponseBody):
+class ArtifactResponseBody(ProjectScopedResponseBody):
     """Response body for artifacts."""
 
     tags: List[TagResponse] = Field(
@@ -92,7 +94,7 @@ class ArtifactResponseBody(BaseDatedResponseBody):
     latest_version_id: Optional[UUID] = None
 
 
-class ArtifactResponseMetadata(BaseResponseMetadata):
+class ArtifactResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for artifacts."""
 
     has_custom_name: bool = Field(
@@ -101,12 +103,12 @@ class ArtifactResponseMetadata(BaseResponseMetadata):
     )
 
 
-class ArtifactResponseResources(BaseResponseResources):
+class ArtifactResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the Artifact Entity."""
 
 
 class ArtifactResponse(
-    BaseIdentifiedResponse[
+    ProjectScopedResponse[
         ArtifactResponseBody,
         ArtifactResponseMetadata,
         ArtifactResponseResources,
@@ -176,24 +178,35 @@ class ArtifactResponse(
         """
         from zenml.client import Client
 
-        responses = Client().list_artifact_versions(name=self.name)
+        responses = Client().list_artifact_versions(artifact=self.name)
         return {str(response.version): response for response in responses}
 
 
 # ------------------ Filter Model ------------------
 
 
-class ArtifactFilter(TaggableFilter):
+class ArtifactFilter(ProjectScopedFilter, TaggableFilter):
     """Model to enable advanced filtering of artifacts."""
 
-    name: Optional[str] = None
-    has_custom_name: Optional[bool] = None
+    FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *TaggableFilter.FILTER_EXCLUDE_FIELDS,
+    ]
 
     CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
         SORT_BY_LATEST_VERSION_KEY,
     ]
 
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
+        *TaggableFilter.CLI_EXCLUDE_FIELDS,
+    ]
+
+    name: Optional[str] = None
+    has_custom_name: Optional[bool] = None
+
     def apply_sorting(
         self,
         query: AnyQuery,

zenml/models/v2/core/artifact_version.py

@@ -27,7 +27,6 @@ from typing import (
 from uuid import UUID
 
 from pydantic import (
-    BaseModel,
     ConfigDict,
     Field,
     field_validator,
@@ -36,18 +35,19 @@ from pydantic import (
 
 from zenml.config.source import Source, SourceWithValidator
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
-from zenml.enums import ArtifactSaveType, ArtifactType, GenericFilterOps
+from zenml.enums import ArtifactSaveType, ArtifactType
 from zenml.logger import get_logger
 from zenml.metadata.metadata_types import MetadataType
-from zenml.models.v2.base.filter import FilterGenerator, StrFilter
+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(
@@ -165,7 +165,7 @@ class ArtifactVersionRequest(WorkspaceScopedRequest):
 # ------------------ Update Model ------------------
 
 
-class ArtifactVersionUpdate(BaseModel):
+class ArtifactVersionUpdate(BaseUpdate):
     """Artifact version update model."""
 
     name: Optional[str] = None
@@ -176,7 +176,7 @@ class ArtifactVersionUpdate(BaseModel):
 # ------------------ 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,13 +470,14 @@ 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,
-        "name",
+        "artifact_id",
+        "artifact",
         "only_unused",
         "has_custom_name",
         "model",
@@ -484,23 +485,28 @@ class ArtifactVersionFilter(WorkspaceScopedFilter, TaggableFilter):
         "model_version_id",
         "run_metadata",
     ]
-    CUSTOM_SORTING_OPTIONS = [
-        *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
+    CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
     ]
-    CLI_EXCLUDE_FIELDS = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
+        "artifact_id",
     ]
 
-    artifact_id: Optional[Union[UUID, str]] = Field(
+    artifact: Optional[Union[UUID, str]] = Field(
         default=None,
-        description="ID of the artifact to which this version belongs.",
+        description="The name or ID of the artifact 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.",
         union_mode="left_to_right",
     )
-    name: Optional[str] = Field(
+    artifact_id: Optional[Union[UUID, str]] = Field(
         default=None,
-        description="Name of the artifact to which this version belongs.",
+        description="[Deprecated] Use 'artifact' instead. ID of the artifact to which this version belongs.",
+        union_mode="left_to_right",
     )
     version: Optional[str] = Field(
         default=None,
@@ -545,10 +551,6 @@ class ArtifactVersionFilter(WorkspaceScopedFilter, TaggableFilter):
         default=None,
         description="Filter only artifacts with/without custom names.",
     )
-    user: Optional[Union[UUID, str]] = Field(
-        default=None,
-        description="Name/ID of the user that created the artifact version.",
-    )
     model: Optional[Union[UUID, str]] = Field(
         default=None,
         description="Name/ID of the model that is associated with this "
@@ -595,18 +597,15 @@ class ArtifactVersionFilter(WorkspaceScopedFilter, TaggableFilter):
             StepRunSchema,
         )
 
-        if self.name:
-            value, filter_operator = self._resolve_operator(self.name)
-            filter_ = StrFilter(
-                operation=GenericFilterOps(filter_operator),
-                column="name",
-                value=value,
-            )
-            artifact_name_filter = and_(
+        if self.artifact:
+            value, operator = self._resolve_operator(self.artifact)
+            artifact_filter = and_(
                 ArtifactVersionSchema.artifact_id == ArtifactSchema.id,
-                filter_.generate_query_conditions(ArtifactSchema),
+                self.generate_name_or_id_query_conditions(
+                    value=self.artifact, table=ArtifactSchema
+                ),
             )
-            custom_filters.append(artifact_name_filter)
+            custom_filters.append(artifact_filter)
 
         if self.only_unused:
             unused_filter = and_(
@@ -702,6 +701,24 @@ class ArtifactVersionFilter(WorkspaceScopedFilter, TaggableFilter):
 
         return custom_filters
 
+    @model_validator(mode="after")
+    def _migrate_artifact_id(self) -> "ArtifactVersionFilter":
+        """Migrate value from the deprecated artifact_id attribute.
+
+        Returns:
+            The filter with migrated value.
+        """
+        # Handle deprecated artifact_id field
+        if self.artifact_id is not None:
+            logger.warning(
+                "The 'ArtifactVersionFilter.artifact_id' field is deprecated "
+                "and will be removed in a future version. Please use "
+                "'ArtifactVersionFilter.artifact' instead."
+            )
+            self.artifact = self.artifact or self.artifact_id
+
+        return self
+
 
 # -------------------- Lazy Loader --------------------
 

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/component.py

@@ -32,12 +32,12 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import LogicalOperators, StackComponentType
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    UserScopedFilter,
+    UserScopedRequest,
+    UserScopedResponse,
+    UserScopedResponseBody,
+    UserScopedResponseMetadata,
+    UserScopedResponseResources,
 )
 from zenml.utils import secret_utils
 
@@ -88,8 +88,8 @@ class ComponentBase(BaseModel):
 # ------------------ Request Model ------------------
 
 
-class ComponentRequest(ComponentBase, WorkspaceScopedRequest):
-    """Request model for components."""
+class ComponentRequest(ComponentBase, UserScopedRequest):
+    """Request model for stack components."""
 
     ANALYTICS_FIELDS: ClassVar[List[str]] = ["type", "flavor"]
 
@@ -120,13 +120,8 @@ class ComponentRequest(ComponentBase, WorkspaceScopedRequest):
         return name
 
 
-class InternalComponentRequest(ComponentRequest):
-    """Internal component request model."""
-
-    user: Optional[UUID] = Field(  # type: ignore[assignment]
-        title="The id of the user that created this resource.",
-        default=None,
-    )
+class DefaultComponentRequest(ComponentRequest):
+    """Internal component request model used only for default stack components."""
 
 
 # ------------------ Update Model ------------------
@@ -162,8 +157,8 @@ class ComponentUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ComponentResponseBody(WorkspaceScopedResponseBody):
-    """Response body for components."""
+class ComponentResponseBody(UserScopedResponseBody):
+    """Response body for stack components."""
 
     type: StackComponentType = Field(
         title="The type of the stack component.",
@@ -185,8 +180,8 @@ class ComponentResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class ComponentResponseMetadata(WorkspaceScopedResponseMetadata):
-    """Response metadata for components."""
+class ComponentResponseMetadata(UserScopedResponseMetadata):
+    """Response metadata for stack components."""
 
     configuration: Dict[str, Any] = Field(
         title="The stack component configuration.",
@@ -206,8 +201,8 @@ class ComponentResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ComponentResponseResources(WorkspaceScopedResponseResources):
-    """Class for all resource models associated with the component entity."""
+class ComponentResponseResources(UserScopedResponseResources):
+    """Response resources for stack components."""
 
     flavor: "FlavorResponse" = Field(
         title="The flavor of this stack component.",
@@ -215,13 +210,13 @@ class ComponentResponseResources(WorkspaceScopedResponseResources):
 
 
 class ComponentResponse(
-    WorkspaceScopedResponse[
+    UserScopedResponse[
         ComponentResponseBody,
         ComponentResponseMetadata,
         ComponentResponseResources,
     ]
 ):
-    """Response model for components."""
+    """Response model for stack components."""
 
     ANALYTICS_FIELDS: ClassVar[List[str]] = ["type"]
 
@@ -346,22 +341,16 @@ class ComponentResponse(
 # ------------------ Filter Model ------------------
 
 
-class ComponentFilter(WorkspaceScopedFilter):
-    """Model to enable advanced filtering of all ComponentModels.
-
-    The Component Model needs additional scoping. As such the `_scope_user`
-    field can be set to the user that is doing the filtering. The
-    `generate_filter()` method of the baseclass is overwritten to include the
-    scoping.
-    """
+class ComponentFilter(UserScopedFilter):
+    """Model to enable advanced stack component filtering."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *UserScopedFilter.FILTER_EXCLUDE_FIELDS,
         "scope_type",
         "stack_id",
     ]
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+        *UserScopedFilter.CLI_EXCLUDE_FIELDS,
         "scope_type",
     ]
     scope_type: Optional[str] = Field(

zenml/models/v2/core/device.py

@@ -18,11 +18,12 @@ from typing import Optional, Union
 from uuid import UUID
 
 from passlib.context import CryptContext
-from pydantic import BaseModel, Field
+from pydantic import Field
 
 from zenml.enums import OAuthDeviceStatus
 from zenml.models.v2.base.base import (
     BaseRequest,
+    BaseUpdate,
 )
 from zenml.models.v2.base.scoped import (
     UserScopedFilter,
@@ -81,7 +82,7 @@ class OAuthDeviceInternalRequest(BaseRequest):
 # ------------------ Update Model ------------------
 
 
-class OAuthDeviceUpdate(BaseModel):
+class OAuthDeviceUpdate(BaseUpdate):
     """OAuth2 device update model."""
 
     locked: Optional[bool] = Field(