digitalhub 0.7.0b2__py3-none-any.whl → 0.8.0__py3-none-any.whl

digitalhub/entities/_base/runtime_entity/builder.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+from digitalhub.utils.exceptions import EntityError
+
+
+class RuntimeEntityBuilder:
+    """
+    RuntimeEntity builder.
+    """
+
+    EXECUTABLE_KIND: str = None
+    TASKS_KINDS: dict = None
+    RUN_KIND: str = None
+
+    def __init__(self) -> None:
+        if self.EXECUTABLE_KIND is None:
+            raise EntityError("EXECUTABLE_KIND must be set")
+        if self.TASKS_KINDS is None:
+            raise EntityError("TASKS_KINDS must be set")
+        if self.RUN_KIND is None:
+            raise EntityError("RUN_KIND must be set")
+
+    def get_action_from_task_kind(self, task_kind: str) -> str:
+        """
+        Get action from task kind.
+
+        Parameters
+        ----------
+        task_kind : str
+            Task kind.
+
+        Returns
+        -------
+        str
+            Action.
+        """
+        for task in self.TASKS_KINDS:
+            if task["kind"] == task_kind:
+                return task["action"]
+        msg = f"Task kind {task_kind} not allowed."
+        raise EntityError(msg)
+
+    def get_task_kind_from_action(self, action: str) -> list[str]:
+        """
+        Get task kinds from action.
+
+        Parameters
+        ----------
+        action : str
+            Action.
+
+        Returns
+        -------
+        list[str]
+            Task kinds.
+        """
+        for task in self.TASKS_KINDS:
+            if task["action"] == action:
+                return task["kind"]
+        msg = f"Action {action} not allowed."
+        raise EntityError(msg)
+
+    def get_run_kind(self) -> str:
+        """
+        Get run kind.
+
+        Returns
+        -------
+        str
+            Run kind.
+        """
+        return self.RUN_KIND
+
+    def get_executable_kind(self) -> str:
+        """
+        Get executable kind.
+
+        Returns
+        -------
+        str
+            Executable kind.
+        """
+        return self.EXECUTABLE_KIND
+
+    def get_all_kinds(self) -> list[str]:
+        """
+        Get all kinds.
+
+        Returns
+        -------
+        list[str]
+            All kinds.
+        """
+        task_kinds = [i["kind"] for i in self.TASKS_KINDS]
+        return [self.EXECUTABLE_KIND, self.RUN_KIND, *task_kinds]
+
+    def get_all_actions(self) -> list[str]:
+        """
+        Get all actions.
+
+        Returns
+        -------
+        list[str]
+            All actions.
+        """
+        return [i["action"] for i in self.TASKS_KINDS]

digitalhub/entities/_base/unversioned/builder.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.entity.builder 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._base.entity.builder 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/artifact/_base/builder.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.versioned.builder import VersionedBuilder
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.utils.exceptions import EntityError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.artifact._base.entity import Artifact
+
+
+class ArtifactBuilder(VersionedBuilder):
+    """
+    Artifact builder.
+    """
+
+    ENTITY_TYPE = EntityTypes.ARTIFACT.value
+
+    def build(
+        self,
+        kind: str,
+        project: str,
+        name: str,
+        uuid: str | None = None,
+        description: str | None = None,
+        labels: list[str] | None = None,
+        embedded: bool = False,
+        path: str | None = None,
+        **kwargs,
+    ) -> Artifact:
+        """
+        Create a new object.
+
+        Parameters
+        ----------
+        project : str
+            Project name.
+        name : str
+            Object name.
+        kind : str
+            Kind the object.
+        uuid : str
+            ID of the object.
+        description : str
+            Description of the object (human readable).
+        labels : list[str]
+            List of labels.
+        embedded : bool
+            Flag to determine if object spec must be embedded in project spec.
+        path : str
+            Object path on local file system or remote storage. It is also the destination path of upload() method.
+        **kwargs : dict
+            Spec keyword arguments.
+
+        Returns
+        -------
+        Artifact
+            Object instance.
+        """
+        if path is None:
+            raise EntityError("Path must be provided.")
+
+        name = self.build_name(name)
+        uuid = self.build_uuid(uuid)
+        metadata = self.build_metadata(
+            project=project,
+            name=name,
+            description=description,
+            labels=labels,
+            embedded=embedded,
+        )
+        spec = self.build_spec(
+            path=path,
+            **kwargs,
+        )
+        status = self.build_status()
+        return self.build_entity(
+            project=project,
+            name=name,
+            uuid=uuid,
+            kind=kind,
+            metadata=metadata,
+            spec=spec,
+            status=status,
+        )

