zenml-nightly 0.58.2.dev20240618__py3-none-any.whl → 0.58.2.dev20240620__py3-none-any.whl

zenml/models/v2/core/pipeline_build.py

@@ -52,10 +52,10 @@ class PipelineBuildBase(BaseZenModel):
         title="Whether any image of the build contains user code.",
     )
     zenml_version: Optional[str] = Field(
-        title="The version of ZenML used for this build."
+        title="The version of ZenML used for this build.", default=None
     )
     python_version: Optional[str] = Field(
-        title="The Python version used for this build."
+        title="The Python version used for this build.", default=None
     )
 
     # Helper methods
@@ -156,13 +156,13 @@ class PipelineBuildBase(BaseZenModel):
 class PipelineBuildRequest(PipelineBuildBase, WorkspaceScopedRequest):
     """Request model for pipelines builds."""
 
-    checksum: Optional[str] = Field(title="The build checksum.")
+    checksum: Optional[str] = Field(title="The build checksum.", default=None)
 
     stack: Optional[UUID] = Field(
-        title="The stack that was used for this build."
+        title="The stack that was used for this build.", default=None
     )
     pipeline: Optional[UUID] = Field(
-        title="The pipeline that was used for this build."
+        title="The pipeline that was used for this build.", default=None
     )
     template_deployment_id: Optional[UUID] = None
 
