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

digitalhub/entities/_base/entity/_constructors/status.py

@@ -1,52 +0,0 @@
-from __future__ import annotations
-
-import typing
-
-from digitalhub.entities.utils.state import State
-
-if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.entity.status import Status
-
-
-def build_status(status_cls: Status, **kwargs) -> Status:
-    """
-    Build entity status object. This method is used to build entity
-    status.
-
-    Parameters
-    ----------
-    status_cls : Status
-        Entity status class.
-    **kwargs : dict
-        Keyword arguments.
-
-    Returns
-    -------
-    Status
-        Entity status object.
-    """
-    kwargs = parse_arguments(**kwargs)
-    return status_cls(**kwargs)
-
-
-def parse_arguments(**kwargs) -> dict:
-    """
-    Parse keyword arguments and add default values if necessary.
-
-    Parameters
-    ----------
-    **kwargs : dict
-        Keyword arguments.
-
-    Returns
-    -------
-    dict
-        Keyword arguments with default values.
-    """
-    state = kwargs.get("state")
-    if state is None:
-        kwargs["state"] = State.CREATED.value
-    else:
-        if kwargs["state"] not in State.__members__:
-            raise ValueError(f"Invalid state: {state}")
-    return kwargs

digitalhub/entities/_base/entity/builder.py

@@ -1,175 +0,0 @@
-from __future__ import annotations
-
-import typing
-from abc import abstractmethod
-
-from digitalhub.entities._base.entity._constructors.metadata import build_metadata
-from digitalhub.entities._base.entity._constructors.name import build_name
-from digitalhub.entities._base.entity._constructors.spec import build_spec
-from digitalhub.entities._base.entity._constructors.status import build_status
-from digitalhub.entities._base.entity._constructors.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.
-        """
-
-    def get_entity_type(self) -> str:
-        """
-        Get entity type.
-
-        Returns
-        -------
-        str
-            Entity type.
-        """
-        return self.ENTITY_TYPE
-
-    def get_kind(self) -> str:
-        """
-        Get entity kind.
-
-        Returns
-        -------
-        str
-            Entity kind.
-        """
-        return self.ENTITY_KIND

digitalhub/entities/_base/runtime_entity/builder.py

@@ -1,106 +0,0 @@
-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

@@ -1,66 +0,0 @@
-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

@@ -1,49 +0,0 @@
-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

@@ -1,68 +0,0 @@
-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

@@ -1,53 +0,0 @@
-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

@@ -1,86 +0,0 @@
-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/spec.py

@@ -1,15 +0,0 @@
-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

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