digitalhub 0.8.0b2__py3-none-any.whl → 0.8.0b4__py3-none-any.whl

digitalhub/entities/_base/{entity/executable.py → executable/entity.py}

@@ -3,18 +3,18 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.crud import list_entity_api_ctx
-from digitalhub.entities._base.entity.versioned import VersionedEntity
-from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities.run.crud import delete_run, get_run, list_runs
 from digitalhub.entities.task.crud import delete_task, task_from_dict, task_from_parameters
+from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
-    from digitalhub.entities.run.entity import Run
-    from digitalhub.entities.task.entity import Task
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
+    from digitalhub.entities.run._base.entity import Run
+    from digitalhub.entities.task._base.entity import Task
 
 
 class ExecutableEntity(VersionedEntity):
@@ -57,7 +57,7 @@ class ExecutableEntity(VersionedEntity):
     #  Tasks
     ##############################
 
-    def _get_or_create_task(self, kind: str, **kwargs) -> Task:
+    def _get_or_create_task(self, kind: str) -> Task:
         """
         Get or create task.
 
@@ -72,7 +72,10 @@ class ExecutableEntity(VersionedEntity):
             Task.
         """
         if self._tasks.get(kind) is None:
-            return self.new_task(kind)
+            try:
+                self._tasks[kind] = self.get_task(kind)
+            except EntityError:
+                self._tasks[kind] = self.new_task(kind)
         return self._tasks[kind]
 
     def import_tasks(self, tasks: list[dict]) -> None:
@@ -147,6 +150,34 @@ class ExecutableEntity(VersionedEntity):
         self._tasks[task_kind] = task
         return task
 
+    def get_task(self, kind: str) -> Task:
+        """
+        Get task.
+
+        Parameters
+        ----------
+        kind : str
+            Kind the object.
+
+        Returns
+        -------
+        Task
+            Task.
+
+        Raises
+        ------
+        EntityError
+            If task is not created.
+        """
+        try:
+            return self._tasks[kind]
+        except KeyError:
+            resp = self._get_task_from_backend(kind)
+            if not resp:
+                raise EntityError(f"Task {kind} is not created")
+            self._tasks[kind] = task_from_dict(resp[0])
+            return self._tasks[kind]
+
     def update_task(self, kind: str, **kwargs) -> Task:
         """
         Update task.
@@ -180,47 +211,42 @@ class ExecutableEntity(VersionedEntity):
         self._tasks[kind] = task
         return task
 
-    def get_task(self, kind: str) -> Task:
+    def delete_task(self, kind: str, cascade: bool = True) -> dict:
         """
-        Get task.
+        Delete task.
 
         Parameters
         ----------
         kind : str
             Kind the object.
+        cascade : bool
+            Flag to determine if cascade deletion must be performed.
 
         Returns
         -------
-        Task
-            Task.
-
-        Raises
-        ------
-        EntityError
-            If task is not created.
+        dict
+            Response from backend.
         """
-        self._raise_if_not_exists(kind)
-        return self._tasks[kind]
+        resp = delete_task(self._tasks[kind].key, cascade=cascade)
+        self._tasks.pop(kind, None)
+        return resp
 
-    def delete_task(self, kind: str, cascade: bool = True) -> dict:
+    def _get_task_from_backend(self, kind: str) -> list:
         """
-        Delete task.
+        List tasks from backend filtered by function and kind.
 
         Parameters
         ----------
         kind : str
             Kind the object.
-        cascade : bool
-            Flag to determine if cascade deletion must be performed.
 
         Returns
         -------
-        dict
+        list
             Response from backend.
         """
-        resp = delete_task(self._tasks[kind].key, cascade=cascade)
-        self._tasks.pop(kind, None)
-        return resp
+        params = {"function": self._get_executable_string(), "kind": kind}
+        return list_entity_api_ctx(self.project, EntityTypes.TASK.value, params=params)
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """
@@ -236,9 +262,7 @@ class ExecutableEntity(VersionedEntity):
         bool
             Flag to determine if task exists in backend.
         """
-        # List tasks from backend filtered by function and kind
-        params = {"function": self._get_executable_string(), "kind": kind}
-        resp = list_entity_api_ctx(self.project, EntityTypes.TASK.value, params=params)
+        resp = self._get_task_from_backend(kind)
         if not resp:
             return False
         return True

digitalhub/entities/_base/{entity/material.py → material/entity.py}

@@ -4,13 +4,13 @@ import typing
 from pathlib import Path
 
 from digitalhub.entities._base.crud import files_info_get_api, files_info_put_api
-from digitalhub.entities._base.entity.versioned import VersionedEntity
+from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.stores.builder import get_store
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.material import MaterialSpec
-    from digitalhub.entities._base.status.material import MaterialStatus
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.material.spec import MaterialSpec
+    from digitalhub.entities._base.material.status import MaterialStatus
 
 
 class MaterialEntity(VersionedEntity):

digitalhub/entities/_base/{spec/material.py → material/spec.py}

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.spec.base import Spec, SpecParams
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 
 
 class MaterialSpec(Spec):
     """
