digitalhub 0.8.1__py3-none-any.whl → 0.9.0b0__py3-none-any.whl

digitalhub/entities/project/_base/entity.py

@@ -1,19 +1,11 @@
 from __future__ import annotations
 
 import typing
-from pathlib import Path
 from typing import Any
 
-from digitalhub.client.api import get_client
-from digitalhub.context.api import set_context
-from digitalhub.entities._base.api_utils import (
-    create_entity_api_base,
-    read_entity_api_base,
-    read_entity_api_ctx,
-    update_entity_api_base,
-)
-from digitalhub.entities._base.crud import import_context_entity, import_executable_entity
-from digitalhub.entities._base.entity.entity import Entity
+from digitalhub.entities._base.project.entity import ProjectEntity
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._operations.processor import processor
 from digitalhub.entities.artifact.crud import (
     delete_artifact,
     get_artifact,
@@ -63,7 +55,6 @@ from digitalhub.entities.secret.crud import (
     new_secret,
     update_secret,
 )
-from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.workflow.crud import (
     delete_workflow,
     get_workflow,
@@ -73,11 +64,7 @@ from digitalhub.entities.workflow.crud import (
     new_workflow,
     update_workflow,
 )
-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 map_uri_scheme
+from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -92,7 +79,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.workflow._base.entity import Workflow
 
 
-class Project(Entity):
+class Project(ProjectEntity):
     """
     A class representing a project.
     """
@@ -109,257 +96,10 @@ class Project(Entity):
         user: str | None = None,
         local: bool = False,
     ) -> None:
-        super().__init__(kind, metadata, spec, status, user)
-        self.id = name
-        self.name = name
-        self.key = f"store://{name}"
+        super().__init__(name, kind, metadata, spec, status, user, local)
         self.spec: ProjectSpec
         self.status: ProjectStatus
 
-        # Add attributes to be used in the to_dict method
-        self._obj_attr.extend(["id", "name"])
-
-        # Set client
-        self._client = get_client(local)
-
-        # Set context
-        set_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.
-        """
-        obj = self._refresh_to_dict()
-
-        if not update:
-            new_obj = create_entity_api_base(self._client, self.ENTITY_TYPE, obj)
-            new_obj["local"] = self._client.is_local()
-            self._update_attributes(new_obj)
-            return self
-
-        self.metadata.updated = obj["metadata"]["updated"] = get_timestamp()
-        new_obj = update_entity_api_base(self._client, self.ENTITY_TYPE, obj)
-        new_obj["local"] = self._client.is_local()
-        self._update_attributes(new_obj)
-        return self
-
-    def refresh(self) -> Project:
-        """
-        Refresh object from backend.
-
-        Returns
-        -------
-        Project
-            Project object.
-        """
-        new_obj = read_entity_api_base(self._client, self.ENTITY_TYPE, self.name)
-        new_obj["local"] = self._client.is_local()
-        self._update_attributes(new_obj)
-        return self
-
-    def export(self, filename: str | None = None) -> str:
-        """
-        Export object as a YAML file. If the objects are not embedded, the objects are
-        exported as a YAML file.
-
-        Parameters
-        ----------
-        filename : str
-            Name of the export YAML file. If not specified, the default value is used.
-
-        Returns
-        -------
-        str
-            Exported file.
-        """
-        obj = self._refresh_to_dict()
-
-        if filename is None:
-            filename = f"{self.kind}_{self.name}.yml"
-        pth = Path(self.spec.context) / filename
-        pth.parent.mkdir(parents=True, exist_ok=True)
-
-        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
-                    obj_dict: dict = read_entity_api_ctx(entity["key"])
-
-                    # Create from dict (not need to new method, we do not save to backend)
-                    ent = build_entity_from_dict(obj_dict)
-
-                    # Export and stor 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 map_uri_scheme(ref) == "local":
-                        try:
-                            # Artifacts, Dataitems and Models
-                            if entity_type in entity_types[:3]:
-                                import_context_entity(ref)
-
-                            # Functions and Workflows
-                            elif entity_type in entity_types[3:]:
-                                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 _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",
-        ]
-
-    def run(self, workflow: str | None = None, **kwargs) -> Run:
-        """
-        Run workflow project.
-
-        Parameters
-        ----------
-        workflow : str
-            Workflow name.
-        **kwargs : dict
-            Keyword arguments passed to workflow.run().
-
-        Returns
-        -------
-        Run
-            Run instance.
-        """
-        self.refresh()
-
-        workflow = workflow if workflow is not None else "main"
-
-        for i in self.spec.workflows:
-            if workflow in [i["name"], i["key"]]:
-                entity = self.get_workflow(i["key"])
-                break
-        else:
-            msg = f"Workflow {workflow} not found."
-            raise EntityError(msg)
-
-        return entity.run(**kwargs)
-
     ##############################
     #  Artifacts
     ##############################
@@ -565,7 +305,7 @@ class Project(Entity):
         **kwargs,
     ) -> Artifact:
         """
-        Import object from a YAML file.
+        Import object from a YAML file and create a new object into the backend.
 
         Parameters
         ----------
@@ -868,7 +608,7 @@ class Project(Entity):
         **kwargs,
     ) -> Dataitem:
         """
-        Import object from a YAML file.
+        Import object from a YAML file and create a new object into the backend.
 
         Parameters
         ----------
@@ -1160,7 +900,7 @@ class Project(Entity):
         **kwargs,
     ) -> Model:
         """