@@ -241,7 +241,7 @@ class PipelineBuildResponse(
         """
         # Get the base attributes
         yaml_dict: Dict[str, Any] = json.loads(
-            self.json(
+            self.model_dump_json(
                 exclude={
                     "body",
                     "metadata",
@@ -249,7 +249,7 @@ class PipelineBuildResponse(
             )
         )
         images = json.loads(
-            self.get_metadata().json(
+            self.get_metadata().model_dump_json(
                 exclude={
                     "pipeline",
                     "stack",
@@ -442,29 +442,41 @@ class PipelineBuildResponse(
 class PipelineBuildFilter(WorkspaceScopedFilter):
     """Model to enable advanced filtering of all pipeline builds."""
 
-    workspace_id: Union[UUID, str, None] = Field(
-        description="Workspace for this pipeline build."
+    workspace_id: Optional[Union[UUID, str]] = Field(
+        description="Workspace for this pipeline build.",
+        default=None,
+        union_mode="left_to_right",
     )
-    user_id: Union[UUID, str, None] = Field(
-        description="User that produced this pipeline build."
+    user_id: Optional[Union[UUID, str]] = Field(
+        description="User that produced this pipeline build.",
+        default=None,
+        union_mode="left_to_right",
     )
-    pipeline_id: Union[UUID, str, None] = Field(
+    pipeline_id: Optional[Union[UUID, str]] = Field(
         description="Pipeline associated with the pipeline build.",
+        default=None,
+        union_mode="left_to_right",
     )
-    stack_id: Union[UUID, str, None] = Field(
-        description="Stack used for the Pipeline Run"
+    stack_id: Optional[Union[UUID, str]] = Field(
+        description="Stack used for the Pipeline Run",
+        default=None,
+        union_mode="left_to_right",
     )
     is_local: Optional[bool] = Field(
         description="Whether the build images are stored in a container "
         "registry or locally.",
+        default=None,
     )
     contains_code: Optional[bool] = Field(
         description="Whether any image of the build contains user code.",
+        default=None,
     )
     zenml_version: Optional[str] = Field(
-        description="The version of ZenML used for this build."
+        description="The version of ZenML used for this build.", default=None
     )
     python_version: Optional[str] = Field(
-        description="The Python version used for this build."
+        description="The Python version used for this build.", default=None
+    )
+    checksum: Optional[str] = Field(
+        description="The build checksum.", default=None
     )
-    checksum: Optional[str] = Field(description="The build checksum.")

zenml/models/v2/core/pipeline_deployment.py

@@ -316,20 +316,32 @@ class PipelineDeploymentFilter(WorkspaceScopedFilter):
     """Model to enable advanced filtering of all pipeline deployments."""
 
     workspace_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Workspace for this deployment."
+        default=None,
+        description="Workspace for this deployment.",
+        union_mode="left_to_right",
     )
     user_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="User that created this deployment."
+        default=None,
+        description="User that created this deployment.",
+        union_mode="left_to_right",
     )
     pipeline_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Pipeline associated with the deployment."
+        default=None,
+        description="Pipeline associated with the deployment.",
+        union_mode="left_to_right",
     )
     stack_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Stack associated with the deployment."
+        default=None,
+        description="Stack associated with the deployment.",
+        union_mode="left_to_right",
     )
     build_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Build associated with the deployment."
+        default=None,
+        description="Build associated with the deployment.",
+        union_mode="left_to_right",
     )
     schedule_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Schedule associated with the deployment."
+        default=None,
+        description="Schedule associated with the deployment.",
+        union_mode="left_to_right",
     )

zenml/models/v2/core/pipeline_namespace.py

@@ -0,0 +1,113 @@
+#  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 pipeline namespaces."""
+
+from typing import Optional
+from uuid import UUID
+
+from pydantic import Field
+
+from zenml.constants import STR_FIELD_MAX_LENGTH
+from zenml.enums import ExecutionStatus
+from zenml.models.v2.base.base import (
+    BaseResponse,
+    BaseResponseBody,
+    BaseResponseMetadata,
+    BaseResponseResources,
+)
+from zenml.models.v2.base.filter import BaseFilter
+
+# ------------------ Request Model ------------------
+
+# There is no request model for pipeline namespaces.
+
+# ------------------ Update Model ------------------
+
+# There is no update model for pipeline namespaces.
+
+# ------------------ Response Model ------------------
+
+
+class PipelineNamespaceResponseBody(BaseResponseBody):
+    """Response body for pipeline namespaces."""
+
+    latest_run_id: Optional[UUID] = Field(
+        default=None,
+        title="The ID of the latest run of the pipeline namespace.",
+    )
+    latest_run_status: Optional[ExecutionStatus] = Field(
+        default=None,
+        title="The status of the latest run of the pipeline namespace.",
+    )
+
+
+class PipelineNamespaceResponseMetadata(BaseResponseMetadata):
+    """Response metadata for pipeline namespaces."""
+
+
+class PipelineNamespaceResponseResources(BaseResponseResources):
+    """Class for all resource models associated with the pipeline namespace entity."""
+
+
+class PipelineNamespaceResponse(
+    BaseResponse[
+        PipelineNamespaceResponseBody,
+        PipelineNamespaceResponseMetadata,
+        PipelineNamespaceResponseResources,
+    ]
+):
+    """Response model for pipeline namespaces."""
+
+    name: str = Field(
+        title="The name of the pipeline namespace.",
+        max_length=STR_FIELD_MAX_LENGTH,
+    )
+
+    def get_hydrated_version(self) -> "PipelineNamespaceResponse":
+        """Get the hydrated version of this pipeline namespace.
+
+        Returns:
+            an instance of the same entity with the metadata field attached.
+        """
+        return self
+
+    @property
+    def latest_run_id(self) -> Optional[UUID]:
+        """The `latest_run_id` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().latest_run_id
+
+    @property
+    def latest_run_status(self) -> Optional[ExecutionStatus]:
+        """The `latest_run_status` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().latest_run_status
+
+
+# ------------------ Filter Model ------------------
+
+
+class PipelineNamespaceFilter(BaseFilter):
+    """Pipeline namespace filter model."""
+
+    name: Optional[str] = Field(
+        default=None,
+        description="Name of the pipeline namespace.",
+    )

zenml/models/v2/core/pipeline_run.py

@@ -16,7 +16,6 @@
 from datetime import datetime
 from typing import (
     TYPE_CHECKING,
-    Any,
     ClassVar,
     Dict,
     List,
@@ -25,7 +24,7 @@ from typing import (
 )
 from uuid import UUID
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from zenml.config.pipeline_configurations import PipelineConfiguration
 from zenml.constants import STR_FIELD_MAX_LENGTH
@@ -42,7 +41,7 @@ from zenml.models.v2.base.scoped import (
 from zenml.models.v2.core.model_version import ModelVersionResponse
 
 if TYPE_CHECKING:
-    from sqlalchemy.sql.elements import BinaryExpression, BooleanClauseList
+    from sqlalchemy.sql.elements import ColumnElement
 
     from zenml.models import TriggerExecutionResponse
     from zenml.models.v2.core.artifact_version import ArtifactVersionResponse
@@ -73,7 +72,8 @@ class PipelineRunRequest(WorkspaceScopedRequest):
         title="The deployment associated with the pipeline run."
     )
     pipeline: Optional[UUID] = Field(
-        title="The pipeline associated with the pipeline run."
+        title="The pipeline associated with the pipeline run.",
+        default=None,
     )
     orchestrator_run_id: Optional[str] = Field(
         title="The orchestrator run ID.",
@@ -198,7 +198,15 @@ class PipelineRunResponseMetadata(WorkspaceScopedResponseMetadata):
 class PipelineRunResponseResources(WorkspaceScopedResponseResources):
     """Class for all resource models associated with the pipeline run entity."""
 
-    model_version: Optional[ModelVersionResponse]
+    model_version: Optional[ModelVersionResponse] = None
+
+    # TODO: In Pydantic v2, the `model_` is a protected namespaces for all
+    #  fields defined under base models. If not handled, this raises a warning.
+    #  It is possible to suppress this warning message with the following
+    #  configuration, however the ultimate solution is to rename these fields.
+    #  Even though they do not cause any problems right now, if we are not
+    #  careful we might overwrite some fields protected by pydantic.
+    model_config = ConfigDict(protected_namespaces=())
 
 
 class PipelineRunResponse(
@@ -431,48 +439,68 @@ class PipelineRunFilter(WorkspaceScopedFilter):
         description="Name of the Pipeline Run within the orchestrator",
     )
     pipeline_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Pipeline associated with the Pipeline Run"
+        default=None,
+        description="Pipeline associated with the Pipeline Run",
+        union_mode="left_to_right",
     )
     pipeline_name: Optional[str] = Field(
         default=None,
         description="Name of the pipeline associated with the run",
     )
     workspace_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Workspace of the Pipeline Run"
+        default=None,
+        description="Workspace of the Pipeline Run",
+        union_mode="left_to_right",
     )
     user_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="User that created the Pipeline Run"
+        default=None,
+        description="User that created the Pipeline Run",
+        union_mode="left_to_right",
     )
     stack_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Stack used for the Pipeline Run"
