digitalhub 0.9.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

digitalhub/entities/_base/project/entity.py

@@ -1,341 +0,0 @@
-from __future__ import annotations
-
-import typing
-from pathlib import Path
-
-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.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._base.entity.spec import Spec
-    from digitalhub.entities._base.entity.status import Status
-
-
-class ProjectEntity(Entity):
-    """
-    Base entity for Project entity.
-    Used to abstract a bit by handling I/O CRUD.
-    """
-
-    def __init__(
-        self,
-        name: str,
-        kind: str,
-        metadata: Metadata,
-        spec: Spec,
-        status: Status,
-        user: str | None = None,
-        local: bool = False,
-    ) -> None:
-        super().__init__(kind, metadata, spec, status, user)
-        self.id = name
-        self.name = name
-        self.key = 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) -> ProjectEntity:
-        """
-        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 = 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 = processor.create_project_entity(_entity=self)
-        self._update_attributes(new_obj)
-        return self
-
-    def refresh(self) -> ProjectEntity:
-        """
-        Refresh object from backend.
-
-        Returns
-        -------
-        Project
-            Project object.
-        """
-        new_obj = 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 = 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 = 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]:
-                                processor.import_context_entity(ref)
-
-                            # Functions and Workflows
-                            elif entity_type in entity_types[3:]:
-                                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]:
-                                processor.load_context_entity(ref)
-
-                            # Functions and Workflows
-                            elif entity_type in entity_types[3:]:
-                                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",
-        ]

digitalhub-0.9.1.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-digitalhub
-test

test/local/CRUD/test_artifacts.py

@@ -1,96 +0,0 @@
-"""
-Unit tests for the entity Artifact
-"""
-
-import digitalhub as dh
-from digitalhub.entities.artifact._base.entity import Artifact
-
-
-class TestArtifactCRUD:
-    def create_test_dicts(self):
-        names = ["test1", "test2", "test3", "test4"]
-        uuids = [
-            "d150bcca-bb64-451d-8455-dff862254b95",
-            "31acdd2d-0c41-428c-b68b-1b133da9e97b",
-            "b4a3dfdc-b917-44c4-9a29-613dcf734244",
-            "2618d9c4-cd61-440f-aebb-7e5761709f3b",
-        ]
-        paths = [
-            "./data/test.csv",
-            "s3://bucket/key.csv",
-            "sql://database/schema/table",
-            "https://url.com/file.csv",
-        ]
-        kind = ["artifact", "artifact", "artifact", "artifact"]
-
-        dicts = []
-        for i in range(len(names)):
-            dicts.append({"name": names[i], "uuid": uuids[i], "path": paths[i], "kind": kind[i]})
-
-        return dicts
-
-    def test_create_delete(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-        # Create and delete artifacts
-        for i in dicts:
-            d = dh.new_artifact(p.name, **i)
-            dh.delete_artifact(d.key)
-            d = dh.new_artifact(p.name, **i)
-            dh.delete_artifact(d.name, project=p.name, entity_id=d.id)
-            d = p.new_artifact(**i)
-            p.delete_artifact(d.key)
-
-        assert dh.list_artifacts(p.name) == []
-        dh.delete_project("test", local=True, clean_context=True)
-
-    def test_list(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-
-        assert dh.list_artifacts(p.name) == []
-
-        for i in dicts:
-            dh.new_artifact(p.name, **i)
-
-        # List artifacts
-        l_obj = dh.list_artifacts(p.name)
-        assert isinstance(l_obj, list)
-        assert len(l_obj) == 4
-        for i in l_obj:
-            assert isinstance(i, Artifact)
-
-        # delete listed objects
-        for obj in l_obj:
-            dh.delete_artifact(obj.key)
-
-        assert len(dh.list_artifacts(p.name)) == 0
-
-        dh.delete_project("test", clean_context=True, local=True)
-
-    def test_get(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-
-        for i in dicts:
-            o1 = dh.new_artifact(p.name, **i)
-            assert isinstance(o1, Artifact)
-
-            # Get by name and id
-            o2 = dh.get_artifact(o1.name, project=p.name, entity_id=o1.id)
-            assert isinstance(o2, Artifact)
-            assert o1.id == o2.id
-
-            # Get by key
-            o3 = dh.get_artifact(o1.key)
-            assert isinstance(o3, Artifact)
-            assert o1.id == o3.id
-
-        # delete listed objects
-        l_obj = dh.list_artifacts(p.name)
-        for obj in l_obj:
-            dh.delete_artifact(obj.key)
-
-        assert len(dh.list_artifacts(p.name)) == 0
-
-        dh.delete_project("test", clean_context=True, local=True)

test/local/CRUD/test_dataitems.py

@@ -1,96 +0,0 @@
-"""
-Unit tests for the entity Dataitem
-"""
-
-import digitalhub as dh
-from digitalhub.entities.dataitem._base.entity import Dataitem
-
-
-class TestDataitemCRUD:
-    def create_test_dicts(self):
-        names = ["test1", "test2", "test3", "test4"]
-        uuids = [
-            "d150bcca-bb64-451d-8455-dff862254b95",
-            "31acdd2d-0c41-428c-b68b-1b133da9e97b",
-            "b4a3dfdc-b917-44c4-9a29-613dcf734244",
-            "2618d9c4-cd61-440f-aebb-7e5761709f3b",
-        ]
-        paths = [
-            "./data/test.csv",
-            "s3://bucket/key.csv",
-            "sql://database/schema/table",
-            "https://url.com/file.csv",
-        ]
-        kind = ["dataitem", "dataitem", "dataitem", "dataitem"]
-
-        dicts = []
-        for i in range(len(names)):
-            dicts.append({"name": names[i], "uuid": uuids[i], "path": paths[i], "kind": kind[i]})
-
-        return dicts
-
-    def test_create_delete(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-        # Create and delete dataitems
-        for i in dicts:
-            d = dh.new_dataitem(p.name, **i)
-            dh.delete_dataitem(d.key)
-            d = dh.new_dataitem(p.name, **i)
-            dh.delete_dataitem(d.name, project=p.name, entity_id=d.id)
-            d = p.new_dataitem(**i)
-            p.delete_dataitem(d.key)
-
-        assert dh.list_dataitems(p.name) == []
-        dh.delete_project("test", local=True, clean_context=True)
-
-    def test_list(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-
-        assert dh.list_dataitems(p.name) == []
-
-        for i in dicts:
-            dh.new_dataitem(p.name, **i)
-
-        # List dataitems
-        l_obj = dh.list_dataitems(p.name)
-        assert isinstance(l_obj, list)
-        assert len(l_obj) == 4
-        for i in l_obj:
-            assert isinstance(i, Dataitem)
-
-        # delete listed objects
-        for obj in l_obj:
-            dh.delete_dataitem(obj.key)
-
-        assert len(dh.list_dataitems(p.name)) == 0
-
-        dh.delete_project("test", clean_context=True, local=True)
-
-    def test_get(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-
-        for i in dicts:
-            o1 = dh.new_dataitem(p.name, **i)
-            assert isinstance(o1, Dataitem)
-
-            # Get by name and id
-            o2 = dh.get_dataitem(o1.name, project=p.name, entity_id=o1.id)
-            assert isinstance(o2, Dataitem)
-            assert o1.id == o2.id
-
-            # Get by key
-            o3 = dh.get_dataitem(o1.key)
-            assert isinstance(o3, Dataitem)
-            assert o1.id == o3.id
-
-        # delete listed objects
-        l_obj = dh.list_dataitems(p.name)
-        for obj in l_obj:
-            dh.delete_dataitem(obj.key)
-
-        assert len(dh.list_dataitems(p.name)) == 0
-
-        dh.delete_project("test", clean_context=True, local=True)

test/local/CRUD/test_models.py

@@ -1,95 +0,0 @@
-"""
-Unit tests for the entity Models
-"""
-
-import digitalhub as dh
-from digitalhub.entities.model._base.entity import Model
-
-
-class TestModelCRUD:
-    def create_test_dicts(self):
-        names = ["test1", "test2", "test3", "test4"]
-        uuids = [
-            "d150bcca-bb64-451d-8455-dff862254b95",
-            "31acdd2d-0c41-428c-b68b-1b133da9e97b",
-            "b4a3dfdc-b917-44c4-9a29-613dcf734244",
-            "2618d9c4-cd61-440f-aebb-7e5761709f3b",
-        ]
-        paths = [
-            "./data/my_random_forest_model.pkl",
-            "s3://bucket/model.pkl",
-            "sql://database/schema/linear_regression_model.joblib",
-            "https://url.com/bert_base_uncased.pt",
-        ]
-        kind = ["model", "model", "model", "model"]
-
-        dicts = []
-        for i in range(len(names)):
-            dicts.append({"name": names[i], "uuid": uuids[i], "path": paths[i], "kind": kind[i]})
-
-        return dicts
-
-    def test_create_delete(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-        # Create and delete models
-        for i in dicts:
-            d = dh.new_model(p.name, **i)
-            dh.delete_model(d.key)
-            d = dh.new_model(p.name, **i)
-            dh.delete_model(d.name, project=p.name, entity_id=d.id)
-            d = p.new_model(**i)
-            p.delete_model(d.key)
-        assert dh.list_models(p.name) == []
-        dh.delete_project("test", local=True, clean_context=True)
-
-    def test_list(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-
-        assert dh.list_models(p.name) == []
-
-        for i in dicts:
-            dh.new_model(p.name, **i)
-
-        # List models
-        l_obj = dh.list_models(p.name)
-        assert isinstance(l_obj, list)
-        assert len(l_obj) == 4
-        for i in l_obj:
-            assert isinstance(i, Model)
-
-        # delete listed objects
-        for obj in l_obj:
-            dh.delete_model(obj.key)
-
-        assert len(dh.list_models(p.name)) == 0
-
-        dh.delete_project("test", clean_context=True, local=True)
-
-    def test_get(self):
-        dicts = self.create_test_dicts()
-        p = dh.get_or_create_project("test", local=True)
-
-        for i in dicts:
-            o1 = dh.new_model(p.name, **i)
-            assert isinstance(o1, Model)
-
-            # Get by name and id
-            o2 = dh.get_model(o1.name, project=p.name, entity_id=o1.id)
-            assert isinstance(o2, Model)
-            assert o1.id == o2.id
-
-            # Get by key
-            o3 = dh.get_model(o1.key)
-            assert isinstance(o3, Model)
-            assert o1.id == o3.id
-
-        # delete listed objects
-        l_obj = dh.list_models(p.name)
-        for obj in l_obj:
-            dh.delete_model(obj.key)
-
-        assert len(dh.list_models(p.name)) == 0
-
-        dh.delete_project("test", clean_context=True, local=True)

test/local/imports/test_imports.py

@@ -1,66 +0,0 @@
-import digitalhub
-
-METHODS = [
-    "new_artifact",
-    "new_function",
-    "new_project",
-    "new_run",
-    "new_secret",
-    "new_task",
-    "new_workflow",
-    "new_dataitem",
-    "new_model",
-    "get_artifact",
-    "get_function",
-    "get_project",
-    "get_run",
-    "get_secret",
-    "get_task",
-    "get_workflow",
-    "get_dataitem",
-    "get_model",
-    "import_artifact",
-    "import_function",
-    "import_project",
-    "import_run",
-    "import_secret",
-    "import_task",
-    "import_workflow",
-    "import_dataitem",
-    "import_model",
-    "list_artifacts",
-    "list_functions",
-    "list_runs",
-    "list_secrets",
-    "list_tasks",
-    "list_workflows",
-    "list_dataitems",
-    "list_models",
-    "update_artifact",
-    "update_function",
-    "update_project",
-    "update_run",
-    "update_secret",
-    "update_task",
-    "update_workflow",
-    "update_dataitem",
-    "update_model",
-    "delete_artifact",
-    "delete_function",
-    "delete_project",
-    "delete_run",
-    "delete_secret",
-    "delete_task",
-    "delete_workflow",
-    "delete_dataitem",
-    "delete_model",
-    "set_dhcore_env",
-    "set_store",
-    "load_project",
-    "get_or_create_project",
-]
-
-
-def test_imports():
-    for i in METHODS:
-        assert hasattr(digitalhub, i)