digitalhub/entities/artifact/_base/entity.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.material.entity import MaterialEntity
+from digitalhub.entities.utils.entity_types import EntityTypes
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.artifact._base.spec import ArtifactSpec
+    from digitalhub.entities.artifact._base.status import ArtifactStatus
+
+
+class Artifact(MaterialEntity):
+    """
+    A class representing a artifact.
+
+    Artifacts are (binary) objects stored in one of the artifact
+    stores of the platform, and available to every process, module
+    and component as files.
+    """
+
+    ENTITY_TYPE = EntityTypes.ARTIFACT.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ArtifactSpec,
+        status: ArtifactStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ArtifactSpec
+        self.status: ArtifactStatus

digitalhub/entities/artifact/_base/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.spec import MaterialSpec, MaterialValidator
+
+
+class ArtifactSpec(MaterialSpec):
+    """
+    ArtifactSpec specifications.
+    """
+
+
+class ArtifactValidator(MaterialValidator):
+    """
+    ArtifactValidator validator.
+    """

digitalhub/entities/artifact/_base/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.status import MaterialStatus
+
+
+class ArtifactStatus(MaterialStatus):
+    """
+    ArtifactStatus status.
+    """

digitalhub/entities/artifact/artifact/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.artifact._base.builder import ArtifactBuilder
+from digitalhub.entities.artifact.artifact.entity import ArtifactArtifact
+from digitalhub.entities.artifact.artifact.spec import ArtifactSpecArtifact, ArtifactValidatorArtifact
+from digitalhub.entities.artifact.artifact.status import ArtifactStatusArtifact
+
+
+class ArtifactArtifactBuilder(ArtifactBuilder):
+    """
+    ArtifactArtifact builder.
+    """
+
+    ENTITY_CLASS = ArtifactArtifact
+    ENTITY_SPEC_CLASS = ArtifactSpecArtifact
+    ENTITY_SPEC_VALIDATOR = ArtifactValidatorArtifact
+    ENTITY_STATUS_CLASS = ArtifactStatusArtifact
+    ENTITY_KIND = "artifact"

digitalhub/entities/artifact/artifact/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.artifact._base.entity import Artifact
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.artifact.artifact.spec import ArtifactSpecArtifact
+    from digitalhub.entities.artifact.artifact.status import ArtifactStatusArtifact
+
+
+class ArtifactArtifact(Artifact):
+    """
+    ArtifactArtifact class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ArtifactSpecArtifact,
+        status: ArtifactStatusArtifact,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ArtifactSpecArtifact
+        self.status: ArtifactStatusArtifact

digitalhub/entities/artifact/artifact/spec.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from digitalhub.entities.artifact._base.spec import ArtifactSpec, ArtifactValidator
+
+
+class ArtifactSpecArtifact(ArtifactSpec):
+    """
+    ArtifactSpecArtifact specifications.
+    """
+
+    def __init__(
+        self,
+        path: str,
+        src_path: str | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(path, **kwargs)
+        self.src_path = src_path
+
+
+class ArtifactValidatorArtifact(ArtifactValidator):
+    """
+    ArtifactValidatorArtifact validator.
+    """
+
+    src_path: str = None
+    """Source path of the artifact."""

digitalhub/entities/artifact/artifact/status.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.status import MaterialStatus
+
+
+class ArtifactStatus(MaterialStatus):
+    """
+    Status class for artifact entities.
+    """
+
+
+class ArtifactStatusArtifact(ArtifactStatus):
+    """
+    Status class for artifact entities.
+    """