+        default=None,
+        description="Stack used for the Pipeline Run",
+        union_mode="left_to_right",
     )
     schedule_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Schedule that triggered the Pipeline Run"
+        default=None,
+        description="Schedule that triggered the Pipeline Run",
+        union_mode="left_to_right",
     )
     build_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Build used for the Pipeline Run"
+        default=None,
+        description="Build used for the Pipeline Run",
+        union_mode="left_to_right",
     )
     deployment_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Deployment used for the Pipeline Run"
+        default=None,
+        description="Deployment used for the Pipeline Run",
+        union_mode="left_to_right",
     )
     code_repository_id: Optional[Union[UUID, str]] = Field(
-        default=None, description="Code repository used for the Pipeline Run"
+        default=None,
+        description="Code repository used for the Pipeline Run",
+        union_mode="left_to_right",
     )
     status: Optional[str] = Field(
         default=None,
         description="Name of the Pipeline Run",
     )
     start_time: Optional[Union[datetime, str]] = Field(
-        default=None, description="Start time for this run"
+        default=None,
+        description="Start time for this run",
+        union_mode="left_to_right",
     )
     end_time: Optional[Union[datetime, str]] = Field(
-        default=None, description="End time for this run"
+        default=None,
+        description="End time for this run",
+        union_mode="left_to_right",
     )
     unlisted: Optional[bool] = None
 
     def get_custom_filters(
         self,
-    ) -> List[Union["BinaryExpression[Any]", "BooleanClauseList[Any]"]]:
+    ) -> List["ColumnElement[bool]"]:
         """Get custom filters.
 
         Returns:
@@ -480,7 +508,7 @@ class PipelineRunFilter(WorkspaceScopedFilter):
         """
         custom_filters = super().get_custom_filters()
 
