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

digitalhub/entities/run/status.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.status.base import Status
+from digitalhub.entities.artifact.crud import get_artifact
+from digitalhub.entities.utils import parse_entity_key
+
+if typing.TYPE_CHECKING:
+    pass
+
+ENTITY_FUNC = {
+    "artifacts": get_artifact,
+}
+
+
+class RunStatus(Status):
+    """
+    Status class for run entities.
+    """
+
+    def __init__(
+        self,
+        state: str,
+        message: str | None = None,
+        outputs: list | None = None,
+        results: dict | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(state, message)
+        self.outputs = outputs
+        self.results = results
+
+        self._any_setter(**kwargs)
+
+    def get_results(self) -> dict:
+        """
+        Get results.
+
+        Returns
+        -------
+        dict
+            The results.
+        """
+        if not hasattr(self, "results") or self.results is None:
+            return {}
+        return self.results
+
+    def get_outputs(self, as_key: bool = False, as_dict: bool = False) -> dict:
+        """
+        Get outputs.
+
+        Parameters
+        ----------
+        as_key : bool
+            If True, return outputs as keys.
+        as_dict : bool
+            If True, return outputs as dictionaries.
+
+        Returns
+        -------
+        dict
+            The outputs.
+        """
+        outputs = {}
+        if not hasattr(self, "outputs") or self.outputs is None:
+            return outputs
+
+        for parameter, key in self.outputs.items():
+            entity_type = self._get_entity_type(key)
+            entity = ENTITY_FUNC[entity_type](key)
+            if as_key:
+                entity = entity.key
+            if as_dict:
+                entity = entity.to_dict()
+            outputs[parameter] = entity
+
+        return outputs
+
+    @staticmethod
+    def _get_entity_type(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
+
+    def get_values(self, values_list: list) -> dict:
+        """
+        Get values.
+
+        Parameters
+        ----------
+        values_list : list
+            The values list to search in.
+
+        Returns
+        -------
+        dict
+            The values.
+        """
+        if not hasattr(self, "results") or self.results is None:
+            return {}
+        return {k: v for k, v in self.get_results().items() if k in values_list}

digitalhub/entities/secret/builder.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+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.secret.entity import Secret
+
+
+def secret_from_parameters(
+    project: str,
+    name: str,
+    kind: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = True,
+    **kwargs,
+) -> Secret:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    labels : list[str]
+        List of labels.
+    description : str
+        Description of the object (human readable).
+    embedded : bool
+        Flag to determine if object spec must be embedded in project spec.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+    """
+    name = build_name(name)
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind,
+        project=project,
+        name=name,
+        version=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+    )
+    path = f"kubernetes://dhcore-proj-secrets-{project}/{name}"
+    provider = "kubernetes"
+    spec = build_spec(
+        kind,
+        path=path,
+        provider=provider,
+        **kwargs,
+    )
+    status = build_status(kind)
+    return Secret(
+        project=project,
+        name=name,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def secret_from_dict(obj: dict) -> Secret:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+    """
+    return Secret.from_dict(obj)

digitalhub/entities/secret/crud.py

@@ -2,20 +2,20 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.context.api import check_context
+from digitalhub.context.builder 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,
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_ctx,
+    read_entity_api_ctx_versions,
 )
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.utils.exceptions import EntityNotExistsError
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.secret.builder import secret_from_dict, secret_from_parameters
+from digitalhub.utils.exceptions import EntityAlreadyExistsError
+from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.secret._base.entity import Secret
+    from digitalhub.entities.secret.entity import Secret
 
 
 ENTITY_TYPE = EntityTypes.SECRET.value
@@ -27,7 +27,7 @@ def new_secret(
     uuid: str | None = None,
     description: str | None = None,
     labels: list[str] | None = None,
-    embedded: bool = False,
+    embedded: bool = True,
     secret_value: str | None = None,
     **kwargs,
 ) -> Secret:
@@ -41,7 +41,7 @@ def new_secret(
     name : str
         Object name.
     uuid : str
-        ID of the object.
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
     description : str
         Description of the object (human readable).
     labels : list[str]
@@ -68,7 +68,8 @@ def new_secret(
 
     if secret_value is None:
         raise ValueError("secret_value must be provided.")
-    obj: Secret = new_context_entity(
+
+    obj = secret_from_parameters(
         project=project,
         name=name,
         kind="secret",
@@ -78,6 +79,7 @@ def new_secret(
         embedded=embedded,
         **kwargs,
     )
+    obj.save()
     obj.set_secret_value(value=secret_value)
     return obj
 
@@ -117,21 +119,14 @@ def get_secret(
     >>>                  project="my-project",
     >>>                  entity_id="my-secret-id")
     """
-    if not identifier.startswith("store://"):
-        secrets = list_secrets(project=project, **kwargs)
-        for secret in secrets:
-            if secret.name == identifier:
-                return secret
-        else:
-            raise EntityNotExistsError(f"Secret {identifier} not found.")
-
-    return get_versioned_entity(
+    obj = read_entity_api_ctx(
         identifier,
-        entity_type=ENTITY_TYPE,
+        ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
         **kwargs,
     )
+    return secret_from_dict(obj)
 
 
 def get_secret_versions(
@@ -165,12 +160,13 @@ def get_secret_versions(
     >>> objs = get_secret_versions("my-secret-name",
     >>>                            project="my-project")
     """
-    return get_context_entity_versions(
+    obj = read_entity_api_ctx_versions(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         **kwargs,
     )
+    return [secret_from_dict(o) for o in obj]
 
 
 def list_secrets(project: str, **kwargs) -> list[Secret]:
@@ -193,11 +189,12 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     --------
     >>> objs = list_secrets(project="my-project")
     """
-    return list_context_entities(
+    objs = list_entity_api_ctx(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
+    return [secret_from_dict(obj) for obj in objs]
 
 
 def import_secret(file: str) -> Secret:
@@ -218,7 +215,14 @@ def import_secret(file: str) -> Secret:
     --------
     >>> obj = import_secret("my-secret.yaml")
     """
-    return import_context_entity(file)
+    dict_obj: dict = read_yaml(file)
+    obj = secret_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    finally:
+        return obj
 
 
 def update_secret(entity: Secret) -> Secret:
@@ -280,7 +284,7 @@ def delete_secret(
     >>>                     project="my-project",
     >>>                     delete_all_versions=True)
     """
-    return delete_entity(
+    return delete_entity_api_ctx(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

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

@@ -2,14 +2,14 @@ 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._base.crud import get_data_api, set_data_api
+from digitalhub.entities._base.entity.versioned import VersionedEntity
+from digitalhub.entities.entity_types import EntityTypes
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.entity.metadata import Metadata
-    from digitalhub.entities.secret._base.spec import SecretSpec
-    from digitalhub.entities.secret._base.status import SecretStatus
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.secret.spec import SecretSpec
+    from digitalhub.entities.secret.status import SecretStatus
 
 
 class Secret(VersionedEntity):
@@ -70,5 +70,4 @@ class Secret(VersionedEntity):
             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)
-        return data[self.name]
+        return get_data_api(self.project, self.ENTITY_TYPE, params=params)

digitalhub/entities/secret/{_base/spec.py → spec.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 SecretSpec(Spec):
     """
-    SecretSpec specifications.
+    Secret specifications.
     """
 
     def __init__(self, path: str | None = None, provider: str | None = None, **kwargs) -> None:
@@ -23,9 +23,9 @@ class SecretSpec(Spec):
         self.provider = provider
 
 
-class SecretValidator(SpecValidator):
+class SecretParams(SpecParams):
     """
-    SecretValidator validator.
+    Secret parameters.
     """
 
     path: str = None

digitalhub/entities/secret/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.status.base import Status
+
+
+class SecretStatus(Status):
+    """
+    Status class for secret entities.
+    """

digitalhub/entities/task/builder.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+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.entities.task.entity import Task
+
+
+def task_from_parameters(
+    project: str,
+    kind: str,
+    uuid: str | None = None,
+    labels: list[str] | None = None,
+    function: str | None = None,
+    **kwargs,
+) -> Task:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    labels : list[str]
+        List of labels.
+    function : str
+        Name of the executable associated with the task.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Task
+        Object instance.
+    """
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind=kind,
+        project=project,
+        name=uuid,
+        labels=labels,
+    )
+    spec = build_spec(kind, function=function, **kwargs)
+    status = build_status(kind)
+    return Task(
+        project=project,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def task_from_dict(obj: dict) -> Task:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary representation of Task.
+
+    Returns
+    -------
+    Task
+        Object instance.
+    """
+    return Task.from_dict(obj)

digitalhub/entities/task/crud.py

@@ -2,18 +2,15 @@ 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.utils.exceptions import EntityError
+from digitalhub.context.builder import check_context
+from digitalhub.entities._base.crud import delete_entity_api_ctx, list_entity_api_ctx, read_entity_api_ctx
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.task.builder import task_from_dict, task_from_parameters
+from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
+from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.task._base.entity import Task
+    from digitalhub.entities.task.entity import Task
 
 
 ENTITY_TYPE = EntityTypes.TASK.value
@@ -37,7 +34,7 @@ def new_task(
     kind : str
         Kind the object.
     uuid : str
-        ID of the object.
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
     labels : list[str]
         List of labels.
     function : str
@@ -52,11 +49,13 @@ def new_task(
 
     Examples
     --------
-    >>> obj = new_task(project="my-project",
-    >>>                kind="python+job",
-    >>>                function="function-string")
+    >>> obj = new_function(project="my-project",
+    >>>                    name="my-function",
+    >>>                    kind="python+task",
+    >>>                    task="task-string"
     """
-    return new_context_entity(
+    check_context(project)
+    obj = task_from_parameters(
         project=project,
         kind=kind,
         uuid=uuid,
@@ -64,6 +63,8 @@ def new_task(
         function=function,
         **kwargs,
     )
+    obj.save()
+    return obj
 
 
 def get_task(
@@ -97,12 +98,16 @@ def get_task(
     >>> obj = get_task("my-task-id"
     >>>               project="my-project")
     """
-    return get_unversioned_entity(
+    if not identifier.startswith("store://"):
+        raise EntityError("Task has no name. Use key instead.")
+    obj = read_entity_api_ctx(
         identifier,
-        entity_type=ENTITY_TYPE,
+        ENTITY_TYPE,
         project=project,
+        entity_id=identifier,
         **kwargs,
     )
+    return task_from_dict(obj)
 
 
 def list_tasks(project: str, **kwargs) -> list[Task]:
@@ -125,11 +130,12 @@ def list_tasks(project: str, **kwargs) -> list[Task]:
     --------
     >>> objs = list_tasks(project="my-project")
     """
-    return list_context_entities(
+    objs = list_entity_api_ctx(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
+    return [task_from_dict(obj) for obj in objs]
 
 
 def import_task(file: str) -> Task:
@@ -150,7 +156,14 @@ def import_task(file: str) -> Task:
     -------
     >>> obj = import_task("my-task.yaml")
     """
-    return import_context_entity(file)
+    dict_obj: dict = read_yaml(file)
+    obj = task_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    finally:
+        return obj
 
 
 def update_task(entity: Task) -> Task:
@@ -217,7 +230,7 @@ def delete_task(
     """
     if not identifier.startswith("store://"):
         raise EntityError("Task has no name. Use key instead.")
-    return delete_entity(
+    return delete_entity_api_ctx(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

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

@@ -2,16 +2,15 @@ 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._base.entity.unversioned import UnversionedEntity
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.run.crud import delete_run, get_run, new_run, run_from_parameters
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.entity.metadata import Metadata
-    from digitalhub.entities.run._base.entity import Run
-    from digitalhub.entities.task._base.spec import TaskSpec
-    from digitalhub.entities.task._base.status import TaskStatus
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.run.entity import Run
+    from digitalhub.entities.task.spec import TaskSpec
+    from digitalhub.entities.task.status import TaskStatus
 
 
 class Task(UnversionedEntity):
@@ -101,7 +100,7 @@ class Task(UnversionedEntity):
             Run object.
         """
         if kwargs["local_execution"]:
-            return build_entity_from_params(**kwargs)
+            return run_from_parameters(**kwargs)
         return new_run(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:

digitalhub/entities/task/{_base/models.py → models.py}

@@ -197,12 +197,3 @@ class K8s(BaseModel):
 
     profile: str = None
     """Profile template."""
-
-
-class CorePort(BaseModel):
-    """
-    Port mapper model.
-    """
-
-    port: int
-    target_port: int

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

@@ -1,19 +1,17 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.entity.spec import Spec, SpecValidator
-from digitalhub.entities.task._base.models import K8s
+from digitalhub.entities._base.spec.base import Spec, SpecParams
+from digitalhub.entities.task.models import K8s
 
 
 class TaskSpec(Spec):
-    """TaskSpec specifications."""
+    """Task specification."""
 
     def __init__(self, function: str) -> None:
         self.function = function
 
 
 class TaskSpecK8s(TaskSpec):
-    """TaskSpecK8s specifications."""
-
     def __init__(
         self,
         function: str,
@@ -38,16 +36,16 @@ class TaskSpecK8s(TaskSpec):
         self.profile = profile
 
 
-class TaskValidator(SpecValidator):
+class TaskParams(SpecParams):
     """
-    TaskValidator validator.
+    Base task model.
     """
 
     function: str
     """Function string."""
 
 
-class TaskValidatorK8s(TaskValidator, K8s):
+class TaskParamsK8s(TaskParams, K8s):
     """
-    TaskValidatorK8s validator.
+    Kubernetes task model.
     """