digitalhub 0.8.0__py3-none-any.whl → 0.8.0b1__py3-none-any.whl

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

@@ -3,20 +3,19 @@ from __future__ import annotations
 import typing
 from abc import ABCMeta, abstractmethod
 
-from digitalhub.entities._base._base.entity import Base
-from digitalhub.factory.api import build_entity_from_dict
+from digitalhub.entities._base.base import ModelObj
 
 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
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities._base.spec.base import Spec
+    from digitalhub.entities._base.status.base import Status
 
 
-class Entity(Base, metaclass=ABCMeta):
+class Entity(ModelObj, metaclass=ABCMeta):
     """
     Abstract class for entities.
 
-    An entity is a collection of metadata, specifications.and status
+    An entity is a collection of metadata, specification and status
     representing a variety of objects handled by Digitalhub.
     """
 
@@ -69,7 +68,7 @@ class Entity(Base, metaclass=ABCMeta):
         -------
         None
         """
-        new_obj = build_entity_from_dict(obj)
+        new_obj = self.from_dict(obj)
         self.metadata = new_obj.metadata
         self.spec = new_obj.spec
         self.status = new_obj.status
@@ -94,6 +93,33 @@ class Entity(Base, metaclass=ABCMeta):
         """
         return {k: v for k, v in super().to_dict().items() if k in self._obj_attr}
 
+    @classmethod
+    def from_dict(cls, obj: dict, validate: bool = True) -> Entity:
+        """
+        Create a new object from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to create object from.
+        validate : bool
+            Flag to indicate if arguments validation against a pydantic schema must be ignored.
+
+        Returns
+        -------
+        Self
+            Self instance.
+        """
+        parsed_dict = cls._parse_dict(obj, validate=validate)
+        return cls(**parsed_dict)
+
+    @staticmethod
+    @abstractmethod
+    def _parse_dict(obj: dict, validate: bool = True) -> dict:
+        """
+        Abstract method to parse dictionary.
+        """
+
     def __repr__(self) -> str:
         """
         Return string representation of the entity object.

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

@@ -2,16 +2,16 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.context.api import get_context
-from digitalhub.entities._base.api_utils import create_entity_api_ctx, read_entity_api_ctx, update_entity_api_ctx
-from digitalhub.entities._base.entity.entity import Entity
+from digitalhub.context.builder import get_context
+from digitalhub.entities._base.crud import create_entity_api_ctx, read_entity_api_ctx, update_entity_api_ctx
+from digitalhub.entities._base.entity.base import Entity
 from digitalhub.utils.generic_utils import get_timestamp
 
 if typing.TYPE_CHECKING:
     from digitalhub.context.context import Context
-    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._base.metadata import Metadata
+    from digitalhub.entities._base.spec.base import Spec
+    from digitalhub.entities._base.status.base import Status
 
 
 class ContextEntity(Entity):

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

@@ -2,20 +2,19 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.api_utils import list_entity_api_ctx
-from digitalhub.entities._base.versioned.entity import VersionedEntity
+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.run.crud import delete_run, get_run, list_runs
-from digitalhub.entities.task.crud import delete_task
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
+from digitalhub.entities.task.crud import delete_task, task_from_dict, task_from_parameters
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
 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
-    from digitalhub.entities.run._base.entity import Run
-    from digitalhub.entities.task._base.entity import Task
+    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
 
 
 class ExecutableEntity(VersionedEntity):
@@ -58,7 +57,7 @@ class ExecutableEntity(VersionedEntity):
     #  Tasks
     ##############################
 
-    def _get_or_create_task(self, kind: str) -> Task:
+    def _get_or_create_task(self, kind: str, **kwargs) -> Task:
         """
         Get or create task.
 
@@ -73,10 +72,7 @@ class ExecutableEntity(VersionedEntity):
             Task.
         """
         if self._tasks.get(kind) is None:
-            try:
-                self._tasks[kind] = self.get_task(kind)
-            except EntityError:
-                self._tasks[kind] = self.new_task(kind)
+            return self.new_task(kind)
         return self._tasks[kind]
 
     def import_tasks(self, tasks: list[dict]) -> None:
@@ -102,7 +98,7 @@ class ExecutableEntity(VersionedEntity):
             # Create a new object from dictionary.
             # the form in which tasks are stored in function
             # status
-            task_obj = build_entity_from_dict(task)
+            task_obj = task_from_dict(task)
 
             # Try to save it in backend to been able to use
             # it for launching runs. In fact, tasks must be
@@ -145,40 +141,12 @@ class ExecutableEntity(VersionedEntity):
         kwargs["kind"] = task_kind
 
         # Create object instance
-        task = build_entity_from_params(**kwargs)
+        task = task_from_parameters(**kwargs)
         task.save()
 
         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] = build_entity_from_dict(resp[0])
-            return self._tasks[kind]
-
     def update_task(self, kind: str, **kwargs) -> Task:
         """
         Update task.
@@ -207,47 +175,52 @@ class ExecutableEntity(VersionedEntity):
         kwargs["uuid"] = self._tasks[kind].id
 
         # Update task
-        task = build_entity_from_params(**kwargs)
+        task = task_from_parameters(**kwargs)
         task.save(update=True)
         self._tasks[kind] = task
         return task
 
-    def delete_task(self, kind: str, cascade: bool = True) -> dict:
+    def get_task(self, kind: str) -> Task:
         """
-        Delete task.
+        Get task.
 
         Parameters
         ----------
         kind : str
             Kind the object.
-        cascade : bool
-            Flag to determine if cascade deletion must be performed.
 
         Returns
         -------
-        dict
-            Response from backend.
+        Task
+            Task.
+
+        Raises
+        ------
+        EntityError
+            If task is not created.
         """