-        Import object from a YAML file.
+        Import object from a YAML file and create a new object into the backend.
 
         Parameters
         ----------
@@ -1403,7 +1143,7 @@ class Project(Entity):
         **kwargs,
     ) -> Function:
         """
-        Import object from a YAML file.
+        Import object from a YAML file and create a new object into the backend.
 
         Parameters
         ----------
@@ -1649,7 +1389,7 @@ class Project(Entity):
         **kwargs,
     ) -> Workflow:
         """
-        Import object from a YAML file.
+        Import object from a YAML file and create a new object into the backend.
 
         Parameters
         ----------
@@ -1893,7 +1633,7 @@ class Project(Entity):
         **kwargs,
     ) -> Secret:
         """
-        Import object from a YAML file.
+        Import object from a YAML file and create a new object into the backend.
 
         Parameters
         ----------
@@ -2076,3 +1816,73 @@ class Project(Entity):
     ##############################
     #  Project methods
     ##############################
+
+    def run(self, workflow: str | None = None, **kwargs) -> Run:
+        """
+        Run workflow project.
+
+        Parameters
+        ----------
+        workflow : str
+            Workflow name.
+        **kwargs : dict
+            Keyword arguments passed to workflow.run().
+
+        Returns
+        -------
+        Run
+            Run instance.
+        """
+        self.refresh()
+
+        workflow = workflow if workflow is not None else "main"
+
+        for i in self.spec.workflows:
+            if workflow in [i["name"], i["key"]]:
+                entity = self.get_workflow(i["key"])
+                break
+        else:
+            msg = f"Workflow {workflow} not found."
+            raise EntityError(msg)
+
+        return entity.run(**kwargs)
+
+    def share(self, user: str) -> None:
+        """
+        Share project.
+
+        Parameters
+        ----------
+        user : str
+            User to share project with.
+        Returns
+        -------
+        None
+        """
+        return processor.share_project_entity(
+            entity_type=self.ENTITY_TYPE,
+            entity_name=self.name,
+            user=user,
+            unshare=False,
+            local=self._client.is_local(),
+        )
+
+    def unshare(self, user: str) -> None:
+        """
+        Unshare project.
+
+        Parameters
+        ----------
+        user : str
+            User to unshare project with.
+        Returns
+        -------
+        None
+        """
+        return processor.share_project_entity(
+            entity_type=self.ENTITY_TYPE,
+            entity_name=self.name,
+            user=user,
+            unshare=True,
+            local=self._client.is_local(),
+        )