-        from sqlalchemy import and_
+        from sqlmodel import and_
 
         from zenml.zen_stores.schemas import (
             CodeReferenceSchema,
@@ -506,14 +534,14 @@ class PipelineRunFilter(WorkspaceScopedFilter):
                 column="name",
                 value=value,
             )
-            pipeline_name_filter = and_(  # type: ignore[type-var]
+            pipeline_name_filter = and_(
                 PipelineRunSchema.pipeline_id == PipelineSchema.id,
                 filter_.generate_query_conditions(PipelineSchema),
             )
             custom_filters.append(pipeline_name_filter)
 
         if self.code_repository_id:
-            code_repo_filter = and_(  # type: ignore[type-var]
+            code_repo_filter = and_(
                 PipelineRunSchema.deployment_id == PipelineDeploymentSchema.id,
                 PipelineDeploymentSchema.code_reference_id
                 == CodeReferenceSchema.id,
@@ -523,7 +551,7 @@ class PipelineRunFilter(WorkspaceScopedFilter):
             custom_filters.append(code_repo_filter)
 
         if self.stack_id:
-            stack_filter = and_(  # type: ignore[type-var]
+            stack_filter = and_(
                 PipelineRunSchema.deployment_id == PipelineDeploymentSchema.id,
                 PipelineDeploymentSchema.stack_id == StackSchema.id,
                 StackSchema.id == self.stack_id,
@@ -531,7 +559,7 @@ class PipelineRunFilter(WorkspaceScopedFilter):
             custom_filters.append(stack_filter)
 
         if self.schedule_id:
-            schedule_filter = and_(  # type: ignore[type-var]
+            schedule_filter = and_(
                 PipelineRunSchema.deployment_id == PipelineDeploymentSchema.id,
                 PipelineDeploymentSchema.schedule_id == ScheduleSchema.id,
                 ScheduleSchema.id == self.schedule_id,
@@ -539,7 +567,7 @@ class PipelineRunFilter(WorkspaceScopedFilter):
             custom_filters.append(schedule_filter)
 
         if self.build_id:
-            pipeline_build_filter = and_(  # type: ignore[type-var]
+            pipeline_build_filter = and_(
                 PipelineRunSchema.deployment_id == PipelineDeploymentSchema.id,
                 PipelineDeploymentSchema.build_id == PipelineBuildSchema.id,
                 PipelineBuildSchema.id == self.build_id,

zenml/models/v2/core/run_metadata.py

@@ -13,14 +13,15 @@
 #  permissions and limitations under the License.
 """Models representing run metadata."""
 
-from typing import TYPE_CHECKING, Dict, Optional, Union
+from typing import Any, Dict, Optional, Union
 from uuid import UUID
 
-from pydantic import Field
+from pydantic import Field, field_validator
 
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.enums import MetadataResourceTypes
 from zenml.metadata.metadata_types import MetadataType, MetadataTypeEnum
+from zenml.model.model import Model
 from zenml.models.v2.base.scoped import (
     WorkspaceScopedFilter,
     WorkspaceScopedRequest,
@@ -30,9 +31,6 @@ from zenml.models.v2.base.scoped import (
     WorkspaceScopedResponseResources,
 )
 
-if TYPE_CHECKING:
-    from zenml.model.model import Model
-
 # ------------------ Request Model ------------------
 
 
@@ -55,11 +53,6 @@ class RunMetadataRequest(WorkspaceScopedRequest):
         title="The types of the metadata to be created.",
     )
 
-    class Config:
-        """Pydantic configuration."""
-
-        smart_union = True
-
 
 # ------------------ Update Model ------------------
 
@@ -71,23 +64,53 @@ class RunMetadataRequest(WorkspaceScopedRequest):
 class RunMetadataResponseBody(WorkspaceScopedResponseBody):
     """Response body for run metadata."""
 
-    key: str = Field(
-        title="The key of the metadata.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
+    key: str = Field(title="The key of the metadata.")
     value: MetadataType = Field(
-        title="The value of the metadata.",
-        max_length=TEXT_FIELD_MAX_LENGTH,
-    )
-    type: MetadataTypeEnum = Field(
-        title="The type of the metadata.",
-        max_length=STR_FIELD_MAX_LENGTH,
+        title="The value of the metadata.", union_mode="smart"
     )
+    type: MetadataTypeEnum = Field(title="The type of the metadata.")
+
+    @field_validator("key", "type")
+    @classmethod
+    def str_field_max_length_check(cls, value: Any) -> Any:
+        """Checks if the length of the value exceeds the maximum str length.
+
+        Args:
+            value: the value set in the field
+
+        Returns:
+            the value itself.
+
+        Raises:
+            AssertionError: if the length of the field is longer than the
+                maximum threshold.
+        """
+        assert len(str(value)) < STR_FIELD_MAX_LENGTH, (
+            "The length of the value for this field can not "
+            f"exceed {STR_FIELD_MAX_LENGTH}"
+        )
+        return value
+
+    @field_validator("value")
+    @classmethod
+    def text_field_max_length_check(cls, value: Any) -> Any:
+        """Checks if the length of the value exceeds the maximum text length.
+
+        Args:
+            value: the value set in the field
 
-    class Config:
-        """Pydantic configuration."""
+        Returns:
+            the value itself.
 
-        smart_union = True
+        Raises:
+            AssertionError: if the length of the field is longer than the
+                maximum threshold.
+        """
+        assert len(str(value)) < TEXT_FIELD_MAX_LENGTH, (
+            "The length of the value for this field can not "
+            f"exceed {TEXT_FIELD_MAX_LENGTH}"
+        )
+        return value
 
 
 class RunMetadataResponseMetadata(WorkspaceScopedResponseMetadata):
@@ -189,11 +212,17 @@ class RunMetadataResponse(
 class RunMetadataFilter(WorkspaceScopedFilter):
     """Model to enable advanced filtering of run metadata."""
 
-    resource_id: Optional[Union[str, UUID]] = None
+    resource_id: Optional[Union[str, UUID]] = Field(
+        default=None, union_mode="left_to_right"
+    )
     resource_type: Optional[MetadataResourceTypes] = None
-    stack_component_id: Optional[Union[str, UUID]] = None
+    stack_component_id: Optional[Union[str, UUID]] = Field(
+        default=None, union_mode="left_to_right"
+    )
     key: Optional[str] = None
-    type: Optional[Union[str, MetadataTypeEnum]] = None
+    type: Optional[Union[str, MetadataTypeEnum]] = Field(
+        default=None, union_mode="left_to_right"
+    )
 
 
 # -------------------- Lazy Loader --------------------
@@ -207,10 +236,10 @@ class LazyRunMetadataResponse(RunMetadataResponse):
     """
 
     id: Optional[UUID] = None  # type: ignore[assignment]
-    _lazy_load_artifact_name: Optional[str] = None
-    _lazy_load_artifact_version: Optional[str] = None
-    _lazy_load_metadata_name: Optional[str] = None
-    _lazy_load_model: "Model"
+    lazy_load_artifact_name: Optional[str] = None
+    lazy_load_artifact_version: Optional[str] = None
+    lazy_load_metadata_name: Optional[str] = None
+    lazy_load_model: Model
 
     def get_body(self) -> None:  # type: ignore[override]
         """Protects from misuse of the lazy loader.
@@ -231,9 +260,3 @@ class LazyRunMetadataResponse(RunMetadataResponse):
         raise RuntimeError(
             "Cannot access run metadata metadata before pipeline runs."
         )
-
-    class Config:
-        """Pydantic configuration class."""
-
-        # Allow extras to include the lazy load attributes
-        extra = "allow"