-        resp = delete_task(self._tasks[kind].key, cascade=cascade)
-        self._tasks.pop(kind, None)
-        return resp
+        self._raise_if_not_exists(kind)
+        return self._tasks[kind]
 
-    def _get_task_from_backend(self, kind: str) -> list:
+    def delete_task(self, kind: str, cascade: bool = True) -> dict:
         """
-        List tasks from backend filtered by function and kind.
+        Delete task.
 
         Parameters
         ----------
         kind : str
             Kind the object.
+        cascade : bool
+            Flag to determine if cascade deletion must be performed.
 
         Returns
         -------
-        list
+        dict
             Response from backend.
         """
-        params = {"function": self._get_executable_string(), "kind": kind}
-        return list_entity_api_ctx(self.project, EntityTypes.TASK.value, params=params)
+        resp = delete_task(self._tasks[kind].key, cascade=cascade)
+        self._tasks.pop(kind, None)
+        return resp
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """
@@ -263,7 +236,9 @@ class ExecutableEntity(VersionedEntity):
         bool
             Flag to determine if task exists in backend.
         """
-        resp = self._get_task_from_backend(kind)
+        # 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)
         if not resp:
             return False
         return True

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

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

digitalhub/entities/_base/entity/unversioned.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.entity.context import ContextEntity
+from digitalhub.entities._builders.metadata import build_metadata
+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.io_utils import write_yaml
+
+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
+
+
+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)
+
+    @staticmethod
+    def _parse_dict(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 = build_uuid(obj.get("id"))
+        metadata = build_metadata(kind, **obj.get("metadata", {}))
+        spec = build_spec(kind, validate=validate, **obj.get("spec", {}))
+        status = build_status(kind, **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/entity/versioned.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.entity.context import ContextEntity
+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.io_utils import write_yaml
+
+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
+
+
+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)
+
+    @staticmethod
+    def _parse_dict(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 = build_name(obj.get("name"))
+        uuid = build_uuid(obj.get("id"))
+        metadata = build_metadata(kind, **obj.get("metadata", {}))
+        spec = build_spec(kind, validate=validate, **obj.get("spec", {}))
+        status = build_status(kind, **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/{entity/metadata.py → metadata.py}

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-from digitalhub.entities._base._base.entity import Base
+from digitalhub.entities._base.base import ModelObj
 
 
-class Metadata(Base):
+class Metadata(ModelObj):
     """
     A class representing the metadata of an entity.
     Metadata is a collection of information about an entity thought

digitalhub/entities/_base/{entity/spec.py → spec/base.py}

@@ -2,46 +2,46 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from digitalhub.entities._base._base.entity import Base
+from digitalhub.entities._base.base import ModelObj
 
 
-class Spec(Base):
+class Spec(ModelObj):
     """
-    A class representing the specifications.of an entity.
-    specifications.is a collection of information about an entity
+    A class representing the specification of an entity.
+    Specification is a collection of information about an entity
     thought to be immutable by the user.
     """
 
     @classmethod
     def from_dict(cls, obj: dict) -> Spec:
         """
-        Return entity specifications.object from dictionary.
+        Return entity specification object from dictionary.
 
         Parameters
         ----------
         obj : dict
-            A dictionary containing the attributes of the entity specifications.
+            A dictionary containing the attributes of the entity specification.
 
         Returns
         -------
         EntitySpec
-            An entity specifications.object.
+            An entity specification object.
         """
         return cls(**obj)
 
 
-class SpecValidator(BaseModel, extra="ignore"):
+class SpecParams(BaseModel, extra="ignore"):
     """
     A class representing the parameters of an entity.
     This base class is used to define the parameters of an entity
-    specifications.and is used to validate the parameters passed
+    specification and is used to validate the parameters passed
     to the constructor.
     """
 
 
 class MaterialSpec(Spec):
     """
-    Material specifications.class.
+    Material specification class.
     """
 
     def __init__(self, path: str, **kwargs) -> None:
@@ -49,7 +49,7 @@ class MaterialSpec(Spec):
         self.path = path
 
 
-class MaterialValidator(SpecValidator):
+class MaterialParams(SpecParams):
     """
     Material parameters class.
     """

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

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

digitalhub/entities/_base/{entity/status.py → status/base.py}

@@ -1,29 +1,18 @@
 from __future__ import annotations
 
-from digitalhub.entities._base._base.entity import Base
+from digitalhub.entities._base.base import ModelObj
 
 
-class Status(Base):
+class Status(ModelObj):
     """
     Base Status class.
     The status class contains information about the state of an entity,
     for example, the state of a RUNNING run, and eventual error message.
     """
 
-    def __init__(
-        self,
-        state: str,
-        message: str | None = None,
-        transitions: list[dict] | None = None,
-        k8s: dict | None = None,
-        **kwargs,
-    ) -> None:
+    def __init__(self, state: str, message: str | None = None) -> None:
         self.state = state
         self.message = message
-        self.transitions = transitions
-        self.k8s = k8s
-
-        self._any_setter(**kwargs)
 
     @classmethod
     def from_dict(cls, obj: dict) -> Status:

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

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

digitalhub/entities/_builders/metadata.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
+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:
+    """
+    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.
+
+    Parameters
+    ----------
+    kind : str
+        Registry entry kind.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    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)
+
+
+def parse_arguments(**kwargs) -> dict:
+    """
+    Parse keyword arguments and add default values if necessary.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    dict
+        A dictionary containing the entity metadata attributes.
+    """
+    if "created" not in kwargs or kwargs["created"] is None:
+        kwargs["created"] = get_timestamp()
+    if "updated" not in kwargs or kwargs["updated"] is None:
+        kwargs["updated"] = kwargs["created"]
+    return kwargs