-    Material specification class.
+    Material specifications.class.
     """
 
     def __init__(self, path: str, **kwargs) -> None:
@@ -13,7 +13,7 @@ class MaterialSpec(Spec):
         self.path = path
 
 
-class MaterialParams(SpecParams):
+class MaterialValidator(SpecValidator):
     """
     Material parameters class.
     """

digitalhub/entities/_base/{status/material.py → material/status.py}

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.status.base import Status
+from digitalhub.entities._base.entity.status import Status
 
 
 class MaterialStatus(Status):

digitalhub/entities/_base/unversioned/builder.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._builders.entity import EntityBuilder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.unversioned.entity import UnversionedEntity
+
+
+class UnversionedBuilder(EntityBuilder):
+    """
+    Unversioned builder.
+    """
+
+    def from_dict(self, obj: dict, validate: bool = True) -> UnversionedEntity:
+        """
+        Create a new object from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to create object from.
+        validate : bool
+            Flag to indicate if arguments must be validated.
+
+        Returns
+        -------
+        UnversionedEntity
+            Object instance.
+        """
+        parsed_dict = self._parse_dict(obj, validate=validate)
+        return self.build_entity(**parsed_dict)
+
+    def _parse_dict(self, obj: dict, validate: bool = True) -> dict:
+        """
+        Get dictionary and parse it to a valid entity dictionary.
+
+        Parameters
+        ----------
+        entity : str
+            Entity type.
+        obj : dict
+            Dictionary to parse.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        project = obj.get("project")
+        kind = obj.get("kind")
+        uuid = self.build_uuid(obj.get("id"))
+        metadata = self.build_metadata(**obj.get("metadata", {}))
+        spec = self.build_spec(validate=validate, **obj.get("spec", {}))
+        status = self.build_status(**obj.get("status", {}))
+        user = obj.get("user")
+        return {
+            "project": project,
+            "uuid": uuid,
+            "kind": kind,
+            "metadata": metadata,
+            "spec": spec,
+            "status": status,
+            "user": user,
+        }

digitalhub/entities/_base/unversioned/entity.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.context.entity import ContextEntity
+from digitalhub.utils.io_utils import write_yaml
+
+if typing.TYPE_CHECKING:
+    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 UnversionedEntity(ContextEntity):
+    def __init__(
+        self,
+        project: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: Spec,
+        status: Status,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, kind, metadata, spec, status, user)
+        self.id = uuid
+        self.key = f"store://{project}/{self.ENTITY_TYPE}/{kind}/{uuid}"
+        self._obj_attr.extend(["id"])
+
+    def export(self, filename: str | None = None) -> str:
+        """
+        Export object 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.to_dict()
+        if filename is None:
+            filename = f"{self.ENTITY_TYPE}-{self.id}.yml"
+        pth = self._context().root / filename
+        write_yaml(pth, obj)
+        return str(pth)

digitalhub/entities/_base/versioned/builder.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._builders.entity import EntityBuilder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.versioned.entity import VersionedEntity
+
+
+class VersionedBuilder(EntityBuilder):
+    """
+    Versioned builder.
+    """
+
+    def from_dict(self, obj: dict, validate: bool = True) -> VersionedEntity:
+        """
+        Create a new object from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to create object from.
+        validate : bool
+            Flag to indicate if arguments must be validated.
+
+        Returns
+        -------
+        VersionedEntity
+            Object instance.
+        """
+        parsed_dict = self._parse_dict(obj, validate=validate)
+        return self.build_entity(**parsed_dict)
+
+    def _parse_dict(self, obj: dict, validate: bool = True) -> dict:
+        """
+        Get dictionary and parse it to a valid entity dictionary.
+
+        Parameters
+        ----------
+        entity : str
+            Entity type.
+        obj : dict
+            Dictionary to parse.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        project = obj.get("project")
+        kind = obj.get("kind")
+        name = self.build_name(obj.get("name"))
+        uuid = self.build_uuid(obj.get("id"))
+        metadata = self.build_metadata(**obj.get("metadata", {}))
+        spec = self.build_spec(validate=validate, **obj.get("spec", {}))
+        status = self.build_status(**obj.get("status", {}))
+        user = obj.get("user")
+        return {
+            "project": project,
+            "name": name,
+            "uuid": uuid,
+            "kind": kind,
+            "metadata": metadata,
+            "spec": spec,
+            "status": status,
+            "user": user,
+        }

