digitalhub 0.10.0b4__py3-none-any.whl → 0.10.0b6__py3-none-any.whl

digitalhub/entities/project/_base/entity.py

@@ -1,11 +1,15 @@
 from __future__ import annotations
 
 import typing
+from pathlib import Path
 from typing import Any
 
-from digitalhub.entities._base.project.entity import ProjectEntity
+from digitalhub.client.api import get_client
+from digitalhub.context.api import build_context
+from digitalhub.entities._base.entity.entity import Entity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.base import base_processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.entities.artifact.crud import (
     delete_artifact,
     get_artifact,
@@ -64,9 +68,14 @@ from digitalhub.entities.workflow.crud import (
     new_workflow,
     update_workflow,
 )
-from digitalhub.utils.exceptions import EntityError
+from digitalhub.factory.api import build_entity_from_dict
+from digitalhub.utils.exceptions import BackendError, EntityAlreadyExistsError, EntityError
+from digitalhub.utils.generic_utils import get_timestamp
+from digitalhub.utils.io_utils import write_yaml
+from digitalhub.utils.uri_utils import has_local_scheme
 
 if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.context.entity import ContextEntity
     from digitalhub.entities._base.entity.metadata import Metadata
     from digitalhub.entities.artifact._base.entity import Artifact
     from digitalhub.entities.dataitem._base.entity import Dataitem
@@ -79,7 +88,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.workflow._base.entity import Workflow
 
 
-class Project(ProjectEntity):
+class Project(Entity):
     """
     A class representing a project.
     """
@@ -96,9 +105,308 @@ class Project(ProjectEntity):
         user: str | None = None,
         local: bool = False,
     ) -> None:
-        super().__init__(name, kind, metadata, spec, status, user, local)
-        self.spec: ProjectSpec
-        self.status: ProjectStatus
+        super().__init__(kind, metadata, spec, status, user)
+        self.id = name
+        self.name = name
+        self.key = base_processor.build_project_key(self.name, local=local)
+
+        self._obj_attr.extend(["id", "name"])
+
+        # Set client
+        self._client = get_client(local)
+
+        # Set context
+        build_context(self)
+
+    ##############################
+    #  Save / Refresh / Export
+    ##############################
+
+    def save(self, update: bool = False) -> Project:
+        """
+        Save entity into backend.
+
+        Parameters
+        ----------
+        update : bool
+            If True, the object will be updated.
+
+        Returns
+        -------
+        Project
+            Entity saved.
+        """
+        if update:
+            if self._client.is_local():
+                self.metadata.updated = get_timestamp()
+            new_obj = base_processor.update_project_entity(
+                entity_type=self.ENTITY_TYPE,
+                entity_name=self.name,
+                entity_dict=self.to_dict(),
+                local=self._client.is_local(),
+            )
+        else:
+            new_obj = base_processor.create_project_entity(_entity=self)
+        self._update_attributes(new_obj)
+        return self
+
+    def refresh(self) -> Project:
+        """
+        Refresh object from backend.
+
+        Returns
+        -------
+        Project
+            Project object.
+        """
+        new_obj = base_processor.read_project_entity(
+            entity_type=self.ENTITY_TYPE,
+            entity_name=self.name,
+            local=self._client.is_local(),
+        )
+        self._update_attributes(new_obj)
+        return self
+
+    def search_entity(
+        self,
+        query: str | None = None,
+        entity_types: list[str] | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+        description: str | None = None,
+        labels: list[str] | None = None,
+        **kwargs,
+    ) -> list[ContextEntity]:
+        """
+        Search objects from backend.
+
+        Parameters
+        ----------
+        query : str
+            Search query.
+        entity_types : list[str]
+            Entity types.
+        name : str
+            Entity name.
+        kind : str
+            Entity kind.
+        created : str
+            Entity creation date.
+        updated : str
+            Entity update date.
+        description : str
+            Entity description.
+        labels : list[str]
+            Entity labels.
+        **kwargs : dict
+            Parameters to pass to the API call.
+
+            Returns
+            -------
+            list[ContextEntity]
+                List of object instances.
+        """
+        objs = context_processor.search_entity(
+            self.name,
+            query=query,
+            entity_types=entity_types,
+            name=name,
+            kind=kind,
+            created=created,
+            updated=updated,
+            description=description,
+            labels=labels,
+            **kwargs,
+        )
+        self.refresh()
+        return objs
+
+    def export(self) -> str:
+        """
+        Export object as a YAML file in the context folder.
+        If the objects are not embedded, the objects are exported as a YAML file.
+
+        Returns
+        -------
+        str
+            Exported filepath.
+        """
+        obj = self._refresh_to_dict()
+        pth = Path(self.spec.context) / f"{self.ENTITY_TYPE}s-{self.name}.yaml"
+        obj = self._export_not_embedded(obj)
+        write_yaml(pth, obj)
+        return str(pth)
+
+    def _refresh_to_dict(self) -> dict:
+        """
+        Try to refresh object to collect entities related to project.
+
+        Returns
+        -------
+        dict
+            Entity object in dictionary format.
+        """
+        try:
+            return self.refresh().to_dict()
+        except BackendError:
+            return self.to_dict()
+
+    def _export_not_embedded(self, obj: dict) -> dict:
+        """
+        Export project objects if not embedded.
+
+        Parameters
+        ----------
+        obj : dict
+            Project object in dictionary format.
+
+        Returns
+        -------
+        dict
+            Updatated project object in dictionary format with referenced entities.
+        """
+        # Cycle over entity types
+        for entity_type in self._get_entity_types():
+            # Entity types are stored as a list of entities
+            for idx, entity in enumerate(obj.get("spec", {}).get(entity_type, [])):
+                # Export entity if not embedded is in metadata, else do nothing
+                if not self._is_embedded(entity):
+                    # Get entity object from backend
+                    ent = context_processor.read_context_entity(entity["key"])
+
+                    # Export and store ref in object metadata inside project
+                    pth = ent.export()
+                    obj["spec"][entity_type][idx]["metadata"]["ref"] = pth
+
+        # Return updated object
+        return obj
+
+    def _import_entities(self, obj: dict) -> None:
+        """
+        Import project entities.
+
+        Parameters
+        ----------
+        obj : dict
+            Project object in dictionary format.
+
+        Returns
+        -------
+        None
+        """
+        entity_types = self._get_entity_types()
+
+        # Cycle over entity types
+        for entity_type in entity_types:
+            # Entity types are stored as a list of entities
+            for entity in obj.get("spec", {}).get(entity_type, []):
+                embedded = self._is_embedded(entity)
+                ref = entity["metadata"].get("ref")
+
+                # Import entity if not embedded and there is a ref
+                if not embedded and ref is not None:
+                    # Import entity from local ref
+                    if has_local_scheme(ref):
+                        try:
+                            # Artifacts, Dataitems and Models
+                            if entity_type in entity_types[:3]:
+                                context_processor.import_context_entity(ref)
+
+                            # Functions and Workflows
+                            elif entity_type in entity_types[3:]:
+                                context_processor.import_executable_entity(ref)
+
+                        except FileNotFoundError:
+                            msg = f"File not found: {ref}."
+                            raise EntityError(msg)
+
+                # If entity is embedded, create it and try to save
+                elif embedded:
+                    # It's possible that embedded field in metadata is not shown
+                    if entity["metadata"].get("embedded") is None:
+                        entity["metadata"]["embedded"] = True
+
+                    try:
+                        build_entity_from_dict(entity).save()
+                    except EntityAlreadyExistsError:
+                        pass
+
+    def _load_entities(self, obj: dict) -> None:
+        """
+        Load project entities.
+
+        Parameters
+        ----------
+        obj : dict
+            Project object in dictionary format.
+
+        Returns
+        -------
+        None
+        """
+        entity_types = self._get_entity_types()
+
+        # Cycle over entity types
+        for entity_type in entity_types:
+            # Entity types are stored as a list of entities
+            for entity in obj.get("spec", {}).get(entity_type, []):
+                embedded = self._is_embedded(entity)
+                ref = entity["metadata"].get("ref")
+
+                # Load entity if not embedded and there is a ref
+                if not embedded and ref is not None:
+                    # Load entity from local ref
+                    if has_local_scheme(ref):
+                        try:
+                            # Artifacts, Dataitems and Models
+                            if entity_type in entity_types[:3]:
+                                context_processor.load_context_entity(ref)
+
+                            # Functions and Workflows
+                            elif entity_type in entity_types[3:]:
+                                context_processor.load_executable_entity(ref)
+
+                        except FileNotFoundError:
+                            msg = f"File not found: {ref}."
+                            raise EntityError(msg)
+
+    def _is_embedded(self, entity: dict) -> bool:
+        """
+        Check if entity is embedded.
+
+        Parameters
+        ----------
+        entity : dict
+            Entity in dictionary format.
+
+        Returns
+        -------
+        bool
+            True if entity is embedded.
+        """
+        metadata_embedded = entity["metadata"].get("embedded", False)
+        no_status = entity.get("status", None) is None
+        no_spec = entity.get("spec", None) is None
+        return metadata_embedded or not (no_status and no_spec)
+
+    def _get_entity_types(self) -> list[str]:
+        """
+        Get entity types.
+
+        Returns
+        -------
+        list
+            Entity types.
+        """
+        return [
+            f"{EntityTypes.ARTIFACT.value}s",
+            f"{EntityTypes.DATAITEM.value}s",
+            f"{EntityTypes.MODEL.value}s",
+            f"{EntityTypes.FUNCTION.value}s",
+            f"{EntityTypes.WORKFLOW.value}s",
+        ]
 
     ##############################
     #  Artifacts
