digitalhub 0.8.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

digitalhub/entities/run/crud.py

@@ -2,14 +2,8 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.crud import (
-    delete_entity,
-    get_unversioned_entity,
-    import_context_entity,
-    list_context_entities,
-    new_context_entity,
-)
-from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._operations.processor import processor
 from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
@@ -59,7 +53,7 @@ def new_run(
     >>>               kind="python+run",
     >>>               task="task-string")
     """
-    return new_context_entity(
+    return processor.create_context_entity(
         project=project,
         kind=kind,
         uuid=uuid,
@@ -101,7 +95,7 @@ def get_run(
     >>> obj = get_run("my-run-id"
     >>>               project="my-project")
     """
-    return get_unversioned_entity(
+    return processor.read_unversioned_entity(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -130,7 +124,7 @@ def list_runs(project: str, **kwargs) -> list[Run]:
     >>> objs = list_runs(project="my-project")
     """
     # TODO more examples: search by function, latest for task and function
-    return list_context_entities(
+    return processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -139,7 +133,7 @@ def list_runs(project: str, **kwargs) -> list[Run]:
 
 def import_run(file: str) -> Run:
     """
-    Get object from file.
+    Import object from a YAML file and create a new object into the backend.
 
     Parameters
     ----------
@@ -155,7 +149,28 @@ def import_run(file: str) -> Run:
     -------
     >>> obj = import_run("my-run.yaml")
     """
-    return import_context_entity(file)
+    return processor.import_context_entity(file)
+
+
+def load_run(file: str) -> Run:
+    """
+    Load object from a YAML file and update an existing object into the backend.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Run
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = load_run("my-run.yaml")
+    """
+    return processor.load_context_entity(file)
 
 
 def update_run(entity: Run) -> Run:
@@ -176,7 +191,12 @@ def update_run(entity: Run) -> Run:
     --------
     >>> obj = update_run(obj)
     """
-    return entity.save(update=True)
+    return processor.update_context_entity(
+        project=entity.project,
+        entity_type=entity.ENTITY_TYPE,
+        entity_id=entity.id,
+        entity_dict=entity.to_dict(),
+    )
 
 
 def delete_run(
@@ -208,12 +228,10 @@ def delete_run(
     """
     if not identifier.startswith("store://") and project is None:
         raise EntityError("Specify entity key or entity ID combined with project")
-    return delete_entity(
+    return processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         entity_id=identifier,
         **kwargs,
     )
-
-    # TODO read logs

digitalhub/entities/secret/_base/builder.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
 from digitalhub.entities._base.versioned.builder import VersionedBuilder
+from digitalhub.entities._commons.enums import EntityKinds, EntityTypes
 from digitalhub.entities.secret._base.entity import Secret
 from digitalhub.entities.secret._base.spec import SecretSpec, SecretValidator
 from digitalhub.entities.secret._base.status import SecretStatus
-from digitalhub.entities.utils.entity_types import EntityTypes
 
 
 class SecretSecretBuilder(VersionedBuilder):
@@ -17,7 +17,7 @@ class SecretSecretBuilder(VersionedBuilder):
     ENTITY_SPEC_CLASS = SecretSpec
     ENTITY_SPEC_VALIDATOR = SecretValidator
     ENTITY_STATUS_CLASS = SecretStatus
-    ENTITY_KIND = "secret"
+    ENTITY_KIND = EntityKinds.SECRET_SECRET.value
 
     def build(
         self,

digitalhub/entities/secret/_base/entity.py

@@ -2,9 +2,9 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.api_utils import get_data_api, set_data_api
 from digitalhub.entities._base.versioned.entity import VersionedEntity
-from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._operations.processor import processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -51,11 +51,8 @@ class Secret(VersionedEntity):
         -------
         None
         """
-        if self._context().local:
-            raise NotImplementedError("set_secret() is not implemented for local projects.")
-
         obj = {self.name: value}
-        set_data_api(self.project, self.ENTITY_TYPE, obj)
+        processor.update_secret_data(self.project, self.ENTITY_TYPE, obj)
 
     def read_secret_value(self) -> dict:
         """
@@ -66,9 +63,6 @@ class Secret(VersionedEntity):
         str
             Value of the secret.
         """
-        if self._context().local:
-            raise NotImplementedError("read_secret() is not implemented for local projects.")
-
         params = {"keys": self.name}
-        data = get_data_api(self.project, self.ENTITY_TYPE, params=params)
+        data = processor.read_secret_data(self.project, self.ENTITY_TYPE, params=params)
         return data[self.name]

digitalhub/entities/secret/crud.py

@@ -2,16 +2,8 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.context.api import check_context
-from digitalhub.entities._base.crud import (
-    delete_entity,
-    get_context_entity_versions,
-    get_versioned_entity,
-    import_context_entity,
-    list_context_entities,
-    new_context_entity,
-)
-from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._operations.processor import processor
 from digitalhub.utils.exceptions import EntityNotExistsError
 
 if typing.TYPE_CHECKING:
@@ -64,11 +56,9 @@ def new_secret(
     >>>                  name="my-secret",
     >>>                  secret_value="my-secret-value")
     """
-    check_context(project)
-
     if secret_value is None:
         raise ValueError("secret_value must be provided.")
-    obj: Secret = new_context_entity(
+    obj: Secret = processor.create_context_entity(
         project=project,
         name=name,
         kind="secret",
@@ -124,8 +114,7 @@ def get_secret(
                 return secret
         else:
             raise EntityNotExistsError(f"Secret {identifier} not found.")
-
-    return get_versioned_entity(
+    return processor.read_context_entity(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -165,7 +154,7 @@ def get_secret_versions(
     >>> objs = get_secret_versions("my-secret-name",
     >>>                            project="my-project")
     """
-    return get_context_entity_versions(
+    return processor.read_context_entity_versions(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -193,7 +182,7 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     --------
     >>> objs = list_secrets(project="my-project")
     """
-    return list_context_entities(
+    return processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -202,7 +191,7 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
 
 def import_secret(file: str) -> Secret:
     """
-    Import object from a YAML file.
+    Import object from a YAML file and create a new object into the backend.
 
     Parameters
     ----------
@@ -218,7 +207,28 @@ def import_secret(file: str) -> Secret:
     --------
     >>> obj = import_secret("my-secret.yaml")
     """
-    return import_context_entity(file)
+    return processor.import_context_entity(file)
+
+
+def load_secret(file: str) -> Secret:
+    """
+    Load object from a YAML file and update an existing object into the backend.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = load_secret("my-secret.yaml")
+    """
+    return processor.load_context_entity(file)
 
 
 def update_secret(entity: Secret) -> Secret:
@@ -239,7 +249,12 @@ def update_secret(entity: Secret) -> Secret:
     --------
     >>> obj = update_secret(obj)
     """
-    return entity.save(update=True)
+    return processor.update_context_entity(
+        project=entity.project,
+        entity_type=entity.ENTITY_TYPE,
+        entity_id=entity.id,
+        entity_dict=entity.to_dict(),
+    )
 
 
 def delete_secret(
@@ -280,7 +295,7 @@ def delete_secret(
     >>>                     project="my-project",
     >>>                     delete_all_versions=True)
     """
-    return delete_entity(
+    return processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/task/_base/builder.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.entities._base.runtime_entity.builder import EntityError, RuntimeEntityBuilder
 from digitalhub.entities._base.unversioned.builder import UnversionedBuilder
-from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities._commons.enums import EntityTypes
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.task._base.entity import Task
@@ -23,7 +23,6 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
         kind: str,
         uuid: str | None = None,
         labels: list[str] | None = None,
-        function: str | None = None,
         **kwargs,
     ) -> Task:
         """
@@ -39,8 +38,6 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
             ID of the object.
         labels : list[str]
             List of labels.
-        function : str
-            Name of the executable associated with the task.
         **kwargs : dict
             Spec keyword arguments.
 
@@ -49,10 +46,14 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
         Task
             Object instance.
         """
-        if function is None:
-            raise EntityError("function must be provided")
+        # Check executable kind validity
+        fnc = kwargs.get("function", None)
+        wkf = kwargs.get("workflow", None)
+        executable = fnc if fnc is not None else wkf
+        if executable is None:
+            raise EntityError("Function or workflow must be provided")
+        self._check_kind_validity(executable)
 
-        self._check_kind_validity(function)
         uuid = self.build_uuid(uuid)
         metadata = self.build_metadata(
             project=project,
@@ -60,7 +61,6 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
             labels=labels,
         )
         spec = self.build_spec(
-            function=function,
             **kwargs,
         )
         status = self.build_status()
@@ -73,19 +73,19 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
             status=status,
         )
 
-    def _check_kind_validity(self, function: str) -> None:
+    def _check_kind_validity(self, executable: str) -> None:
         """
         Check kind validity.
 
         Parameters
         ----------
-        function : str
-            Function string.
+        executable : str
+            Executable string.
 
         Returns
         -------
         None
         """
-        function_kind = function.split("://")[0]
-        if self.EXECUTABLE_KIND != function_kind:
-            raise EntityError(f"Invalid task '{self.ENTITY_KIND}' for function kind '{function_kind}'")
+        exec_kind = executable.split("://")[0]
+        if self.EXECUTABLE_KIND != exec_kind:
+            raise EntityError(f"Invalid task '{self.ENTITY_KIND}' for executable kind '{exec_kind}'")

digitalhub/entities/task/_base/entity.py

@@ -3,9 +3,9 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
-from digitalhub.entities.run.crud import delete_run, get_run, new_run
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.factory.api import build_entity_from_params
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._operations.processor import processor
+from digitalhub.factory.api import build_entity_from_params, get_entity_type_from_kind, get_executable_kind
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -42,6 +42,7 @@ class Task(UnversionedEntity):
     def run(
         self,
         run_kind: str,
+        save: bool = True,
         local_execution: bool = False,
         **kwargs,
     ) -> Run:
@@ -62,7 +63,11 @@ class Task(UnversionedEntity):
         Run
             Run object.
         """
+        exec_kind = get_executable_kind(self.kind)
+        exec_type = get_entity_type_from_kind(exec_kind)
+        kwargs[exec_type] = getattr(self.spec, exec_type)
         return self.new_run(
+            save=save,
             project=self.project,
             task=self._get_task_string(),
             kind=run_kind,
@@ -79,30 +84,31 @@ class Task(UnversionedEntity):
         str
             Task string.
         """
-        splitted = self.spec.function.split("://")
-        return f"{self.kind}://{splitted[1]}"
+        return f"{self.kind}://{self.project}/{self.id}"
 
     ##############################
     # CRUD Methods for Run
     ##############################
 
-    def new_run(self, **kwargs) -> Run:
+    def new_run(self, save: bool = True, **kwargs) -> Run:
         """
         Create a new run.
 
         Parameters
         ----------
+        save : bool
+            Flag to indicate save.
         **kwargs : dict
-            Keyword arguments.
+            Keyword arguments to build run. See new_run().
 
         Returns
         -------
         Run
             Run object.
         """
-        if kwargs["local_execution"]:
-            return build_entity_from_params(**kwargs)
-        return new_run(**kwargs)
+        if save:
+            return processor.create_context_entity(**kwargs)
+        return build_entity_from_params(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:
         """
@@ -118,9 +124,9 @@ class Task(UnversionedEntity):
         Run
             Run object.
         """
-        return get_run(entity_key)
+        return processor.read_context_entity(entity_key)
 
-    def delete_run(self, entity_key: str) -> None:
+    def delete_run(self, entity_key: str) -> dict:
         """
         Delete run.
 
@@ -131,6 +137,7 @@ class Task(UnversionedEntity):
 
         Returns
         -------
-        None
+        dict
+            Response from backend.
         """
-        delete_run(entity_key)
+        return processor.delete_context_entity(entity_key)

digitalhub/entities/task/_base/models.py

@@ -1,7 +1,17 @@
 from __future__ import annotations
 
-from pydantic import BaseModel, Field
-from typing_extensions import Literal
+from enum import Enum
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class VolumeType(Enum):
+    """
+    Volume type.
+    """
+
+    PERSISTENT_VOLUME_CLAIM = "persistent_volume_claim"
+    EMPTY_DIR = "empty_dir"
 
 
 class Volume(BaseModel):
@@ -9,7 +19,9 @@ class Volume(BaseModel):
     Volume model.
     """
 
-    volume_type: Literal["persistent_volume_claim", "empty_dir"]
+    model_config = ConfigDict(use_enum_values=True)
+
+    volume_type: VolumeType
     """Volume type."""
 
     name: str
@@ -18,7 +30,7 @@ class Volume(BaseModel):
     mount_path: str
     """Volume mount path inside the container."""
 
-    spec: dict[str, str]
+    spec: dict[str, str] = None
     """Volume spec."""
 
 
@@ -39,10 +51,10 @@ class ResourceItem(BaseModel):
     Resource item model.
     """
 
-    requests: str = Field(default=None, regex=r"[\d]+|^([0-9])+([a-zA-Z])+$")
+    requests: str = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
     """Resource requests."""
 
-    limits: str = Field(default=None, regex=r"[\d]+|^([0-9])+([a-zA-Z])+$")
+    limits: str = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
     """Resource limits."""
 
 
@@ -198,6 +210,12 @@ class K8s(BaseModel):
     profile: str = None
     """Profile template."""
 
+    runtime_class: str = None
+    """Runtime class name."""
+
+    priority_class: str = None
+    """Priority class."""
+
 
 class CorePort(BaseModel):
     """
@@ -206,3 +224,14 @@ class CorePort(BaseModel):
 
     port: int
     target_port: int
+
+
+class CoreServiceType(Enum):
+    """
+    CoreServiceType enum.
+    """
+
+    EXTERNAL_NAME = "ExternalName"
+    CLUSTER_IP = "ClusterIP"
+    NODE_PORT = "NodePort"
+    LOAD_BALANCER = "LoadBalancer"

digitalhub/entities/task/_base/spec.py

@@ -7,27 +7,57 @@ from digitalhub.entities.task._base.models import K8s
 class TaskSpec(Spec):
     """TaskSpec specifications."""
 
-    def __init__(self, function: str) -> None:
+
+class TaskSpecFunction(TaskSpec):
+    """TaskSpecFunction specifications."""
+
+    def __init__(
+        self,
+        function: str,
+        node_selector: list[dict] | None = None,
+        volumes: list[dict] | None = None,
+        resources: dict | None = None,
+        affinity: dict | None = None,
+        tolerations: list[dict] | None = None,
+        envs: list[dict] | None = None,
+        secrets: list[str] | None = None,
+        profile: str | None = None,
+        runtime_class: str | None = None,
+        priority_class: str | None = None,
+        **kwargs,
+    ) -> None:
         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
+        self.runtime_class = runtime_class
+        self.priority_class = priority_class
 
 
-class TaskSpecK8s(TaskSpec):
-    """TaskSpecK8s specifications."""
+class TaskSpecWorkflow(TaskSpec):
+    """TaskSpecWorkflow specifications."""
 
     def __init__(
         self,
-        function: str,
-        node_selector: dict | None = None,
-        volumes: list | None = None,
+        workflow: str,
+        node_selector: list[dict] | None = None,
+        volumes: list[dict] | None = None,
         resources: dict | None = None,
         affinity: dict | None = None,
-        tolerations: list | None = None,
-        envs: list | None = None,
-        secrets: list | None = None,
+        tolerations: list[dict] | None = None,
+        envs: list[dict] | None = None,
+        secrets: list[str] | None = None,
         profile: str | None = None,
+        runtime_class: str | None = None,
+        priority_class: str | None = None,
         **kwargs,
     ) -> None:
-        super().__init__(function)
+        self.workflow = workflow
         self.node_selector = node_selector
         self.volumes = volumes
         self.resources = resources
@@ -43,11 +73,18 @@ class TaskValidator(SpecValidator):
     TaskValidator validator.
     """
 
+
+class TaskValidatorFunction(TaskValidator, K8s):
+    """
+    TaskValidatorFunction validator.
+    """
+
     function: str
-    """Function string."""
 
 
-class TaskValidatorK8s(TaskValidator, K8s):
+class TaskValidatorWorkflow(TaskValidator, K8s):
     """
-    TaskValidatorK8s validator.
+    TaskValidatorWorkflow validator.
     """
+
+    workflow: str

digitalhub/entities/task/_base/utils.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+
+def build_task_actions(kind_action_list: list[tuple[str, str]]) -> dict[str, str]:
+    """
+    Build task actions.
+
+    Parameters
+    ----------
+    kind_action_list : list[tuple[str, str]]
+        List of kind-action couples.
+
+    Returns
+    -------
+    dict[str, str]
+        Returns the task actions.
+    """
+    return [{"kind": kind, "action": action} for (kind, action) in kind_action_list]