digitalhub/entities/_base/versioned/entity.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.context.entity import ContextEntity
+from digitalhub.utils.io_utils import write_yaml
+
+if typing.TYPE_CHECKING:
+    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 VersionedEntity(ContextEntity):
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: Spec,
+        status: Status,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, kind, metadata, spec, status, user)
+        self.name = name
+        self.id = uuid
+        self.key = f"store://{project}/{self.ENTITY_TYPE}/{kind}/{name}:{uuid}"
+
+        # Add attributes to be used in the to_dict method
+        self._obj_attr.extend(["name", "id"])
+
+    def export(self, filename: str | None = None) -> str:
+        """
+        Export object 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.to_dict()
+        if filename is None:
+            filename = f"{self.ENTITY_TYPE}-{self.name}-{self.id}.yml"
+        pth = self._context().root / filename
+        write_yaml(pth, obj)
+        return str(pth)

digitalhub/entities/_builders/entity.py

@@ -0,0 +1,153 @@
+from __future__ import annotations
+
+import typing
+from abc import abstractmethod
+
+from digitalhub.entities._builders.metadata import build_metadata
+from digitalhub.entities._builders.name import build_name
+from digitalhub.entities._builders.spec import build_spec
+from digitalhub.entities._builders.status import build_status
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.utils.exceptions import BuilderError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.entity import Entity
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+    from digitalhub.entities._base.entity.status import Status
+
+
+class EntityBuilder:
+    """
+    Builder class for building entities.
+    """
+
+    # Class variables
+    ENTITY_TYPE: str = None
+    ENTITY_CLASS: Entity = None
+    ENTITY_SPEC_CLASS: Spec = None
+    ENTITY_SPEC_VALIDATOR: SpecValidator = None
+    ENTITY_STATUS_CLASS: Status = None
+    ENTITY_KIND: str = None
+
+    def __init__(self) -> None:
+        if self.ENTITY_TYPE is None:
+            raise BuilderError("ENTITY_TYPE must be set")
+        if self.ENTITY_CLASS is None:
+            raise BuilderError("ENTITY_CLASS must be set")
+        if self.ENTITY_SPEC_CLASS is None:
+            raise BuilderError("ENTITY_SPEC_CLASS must be set")
+        if self.ENTITY_SPEC_VALIDATOR is None:
+            raise BuilderError("ENTITY_SPEC_VALIDATOR must be set")
+        if self.ENTITY_STATUS_CLASS is None:
+            raise BuilderError("ENTITY_STATUS_CLASS must be set")
+        if self.ENTITY_KIND is None:
+            raise BuilderError("ENTITY_KIND must be set")
+
+    def build_name(self, name: str) -> str:
+        """
+        Build entity name.
+
+        Parameters
+        ----------
+        name : str
+            Entity name.
+
+        Returns
+        -------
+        str
+            Entity name.
+        """
+        return build_name(name)
+
+    def build_uuid(self, uuid: str) -> str:
+        """
+        Build entity uuid.
+
+        Parameters
+        ----------
+        uuid : str
+            Entity uuid.
+
+        Returns
+        -------
+        str
+            Entity uuid.
+        """
+        return build_uuid(uuid)
+
+    def build_metadata(self, **kwargs) -> Metadata:
+        """
+        Build entity metadata object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Metadata
+            Metadata object.
+        """
+        return build_metadata(**kwargs)
+
+    def build_spec(self, validate: bool = True, **kwargs) -> Spec:
+        """
+        Build entity spec object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Spec
+            Spec object.
+        """
+        return build_spec(self.ENTITY_SPEC_CLASS, self.ENTITY_SPEC_VALIDATOR, validate=validate, **kwargs)
+
+    def build_status(self, **kwargs) -> Status:
+        """
+        Build entity status object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Status
+            Status object.
+        """
+        return build_status(self.ENTITY_STATUS_CLASS, **kwargs)
+
+    def build_entity(self, **kwargs) -> Entity:
+        """
+        Build entity object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Entity
+            Entity object.
+        """
+        return self.ENTITY_CLASS(**kwargs)
+
+    @abstractmethod
+    def build(self, *args, **kwargs) -> Entity:
+        """
+        Build entity object.
+        """
+
+    @abstractmethod
+    def from_dict(self, obj: dict, validate: bool = True) -> Entity:
+        """
+        Build entity object from dictionary.
+        """

digitalhub/entities/_builders/metadata.py

@@ -1,30 +1,16 @@
 from __future__ import annotations
 
-import typing
-
-from digitalhub.registry.registry import registry
-from digitalhub.registry.utils import import_class
+from digitalhub.entities._base.entity.metadata import Metadata
 from digitalhub.utils.generic_utils import get_timestamp
 
-if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.registry.models import RegistryEntry
-
 
-def build_metadata(kind: str, **kwargs) -> Metadata:
+def build_metadata(**kwargs) -> Metadata:
     """
-    Build entity metadata object. The builder takes as input
-    the kind of metadata's object to build and the keyword
-    arguments to pass to the metadata's constructor.
-    The specific Metadata class is searched in the global
-    registry, where lies info about where to find the class.
-    The arguments are parsed, eventually adding default values,
-    and then passed to the constructor.
+    Build entity metadata object. This method is used to build entity
+    metadata.
 
     Parameters
     ----------
-    kind : str
-        Registry entry kind.
     **kwargs : dict
         Keyword arguments for the constructor.
 
@@ -33,10 +19,8 @@ def build_metadata(kind: str, **kwargs) -> Metadata:
     Metadata
         Metadata object.
     """
-    infos: RegistryEntry = getattr(registry, kind)
-    metadata = import_class(infos.metadata.module, infos.metadata.class_name)
     kwargs = parse_arguments(**kwargs)
-    return metadata(**kwargs)
+    return Metadata(**kwargs)
 
 
 def parse_arguments(**kwargs) -> dict: