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

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(

zenml/models/v2/core/event_source.py

@@ -20,7 +20,7 @@ from pydantic import Field
 
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import PluginSubType
-from zenml.models.v2.base.base import BaseZenModel
+from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.page import Page
 from zenml.models.v2.base.scoped import (
     WorkspaceScopedFilter,
@@ -63,7 +63,7 @@ class EventSourceRequest(WorkspaceScopedRequest):
 # ------------------ Update Model ------------------
 
 
-class EventSourceUpdate(BaseZenModel):
+class EventSourceUpdate(BaseUpdate):
     """Update model for event sources."""
 
     name: Optional[str] = Field(

zenml/models/v2/core/flavor.py

@@ -14,7 +14,6 @@
 """Models representing flavors."""
 
 from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, Optional
-from uuid import UUID
 
 from pydantic import Field
 
@@ -22,25 +21,24 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import StackComponentType
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
+    UserScopedFilter,
     UserScopedRequest,
     UserScopedResponse,
     UserScopedResponseBody,
     UserScopedResponseMetadata,
     UserScopedResponseResources,
-    WorkspaceScopedFilter,
 )
 
 if TYPE_CHECKING:
     from zenml.models import (
         ServiceConnectorRequirements,
     )
-    from zenml.models.v2.core.workspace import WorkspaceResponse
 
 # ------------------ Request Model ------------------
 
 
 class FlavorRequest(UserScopedRequest):
-    """Request model for flavors."""
+    """Request model for stack component flavors."""
 
     ANALYTICS_FIELDS: ClassVar[List[str]] = [
         "type",
@@ -98,25 +96,13 @@ class FlavorRequest(UserScopedRequest):
         title="Whether or not this flavor is a custom, user created flavor.",
         default=True,
     )
-    workspace: Optional[UUID] = Field(
-        default=None, title="The workspace to which this resource belongs."
-    )
-
-
-class InternalFlavorRequest(FlavorRequest):
-    """Internal flavor request model."""
-
-    user: Optional[UUID] = Field(  # type: ignore[assignment]
-        title="The id of the user that created this resource.",
-        default=None,
-    )
 
 
 # ------------------ Update Model ------------------
 
 
 class FlavorUpdate(BaseUpdate):
-    """Update model for flavors."""
+    """Update model for stack component flavors."""
 
     name: Optional[str] = Field(
         title="The name of the Flavor.",
@@ -175,17 +161,13 @@ class FlavorUpdate(BaseUpdate):
         title="Whether or not this flavor is a custom, user created flavor.",
         default=None,
     )
-    workspace: Optional[UUID] = Field(
-        title="The workspace to which this resource belongs.",
-        default=None,
-    )
 
 
 # ------------------ Response Model ------------------
 
 
 class FlavorResponseBody(UserScopedResponseBody):
-    """Response body for flavor."""
+    """Response body for stack component flavors."""
 
     type: StackComponentType = Field(title="The type of the Flavor.")
     integration: Optional[str] = Field(
@@ -201,14 +183,15 @@ class FlavorResponseBody(UserScopedResponseBody):
         title="Optionally, a url pointing to a png,"
         "svg or jpg can be attached.",
     )
+    is_custom: bool = Field(
+        title="Whether or not this flavor is a custom, user created flavor.",
+        default=True,
+    )
 
 
 class FlavorResponseMetadata(UserScopedResponseMetadata):
-    """Response metadata for flavors."""
+    """Response metadata for stack component flavors."""
 
-    workspace: Optional["WorkspaceResponse"] = Field(
-        title="The project of this resource."
-    )
     config_schema: Dict[str, Any] = Field(
         title="The JSON schema of this flavor's corresponding configuration.",
     )
@@ -238,22 +221,20 @@ class FlavorResponseMetadata(UserScopedResponseMetadata):
         title="Optionally, a url pointing to SDK docs,"
         "within sdkdocs.zenml.io.",
     )
-    is_custom: bool = Field(
-        title="Whether or not this flavor is a custom, user created flavor.",
-        default=True,
-    )
 
 
 class FlavorResponseResources(UserScopedResponseResources):
-    """Class for all resource models associated with the flavor entity."""
+    """Response resources for stack component flavors."""
 
 
 class FlavorResponse(
     UserScopedResponse[
-        FlavorResponseBody, FlavorResponseMetadata, FlavorResponseResources
+        FlavorResponseBody,
+        FlavorResponseMetadata,
+        FlavorResponseResources,
     ]
 ):
-    """Response model for flavors."""
+    """Response model for stack component flavors."""
 
     # Analytics
     ANALYTICS_FIELDS: ClassVar[List[str]] = [
@@ -338,13 +319,13 @@ class FlavorResponse(
         return self.get_body().logo_url
 
     @property
-    def workspace(self) -> Optional["WorkspaceResponse"]:
-        """The `workspace` property.
+    def is_custom(self) -> bool:
+        """The `is_custom` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().workspace
+        return self.get_body().is_custom
 
     @property
     def config_schema(self) -> Dict[str, Any]:
@@ -400,21 +381,12 @@ class FlavorResponse(
         """
         return self.get_metadata().sdk_docs_url
 
-    @property
-    def is_custom(self) -> bool:
-        """The `is_custom` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_metadata().is_custom
-
 
 # ------------------ Filter Model ------------------
 
 
-class FlavorFilter(WorkspaceScopedFilter):
-    """Model to enable advanced filtering of all Flavors."""
+class FlavorFilter(UserScopedFilter):
+    """Model to enable advanced stack component flavor filtering."""
 
     name: Optional[str] = Field(
         default=None,

zenml/models/v2/core/logs.py

@@ -35,9 +35,8 @@ class LogsRequest(BaseRequest):
 
     uri: str = Field(title="The uri of the logs file")
 
-    artifact_store_id: Union[str, UUID] = Field(
+    artifact_store_id: UUID = Field(
         title="The artifact store ID to associate the logs with.",
-        union_mode="left_to_right",
     )
 
     @field_validator("uri")

zenml/models/v2/core/model.py

@@ -16,13 +16,14 @@
 from typing import TYPE_CHECKING, Any, ClassVar, List, Optional, Type, TypeVar
 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,
     TEXT_FIELD_MAX_LENGTH,
 )
+from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
     TaggableFilter,
     WorkspaceScopedFilter,
@@ -101,7 +102,7 @@ class ModelRequest(WorkspaceScopedRequest):
 # ------------------ Update Model ------------------
 
 
-class ModelUpdate(BaseModel):
+class ModelUpdate(BaseUpdate):
     """Update model for models."""
 
     name: Optional[str] = None
@@ -312,7 +313,9 @@ class ModelResponse(
 
         client = Client()
         model_versions = depaginate(
-            client.list_model_versions, model_name_or_id=self.id
+            client.list_model_versions,
+            model_name_or_id=self.id,
+            workspace=self.workspace.id,
         )
         return [
             mv.to_model_class(suppress_class_validation_warnings=True)
@@ -340,7 +343,7 @@ class ModelFilter(WorkspaceScopedFilter, TaggableFilter):
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
         SORT_BY_LATEST_VERSION_KEY,
     ]
-    CLI_EXCLUDE_FIELDS = [
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
     ]

zenml/models/v2/core/model_version.py

@@ -25,11 +25,12 @@ from typing import (
 )
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field, PrivateAttr, field_validator
+from pydantic import ConfigDict, Field, field_validator
 
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.enums import ArtifactType, ModelStages
 from zenml.metadata.metadata_types import MetadataType
+from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.filter import AnyQuery
 from zenml.models.v2.base.page import Page
 from zenml.models.v2.base.scoped import (
@@ -90,12 +91,9 @@ class ModelVersionRequest(WorkspaceScopedRequest):
 # ------------------ Update Model ------------------
 
 
-class ModelVersionUpdate(BaseModel):
+class ModelVersionUpdate(BaseUpdate):
     """Update model for model versions."""
 
-    model: UUID = Field(
-        description="The ID of the model containing version",
-    )
     stage: Optional[Union[str, ModelStages]] = Field(
         description="Target model version stage to be set",
         default=None,
@@ -446,7 +444,7 @@ class ModelVersionResponse(
         artifact_versions = Client().list_artifact_versions(
             sort_by="desc:created",
             size=1,
-            name=name,
+            artifact=name,
             version=version,
             model_version_id=self.id,
             type=type,
@@ -574,15 +572,17 @@ class ModelVersionFilter(WorkspaceScopedFilter, TaggableFilter):
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
+        "model",
         "run_metadata",
     ]
-    CUSTOM_SORTING_OPTIONS = [
+    CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
         *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
     ]
-    CLI_EXCLUDE_FIELDS = [
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
+        "model",
     ]
 
     name: Optional[str] = Field(
@@ -602,23 +602,14 @@ class ModelVersionFilter(WorkspaceScopedFilter, TaggableFilter):
         default=None,
         description="The run_metadata to filter the model versions by.",
     )
-
-    _model_id: UUID = PrivateAttr(None)
-
-    def set_scope_model(self, model_name_or_id: Union[str, UUID]) -> None:
-        """Set the model to scope this response.
-
-        Args:
-            model_name_or_id: The model to scope this response to.
-        """
-        try:
-            model_id = UUID(str(model_name_or_id))
-        except ValueError:
-            from zenml.client import Client
-
-            model_id = Client().get_model(model_name_or_id).id
-
-        self._model_id = model_id
+    model: Optional[Union[str, UUID]] = Field(
+        default=None,
+        description="The name or ID of the model 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",
+    )
 
     def get_custom_filters(
         self, table: Type["AnySchema"]
@@ -675,10 +666,28 @@ class ModelVersionFilter(WorkspaceScopedFilter, TaggableFilter):
 
         Returns:
             The query with filter applied.
+
+        Raises:
+            ValueError: if the filter is not scoped to a model.
         """
         query = super().apply_filter(query=query, table=table)
 
-        if self._model_id:
-            query = query.where(getattr(table, "model_id") == self._model_id)
+        # The model 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
+        # model ID.
+        #
+        # If not set by the client, the server will raise a ValueError.
+        #
+        # See: SqlZenStore._set_filter_model_id
+
+        if not self.model:
+            raise ValueError("Model scope missing from the filter.")
+
+        if not isinstance(self.model, UUID):
+            raise ValueError(
+                f"Model scope must be a UUID, got {type(self.model)}."
+            )
+
+        query = query.where(getattr(table, "model_id") == self.model)
 
         return query

zenml/models/v2/core/pipeline.py

@@ -270,7 +270,7 @@ class PipelineFilter(WorkspaceScopedFilter, TaggableFilter):
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
         "latest_run_status",
     ]
-    CLI_EXCLUDE_FIELDS = [
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
     ]

zenml/models/v2/core/pipeline_run.py

@@ -28,12 +28,13 @@ from typing import (
 )
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import ConfigDict, Field
 
 from zenml.config.pipeline_configurations import PipelineConfiguration
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import ExecutionStatus
 from zenml.metadata.metadata_types import MetadataType
+from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
     TaggableFilter,
     WorkspaceScopedFilter,
@@ -45,6 +46,7 @@ from zenml.models.v2.base.scoped import (
 )
 from zenml.models.v2.core.model_version import ModelVersionResponse
 from zenml.models.v2.core.tag import TagResponse
+from zenml.utils.tag_utils import Tag
 
 if TYPE_CHECKING:
     from sqlalchemy.sql.elements import ColumnElement
@@ -117,15 +119,10 @@ class PipelineRunRequest(WorkspaceScopedRequest):
         default=None,
         title="ID of the trigger execution that triggered this run.",
     )
-    tags: Optional[List[str]] = Field(
+    tags: Optional[List[Union[str, Tag]]] = Field(
         default=None,
         title="Tags of the pipeline run.",
     )
-    model_version_id: Optional[UUID] = Field(
-        title="The ID of the model version that was "
-        "configured by this pipeline run explicitly.",
-        default=None,
-    )
 
     model_config = ConfigDict(protected_namespaces=())
 
@@ -133,16 +130,11 @@ class PipelineRunRequest(WorkspaceScopedRequest):
 # ------------------ Update Model ------------------
 
 
-class PipelineRunUpdate(BaseModel):
+class PipelineRunUpdate(BaseUpdate):
     """Pipeline run update model."""
 
     status: Optional[ExecutionStatus] = None
     end_time: Optional[datetime] = None
-    model_version_id: Optional[UUID] = Field(
-        title="The ID of the model version that was "
-        "configured by this pipeline run explicitly.",
-        default=None,
-    )
     # TODO: we should maybe have a different update model here, the upper
     #  three attributes should only be for internal use
     add_tags: Optional[List[str]] = Field(

zenml/models/v2/core/run_template.py

@@ -318,7 +318,6 @@ class RunTemplateFilter(WorkspaceScopedFilter, TaggableFilter):
         "stack_id",
         "build_id",
         "pipeline_id",
-        "user",
         "pipeline",
         "stack",
     ]
@@ -326,7 +325,7 @@ class RunTemplateFilter(WorkspaceScopedFilter, TaggableFilter):
         *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
     ]
-    CLI_EXCLUDE_FIELDS = [
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
     ]

zenml/models/v2/core/schedule.py

@@ -127,15 +127,6 @@ class ScheduleUpdate(BaseUpdate):
     """Update model for schedules."""
 
     name: Optional[str] = None
-    active: Optional[bool] = None
-    cron_expression: Optional[str] = None
-    start_time: Optional[datetime] = None
-    end_time: Optional[datetime] = None
-    interval_second: Optional[timedelta] = None
-    catchup: Optional[bool] = None
-    run_once_start_time: Optional[datetime] = None
-    orchestrator_id: Optional[UUID] = None
-    pipeline_id: Optional[UUID] = None
 
 
 # ------------------ Response Model ------------------