digitalhub 0.8.0b5__tar.gz → 0.8.0b7__tar.gz

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub
-Version: 0.8.0b5
+Version: 0.8.0b7
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License

digitalhub-0.8.0b5/digitalhub/entities/_builders/entity.py → digitalhub-0.8.0b7/digitalhub/entities/_base/entity/builder.py

@@ -3,11 +3,11 @@ 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.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:
@@ -151,3 +151,25 @@ class EntityBuilder:
         """
         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-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/_base/entity/entity.py

@@ -4,7 +4,7 @@ import typing
 from abc import ABCMeta, abstractmethod
 
 from digitalhub.entities._base._base.entity import Base
-from digitalhub.factory.factory import factory
+from digitalhub.factory.api import build_entity_from_dict
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -69,7 +69,7 @@ class Entity(Base, metaclass=ABCMeta):
         -------
         None
         """
-        new_obj = factory.build_entity_from_dict(self.kind, obj)
+        new_obj = build_entity_from_dict(self.kind, obj)
         self.metadata = new_obj.metadata
         self.spec = new_obj.spec
         self.status = new_obj.status

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/_base/entity/status.py

@@ -10,9 +10,20 @@ class Status(Base):
     for example, the state of a RUNNING run, and eventual error message.
     """
 
-    def __init__(self, state: str, message: str | None = None) -> None:
+    def __init__(
+        self,
+        state: str,
+        message: str | None = None,
+        transitions: list[dict] | None = None,
+        k8s: dict | None = None,
+        **kwargs,
+    ) -> 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-0.8.0b7/digitalhub/entities/_base/runtime_entity/builder.py

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

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/_base/unversioned/builder.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._builders.entity import EntityBuilder
+from digitalhub.entities._base.entity.builder import EntityBuilder
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.unversioned.entity import UnversionedEntity

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/_base/versioned/builder.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._builders.entity import EntityBuilder
+from digitalhub.entities._base.entity.builder import EntityBuilder
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.versioned.entity import VersionedEntity

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/artifact/crud.py

@@ -9,7 +9,7 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx,
     read_entity_api_ctx_versions,
 )
-from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities._base.entity._constructors.uuid import build_uuid
 from digitalhub.entities.artifact.builder import artifact_from_dict, artifact_from_parameters
 from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.utils.utils import build_log_path_from_source, eval_local_source

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/dataitem/crud.py

@@ -12,7 +12,7 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx,
     read_entity_api_ctx_versions,
 )
-from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities._base.entity._constructors.uuid import build_uuid
 from digitalhub.entities.dataitem.builder import dataitem_from_dict, dataitem_from_parameters
 from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.utils.utils import build_log_path_from_filename, build_log_path_from_source, eval_local_source

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/function/_base/builder.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.entities._base.runtime_entity.builder import RuntimeEntityBuilder
 from digitalhub.entities._base.versioned.builder import VersionedBuilder
 from digitalhub.entities.utils.entity_types import EntityTypes
 
@@ -9,7 +10,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.function._base.entity import Function
 
 
-class FunctionBuilder(VersionedBuilder):
+class FunctionBuilder(VersionedBuilder, RuntimeEntityBuilder):
     """
     Function builder.
     """

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/function/_base/entity.py

@@ -5,7 +5,7 @@ from concurrent.futures import ThreadPoolExecutor
 
 from digitalhub.entities._base.executable.entity import ExecutableEntity
 from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.runtimes.utils import get_kind_registry
+from digitalhub.factory.api import get_run_kind, get_task_kind_from_action
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
@@ -71,12 +71,9 @@ class Function(ExecutableEntity):
         Run
             Run instance.
         """
-        # Get kind registry
-        kind_reg = get_kind_registry(self.kind, self.project)
-
         # Get task and run kind
-        task_kind = kind_reg.get_task_kind_from_action(action=action)
-        run_kind = kind_reg.get_run_kind()
+        task_kind = get_task_kind_from_action(self.kind, action)
+        run_kind = get_run_kind(self.kind)
 
         # Create or update new task
         task = self._get_or_create_task(task_kind)

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/model/crud.py

@@ -9,7 +9,7 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx,
     read_entity_api_ctx_versions,
 )