@@ -1859,7 +2167,7 @@ class Project(ProjectEntity):
         -------
         None
         """
-        return processor.share_project_entity(
+        return base_processor.share_project_entity(
             entity_type=self.ENTITY_TYPE,
             entity_name=self.name,
             user=user,
@@ -1879,7 +2187,7 @@ class Project(ProjectEntity):
         -------
         None
         """
-        return processor.share_project_entity(
+        return base_processor.share_project_entity(
             entity_type=self.ENTITY_TYPE,
             entity_name=self.name,
             user=user,

digitalhub/entities/project/crud.py

@@ -3,7 +3,8 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.base import base_processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.entities.project.utils import setup_project
 from digitalhub.utils.exceptions import BackendError
 
@@ -58,7 +59,7 @@ def new_project(
     """
     if context is None:
         context = "./"
-    obj = processor.create_project_entity(
+    obj = base_processor.create_project_entity(
         name=name,
         kind="project",
         description=description,
@@ -103,7 +104,7 @@ def get_project(
     --------
     >>> obj = get_project("my-project")
     """
-    obj = processor.read_project_entity(
+    obj = base_processor.read_project_entity(
         entity_type=ENTITY_TYPE,
         entity_name=name,
         local=local,
@@ -142,7 +143,7 @@ def import_project(
     --------
     >>> obj = import_project("my-project.yaml")
     """
-    obj = processor.import_project_entity(file=file, local=local, config=config)
+    obj = base_processor.import_project_entity(file=file, local=local, config=config)
     return setup_project(obj, setup_kwargs)
 
 
@@ -175,7 +176,7 @@ def load_project(
     --------
     >>> obj = load_project("my-project.yaml")
     """
-    obj = processor.load_project_entity(file=file, local=local, config=config)
+    obj = base_processor.load_project_entity(file=file, local=local, config=config)
     return setup_project(obj, setup_kwargs)
 
 
@@ -195,7 +196,7 @@ def list_projects(local: bool = False, **kwargs) -> list[Project]:
     list
         List of objects.
     """
-    return processor.list_project_entities(local=local, **kwargs)
+    return base_processor.list_project_entities(local=local, **kwargs)
 
 
 def get_or_create_project(
@@ -268,7 +269,7 @@ def update_project(entity: Project, **kwargs) -> Project:
     --------
     >>> obj = update_project(obj)
     """
-    return processor.update_project_entity(
+    return base_processor.update_project_entity(
         entity_type=entity.ENTITY_TYPE,
         entity_name=entity.name,
         entity_dict=entity.to_dict(),
@@ -309,7 +310,7 @@ def delete_project(
     --------
     >>> delete_project("my-project")
     """
-    return processor.delete_project_entity(
+    return base_processor.delete_project_entity(
         entity_type=ENTITY_TYPE,
         entity_name=name,
         local=local,
@@ -362,7 +363,7 @@ def search_entity(
         list[ContextEntity]
             List of object instances.
     """
-    return processor.search_entity(
+    return context_processor.search_entity(
         project_name,
         query=query,
         entity_types=entity_types,

digitalhub/entities/run/_base/entity.py

@@ -5,8 +5,8 @@ import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes, State
-from digitalhub.entities._commons.utils import validate_metric_value
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._commons.metrics import MetricType, set_metrics, validate_metric_value
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.factory.api import (
     build_runtime,
     build_spec,
@@ -46,9 +46,6 @@ class Run(UnversionedEntity):
         self.spec: RunSpec
         self.status: RunStatus
 
-        # Initialize metrics
-        self._init_metrics()
-
     ##############################
     #  Run Methods
     ##############################
@@ -141,7 +138,7 @@ class Run(UnversionedEntity):
         dict
             Run logs.
         """
-        return processor.read_run_logs(self.project, self.ENTITY_TYPE, self.id)
+        return context_processor.read_run_logs(self.project, self.ENTITY_TYPE, self.id)
 
     def stop(self) -> None:
         """
@@ -152,7 +149,7 @@ class Run(UnversionedEntity):
         None
         """
         if not self.spec.local_execution:
-            return processor.stop_run(self.project, self.ENTITY_TYPE, self.id)
+            return context_processor.stop_run(self.project, self.ENTITY_TYPE, self.id)
 
     def resume(self) -> None:
         """
@@ -163,12 +160,12 @@ class Run(UnversionedEntity):
         None
         """
         if not self.spec.local_execution:
-            return processor.resume_run(self.project, self.ENTITY_TYPE, self.id)
+            return context_processor.resume_run(self.project, self.ENTITY_TYPE, self.id)
 
     def log_metric(
         self,
         key: str,
-        value: list[float | int] | float | int,
+        value: MetricType,
         overwrite: bool = False,
         single_value: bool = False,
     ) -> None:
@@ -182,7 +179,7 @@ class Run(UnversionedEntity):
         ----------
         key : str
             Key of the metric.
-        value : list[float | int] | float | int
+        value : MetricType
             Value of the metric.
         overwrite : bool
             If True, overwrite existing metric.
@@ -210,16 +207,8 @@ class Run(UnversionedEntity):
         Log a list of values and overwrite existing metric:
         >>> entity.log_metric("accuracy", [0.8, 0.9], overwrite=True)
         """
-        value = validate_metric_value(value)
-
-        if isinstance(value, list):
-            self._handle_metric_list(key, value, overwrite)
-        elif single_value:
-            self._handle_metric_single(key, value, overwrite)
-        else:
-            self._handle_metric_list_append(key, value, overwrite)
-
-        processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
+        self._set_metrics(key, value, overwrite, single_value)
+        context_processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
 
     ##############################
     #  Helpers
@@ -340,7 +329,7 @@ class Run(UnversionedEntity):
         exec_type = get_entity_type_from_kind(exec_kind)
         string_to_split = getattr(self.spec, exec_type)
         exec_name, exec_id = string_to_split.split("://")[-1].split("/")[-1].split(":")
-        return processor.read_context_entity(
+        return context_processor.read_context_entity(
             exec_name,
             entity_type=exec_type,
             project=self.project,
@@ -358,97 +347,56 @@ class Run(UnversionedEntity):
             Task from backend.
         """
         task_id = self.spec.task.split("://")[-1].split("/")[-1]
-        return processor.read_unversioned_entity(
+        return context_processor.read_unversioned_entity(
             task_id,
             entity_type=EntityTypes.TASK.value,
             project=self.project,
         ).to_dict()
 
-    def _init_metrics(self) -> None:
-        """
-        Initialize metrics.
-
-        Returns
-        -------
-        None
-        """
-        if self.status.metrics is None:
-            self.status.metrics = {}
-
     def _get_metrics(self) -> None:
         """
-        Get run metrics from backend.
+        Get model metrics from backend.
 
         Returns
         -------
         None
         """
-        self.status.metrics = processor.read_metrics(
+        self.status.metrics = context_processor.read_metrics(
             project=self.project,
             entity_type=self.ENTITY_TYPE,
             entity_id=self.id,
         )
 
-    def _handle_metric_single(self, key: str, value: float | int, overwrite: bool = False) -> None:
-        """
-        Handle metric single value.
-
-        Parameters
-        ----------
-        key : str
-            Key of the metric.
-        value : float
-            Value of the metric.
-        overwrite : bool
-            If True, overwrite existing metric.
-
-        Returns
-        -------
-        None
-        """
-        if key not in self.status.metrics or overwrite:
-            self.status.metrics[key] = value
-
-    def _handle_metric_list_append(self, key: str, value: float | int, overwrite: bool = False) -> None:
-        """
-        Handle metric list append.
-
-        Parameters
-        ----------
-        key : str
-            Key of the metric.
-        value : float
-            Value of the metric.
-        overwrite : bool
-            If True, overwrite existing metric.
-
-        Returns
-        -------
-        None
-        """
-        if key not in self.status.metrics or overwrite:
-            self.status.metrics[key] = [value]
-        else:
-            self.status.metrics[key].append(value)
-
-    def _handle_metric_list(self, key: str, value: list[int | float], overwrite: bool = False) -> None:
+    def _set_metrics(
+        self,
+        key: str,
+        value: MetricType,
+        overwrite: bool,
+        single_value: bool,
+    ) -> None:
         """
-        Handle metric list.
+        Set model metrics.
 
         Parameters
         ----------
         key : str
             Key of the metric.
-        value : list[int | float]
+        value : MetricType
             Value of the metric.
         overwrite : bool
             If True, overwrite existing metric.
+        single_value : bool
+            If True, value is a single value.
 
         Returns
         -------
         None
         """
-        if key not in self.status.metrics or overwrite:
-            self.status.metrics[key] = value
-        else:
-            self.status.metrics[key].extend(value)
+        value = validate_metric_value(value)
+        self.status.metrics = set_metrics(
+            self.status.metrics,
+            key,
+            value,
+            overwrite,
+            single_value,
+        )

digitalhub/entities/run/_base/status.py

@@ -18,4 +18,4 @@ class RunStatus(Status):
         **kwargs,
     ) -> None:
         super().__init__(state, message, transitions, k8s, **kwargs)
-        self.metrics = metrics
+        self.metrics = metrics if metrics is not None else {}