-from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities._base.entity._constructors.uuid import build_uuid
 from digitalhub.entities.model.builder import model_from_dict, model_from_parameters
 from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.utils.utils import build_log_path_from_source, eval_local_source

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/project/_base/builder.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from digitalhub.entities._builders.entity import EntityBuilder
+from digitalhub.entities._base.entity.builder import EntityBuilder
 from digitalhub.entities.project._base.entity import Project
 from digitalhub.entities.project._base.spec import ProjectSpec, ProjectValidator
 from digitalhub.entities.project._base.status import ProjectStatus

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/run/_base/builder.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.entities._base.runtime_entity.builder import RuntimeEntityBuilder
 from digitalhub.entities._base.unversioned.builder import UnversionedBuilder
 from digitalhub.entities.utils.entity_types import EntityTypes
 
@@ -9,7 +10,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.run._base.entity import Run
 
 
-class RunBuilder(UnversionedBuilder):
+class RunBuilder(UnversionedBuilder, RuntimeEntityBuilder):
     """
     Run builder.
     """

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/run/_base/entity.py

@@ -14,7 +14,13 @@ from digitalhub.entities._base.crud import (
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.utils.state import State
-from digitalhub.factory.factory import factory
+from digitalhub.factory.api import (
+    build_runtime,
+    build_spec,
+    build_status,
+    get_entity_type_from_kind,
+    get_executable_kind,
+)
 from digitalhub.utils.exceptions import EntityError
 from digitalhub.utils.logger import LOGGER
 
@@ -59,11 +65,10 @@ class Run(UnversionedEntity):
         -------
         None
         """
-        runtime = self._get_runtime()
-        executable = self._get_executable(runtime)
-        task = self._get_task(runtime)
-        new_spec = runtime.build(executable, task, self.to_dict())
-        self.spec = factory.build_spec(
+        executable = self._get_executable()
+        task = self._get_task()
+        new_spec = self._get_runtime().build(executable, task, self.to_dict())
+        self.spec = build_spec(
             self.kind,
             **new_spec,
         )
@@ -92,9 +97,6 @@ class Run(UnversionedEntity):
             status = self._get_runtime().run(self.to_dict())
         except Exception as e:
             self.refresh()
-            import pdb
-
-            pdb.set_trace()
             if self.spec.local_execution:
                 self._set_state(State.ERROR.value)
             self._set_message(str(e))
@@ -163,11 +165,6 @@ class Run(UnversionedEntity):
         """
         if not self._context().local and not self.spec.local_execution:
             return stop_api(self.project, self.ENTITY_TYPE, self.id)
-        try:
-            self.status.stop()
-        except AttributeError:
-            raise EntityError("Stop is not supported in local execution.")
-            return
 
     def resume(self) -> None:
         """
@@ -179,14 +176,6 @@ class Run(UnversionedEntity):
         """
         if not self._context().local and not self.spec.local_execution:
             return resume_api(self.project, self.ENTITY_TYPE, self.id)
-
-        try:
-            self.status.resume()
-        except AttributeError:
-            raise EntityError("Resume is not supported in local execution.")
-            return
-        # re-run
-        # TODO verify the logic and order
         self.run()
 
     ##############################
@@ -226,7 +215,7 @@ class Run(UnversionedEntity):
         -------
         None
         """
-        self.status: RunStatus = factory.build_status(self.kind, **status)
+        self.status: RunStatus = build_status(self.kind, **status)
 
     def _set_state(self, state: str) -> None:
         """
@@ -267,24 +256,20 @@ class Run(UnversionedEntity):
         Runtime
             Runtime object.
         """
-        return factory.build_runtime(self.kind, self.project)
+        return build_runtime(self.kind, self.project)
 
-    def _get_executable(self, runtime: Runtime) -> dict:
+    def _get_executable(self) -> dict:
         """
-        Get object from backend. Reimplemented to avoid circular imports.
-
-        Parameters
-        ----------
-        runtime : Runtime
-            Runtime object.
+        Get executable object from backend. Reimplemented to avoid
+        circular imports.
 
         Returns
         -------
         dict
             Executable (function or workflow) from backend.
         """
-        exec_kind = runtime.get_executable_kind()
-        entity_type = factory.get_entity_type_from_builder(exec_kind)
+        exec_kind = get_executable_kind(self.kind)
+        entity_type = get_entity_type_from_kind(exec_kind)
         splitted = self.spec.task.split("/")
         exec_name = splitted[-1].split(":")[0]
         exec_id = splitted[-1].split(":")[1]
@@ -295,21 +280,17 @@ class Run(UnversionedEntity):
             entity_id=exec_id,
         )
 
-    def _get_task(self, runtime: Runtime) -> dict:
+    def _get_task(self) -> dict:
         """
-        Get object from backend. Reimplemented to avoid circular imports.
-
-        Parameters
-        ----------
-        runtime : Runtime
-            Runtime object.
+        Get object from backend. Reimplemented to avoid
+        circular imports.
 
         Returns
         -------
         dict
             Task from backend.
         """
-        executable_kind = runtime.get_executable_kind()
+        executable_kind = get_executable_kind(self.kind)
         exec_string = f"{executable_kind}://{self.spec.task.split('://')[1]}"
 
         # Local backend

digitalhub-0.8.0b7/digitalhub/entities/run/_base/spec.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+from digitalhub.entities.task._base.models import K8s
+
+
+class RunSpec(Spec):
+    """RunSpec specifications."""
+
+    def __init__(
+        self,
+        task: str,
+        local_execution: bool = False,
+        function: str | None = None,
+        node_selector: dict | None = None,
+        volumes: list | None = None,
+        resources: dict | None = None,
+        affinity: dict | None = None,
+        tolerations: list | None = None,
+        envs: list | None = None,
+        secrets: list | None = None,
+        profile: str | None = None,
+        **kwargs,
+    ) -> None:
+        self.task = task
+        self.local_execution = local_execution
+        self.function = function
+        self.node_selector = node_selector
+        self.volumes = volumes
+        self.resources = resources
+        self.affinity = affinity
+        self.tolerations = tolerations
+        self.envs = envs
+        self.secrets = secrets
+        self.profile = profile
+
+
+class RunValidator(SpecValidator, K8s):
+    """
+    RunValidator validator.
+    """
+
+    function: str = None
+    """The function associated with the run."""
+
+    task: str = None
+    """The task string associated with the run."""
+
+    local_execution: bool = False
+    """Flag to indicate if the run will be executed locally."""

digitalhub-0.8.0b7/digitalhub/entities/run/_base/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.status import Status
+
+
+class RunStatus(Status):
+    """
+    RunStatus status.
+    """

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/secret/_base/builder.py

@@ -62,7 +62,7 @@ class SecretSecretBuilder(VersionedBuilder):
             description=description,
             labels=labels,
         )
-        path = f"kubernetes://dhcore-proj-secrets-{project}/{name}"
+        path = f"secret://{name}"
         provider = "kubernetes"
         spec = self.build_spec(
             path=path,

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/task/_base/builder.py

@@ -2,27 +2,21 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.entities._base.runtime_entity.builder import RuntimeEntityBuilder
 from digitalhub.entities._base.unversioned.builder import UnversionedBuilder
 from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.task._base.entity import Task
 
 
-class TaskBuilder(UnversionedBuilder):
+class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
     """
     Task builder.
     """
 
-    ACTION: str = None
     ENTITY_TYPE = EntityTypes.TASK.value
 
-    def __init__(self) -> None:
-        super().__init__()
-        if self.ACTION is None:
-            raise BuilderError("ACTION must be set")
-
     def build(
         self,
         project: str,

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/utils/utils.py

@@ -182,3 +182,21 @@ def build_log_path_from_source(
         path += f"/{Path(source).name}"
 
     return path
+
+
+def get_entity_type_from_key(key: str) -> str:
+    """
+    Get entity type.
+
+    Parameters
+    ----------
+    key : str
+        The key of the entity.
+
+    Returns
+    -------
+    str
+        The entity type.
+    """
+    _, entity_type, _, _, _ = parse_entity_key(key)
+    return entity_type

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/workflow/_base/builder.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.entities._base.runtime_entity.builder import RuntimeEntityBuilder
 from digitalhub.entities._base.versioned.builder import VersionedBuilder
 from digitalhub.entities.utils.entity_types import EntityTypes
 
@@ -9,7 +10,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.workflow._base.entity import Workflow
 
 
-class WorkflowBuilder(VersionedBuilder):
+class WorkflowBuilder(VersionedBuilder, RuntimeEntityBuilder):
     """
     Workflow builder.
     """

{digitalhub-0.8.0b5 → digitalhub-0.8.0b7}/digitalhub/entities/workflow/_base/entity.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.entities._base.executable.entity import ExecutableEntity
 from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.runtimes.utils import get_kind_registry
+from digitalhub.factory.api import get_run_kind, get_task_kind_from_action
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
@@ -60,12 +60,9 @@ class Workflow(ExecutableEntity):
         if action is None:
             action = "pipeline"
 
-        # Get kind registry
-        kind_reg = get_kind_registry(self.kind, self.project)
-
         # Get task and run kind
-        task_kind = kind_reg.get_task_kind_from_action(action=action)
-        run_kind = kind_reg.get_run_kind()
+        task_kind = get_task_kind_from_action(self.kind, action)
+        run_kind = get_run_kind(self.kind)
 
         # Create or update new task
         task = self._get_or_create_task(task_kind)