digitalhub 0.8.0b7__py3-none-any.whl → 0.8.0b10__py3-none-any.whl

digitalhub/entities/project/_base/entity.py

@@ -4,17 +4,17 @@ import typing
 from pathlib import Path
 from typing import Any
 
-from digitalhub.client.builder import get_client
-from digitalhub.context.builder import set_context
-from digitalhub.entities._base.crud import (
+from digitalhub.client.api import get_client
+from digitalhub.context.api import set_context
+from digitalhub.entities._base.api_utils import (
     create_entity_api_base,
     read_entity_api_base,
     read_entity_api_ctx,
     update_entity_api_base,
 )
+from digitalhub.entities._base.crud import import_context_entity, import_executable_entity
 from digitalhub.entities._base.entity.entity import Entity
 from digitalhub.entities.artifact.crud import (
-    artifact_from_dict,
     delete_artifact,
     get_artifact,
     get_artifact_versions,
@@ -25,7 +25,6 @@ from digitalhub.entities.artifact.crud import (
     update_artifact,
 )
 from digitalhub.entities.dataitem.crud import (
-    dataitem_from_dict,
     delete_dataitem,
     get_dataitem,
     get_dataitem_versions,
@@ -37,7 +36,6 @@ from digitalhub.entities.dataitem.crud import (
 )
 from digitalhub.entities.function.crud import (
     delete_function,
-    function_from_dict,
     get_function,
     get_function_versions,
     import_function,
@@ -52,7 +50,6 @@ from digitalhub.entities.model.crud import (
     import_model,
     list_models,
     log_model,
-    model_from_dict,
     new_model,
     update_model,
 )
@@ -75,8 +72,8 @@ from digitalhub.entities.workflow.crud import (
     list_workflows,
     new_workflow,
     update_workflow,
-    workflow_from_dict,
 )
+from digitalhub.factory.api import build_entity_from_dict
 from digitalhub.utils.exceptions import BackendError, EntityAlreadyExistsError, EntityError
 from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
@@ -95,31 +92,6 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.workflow._base.entity import Workflow
 
 
-ARTIFACTS = EntityTypes.ARTIFACT.value + "s"
-FUNCTIONS = EntityTypes.FUNCTION.value + "s"
-WORKFLOWS = EntityTypes.WORKFLOW.value + "s"
-DATAITEMS = EntityTypes.DATAITEM.value + "s"
-MODELS = EntityTypes.MODEL.value + "s"
-
-CTX_ENTITIES = [ARTIFACTS, FUNCTIONS, WORKFLOWS, DATAITEMS, MODELS]
-
-FROM_DICT_MAP = {
-    ARTIFACTS: artifact_from_dict,
-    FUNCTIONS: function_from_dict,
-    WORKFLOWS: workflow_from_dict,
-    DATAITEMS: dataitem_from_dict,
-    MODELS: model_from_dict,
-}
-
-IMPORT_MAP = {
-    ARTIFACTS: import_artifact,
-    FUNCTIONS: import_function,
-    WORKFLOWS: import_workflow,
-    DATAITEMS: import_dataitem,
-    MODELS: import_model,
-}
-
-
 class Project(Entity):
     """
     A class representing a project.
@@ -253,7 +225,7 @@ class Project(Entity):
             Updatated project object in dictionary format with referenced entities.
         """
         # Cycle over entity types
-        for entity_type in CTX_ENTITIES:
+        for entity_type in self._get_entity_types():
             # Entity types are stored as a list of entities
             for idx, entity in enumerate(obj.get("spec", {}).get(entity_type, [])):
                 # Export entity if not embedded is in metadata, else do nothing
@@ -262,7 +234,7 @@ class Project(Entity):
                     obj_dict: dict = read_entity_api_ctx(entity["key"])
 
                     # Create from dict (not need to new method, we do not save to backend)
-                    ent = FROM_DICT_MAP[entity_type](obj_dict)
+                    ent = build_entity_from_dict(obj_dict)
 
                     # Export and stor ref in object metadata inside project
                     pth = ent.export()
@@ -279,8 +251,10 @@ class Project(Entity):
         -------
         None
         """
+        entity_types = self._get_entity_types()
+
         # Cycle over entity types
-        for entity_type in CTX_ENTITIES:
+        for entity_type in entity_types:
             # Entity types are stored as a list of entities
             for entity in getattr(self.spec, entity_type, []):
                 entity_metadata = entity["metadata"]
@@ -292,7 +266,12 @@ class Project(Entity):
                     # Import entity from local ref
                     if map_uri_scheme(ref) == "local":
                         try:
-                            IMPORT_MAP[entity_type](ref)
+                            # Artifacts, Dataitems and Models
+                            if entity_type in entity_types[:3]:
+                                import_context_entity(ref)
+                            # Functions and Workflows
+                            elif entity_type in entity_types[3:]:
+                                import_executable_entity(ref)
                         except FileNotFoundError:
                             msg = f"File not found: {ref}."
                             raise EntityError(msg)
@@ -300,10 +279,54 @@ class Project(Entity):
                 # If entity is embedded, create it and try to save
                 elif embedded:
                     try:
-                        FROM_DICT_MAP[entity_type](entity).save()
+                        build_entity_from_dict(entity).save()
                     except EntityAlreadyExistsError:
                         pass
 
+    def _get_entity_types(self) -> list[str]:
+        """
+        Get entity types.
+
+        Returns
+        -------
+        list
+            Entity types.
+        """
+        return [
+            f"{EntityTypes.ARTIFACT.value}s",
+            f"{EntityTypes.DATAITEM.value}s",
+            f"{EntityTypes.MODEL.value}s",
+            f"{EntityTypes.FUNCTION.value}s",
+            f"{EntityTypes.WORKFLOW.value}s",
+        ]
+
+    def run(self, workflow: str | None = "main", **kwargs) -> Run:
+        """
+        Run workflow project.
+
+        Parameters
+        ----------
+        workflow : str
+            Workflow name.
+        **kwargs : dict
+            Keyword arguments passed to workflow.run().
+
+        Returns
+        -------
+        Run
+            Run instance.
+        """
+        self.refresh()
+        for i in self.spec.workflows:
+            if i["name"] == workflow or i["key"] == workflow:
+                workflow = build_entity_from_dict(i)
+                break
+        else:
+            msg = f"Workflow {workflow} not found."
+            raise EntityError(msg)
+
+        return workflow.run(**kwargs)
+
     ##############################
     #  Artifacts
     ##############################
@@ -2016,3 +2039,7 @@ class Project(Entity):
             **kwargs,
         )
         self.refresh()
+
+    ##############################
+    #  Project methods
+    ##############################

digitalhub/entities/project/crud.py

@@ -4,11 +4,11 @@ import importlib.util as imputil
 import typing
 from pathlib import Path
 
-from digitalhub.client.builder import build_client, get_client
-from digitalhub.context.builder import delete_context
-from digitalhub.entities._base.crud import delete_entity_api_base, read_entity_api_base, update_entity_api_base
-from digitalhub.entities.project.builder import project_from_dict, project_from_parameters
+from digitalhub.client.api import build_client, get_client
+from digitalhub.context.api import delete_context
+from digitalhub.entities._base.api_utils import delete_entity_api_base, read_entity_api_base, update_entity_api_base
 from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
 from digitalhub.utils.exceptions import BackendError, EntityError
 from digitalhub.utils.io_utils import read_yaml
 
@@ -63,7 +63,7 @@ def new_project(
     build_client(local, config)
     if context is None:
         context = name
-    obj = project_from_parameters(
+    obj = build_entity_from_params(
         name=name,
         kind="project",
         description=description,
@@ -112,7 +112,7 @@ def get_project(
     client = get_client(local)
     obj = read_entity_api_base(client, ENTITY_TYPE, name, **kwargs)
     obj["local"] = local
-    project = project_from_dict(obj)
+    project = build_entity_from_dict(obj)
     return _setup_project(project, setup_kwargs)
 
 
@@ -148,7 +148,7 @@ def import_project(
     build_client(local, config)
     dict_obj: dict = read_yaml(file)
     dict_obj["local"] = local
-    obj = project_from_dict(dict_obj)
+    obj = build_entity_from_dict(dict_obj)
     obj = _setup_project(obj, setup_kwargs)
 
     # Import related entities
@@ -278,7 +278,7 @@ def update_project(entity: Project, local: bool = False, **kwargs) -> Project:
     """
     client = get_client(local)
     obj = update_entity_api_base(client, ENTITY_TYPE, entity.name, entity.to_dict(), **kwargs)
-    return project_from_dict(obj)
+    return build_entity_from_dict(obj)
 
 
 def delete_project(

digitalhub/entities/run/_base/entity.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import time
 import typing
 
-from digitalhub.entities._base.crud import (
+from digitalhub.entities._base.api_utils import (
     list_entity_api_base,
     list_entity_api_ctx,
     logs_api,

digitalhub/entities/run/crud.py

@@ -2,12 +2,15 @@ from __future__ import annotations
 
 import typing
 
-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.run.builder import run_from_dict, run_from_parameters
+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 EntityAlreadyExistsError, EntityError
-from digitalhub.utils.io_utils import read_yaml
+from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.run._base.entity import Run
@@ -52,13 +55,11 @@ def new_run(
 
     Examples
     --------
-    >>> obj = new_function(project="my-project",
-    >>>                    name="my-function",
-    >>>                    kind="python+run",
-    >>>                    task="task-string"
+    >>> obj = new_run(project="my-project",
+    >>>               kind="python+run",
+    >>>               task="task-string")
     """
-    check_context(project)
-    obj = run_from_parameters(
+    return new_context_entity(
         project=project,
         kind=kind,
         uuid=uuid,
@@ -67,8 +68,6 @@ def new_run(
         local_execution=local_execution,
         **kwargs,
     )
-    obj.save()
-    return obj
 
 
 def get_run(
@@ -102,16 +101,12 @@ def get_run(
     >>> obj = get_run("my-run-id"
     >>>               project="my-project")
     """
-    if not identifier.startswith("store://") and project is None:
-        raise EntityError("Specify entity key or entity ID combined with project")
-    obj = read_entity_api_ctx(
+    return get_unversioned_entity(
         identifier,
-        ENTITY_TYPE,
+        entity_type=ENTITY_TYPE,
         project=project,
-        entity_id=identifier,
         **kwargs,
     )
-    return run_from_dict(obj)
 
 
 def list_runs(project: str, **kwargs) -> list[Run]:
@@ -135,12 +130,11 @@ 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
-    objs = list_entity_api_ctx(
+    return list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
-    return [run_from_dict(obj) for obj in objs]
 
 
 def import_run(file: str) -> Run:
@@ -161,14 +155,7 @@ def import_run(file: str) -> Run:
     -------
     >>> obj = import_run("my-run.yaml")
     """
-    dict_obj: dict = read_yaml(file)
-    obj = run_from_dict(dict_obj)
-    try:
-        obj.save()
-    except EntityAlreadyExistsError:
-        pass
-    finally:
-        return obj
+    return import_context_entity(file)
 
 
 def update_run(entity: Run) -> Run:
@@ -221,7 +208,7 @@ 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_api_ctx(
+    return delete_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/secret/_base/entity.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.crud import get_data_api, set_data_api
+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
 

digitalhub/entities/secret/crud.py

@@ -2,17 +2,17 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.context.builder import check_context
+from digitalhub.context.api import check_context
 from digitalhub.entities._base.crud import (
-    delete_entity_api_ctx,
-    list_entity_api_ctx,
-    read_entity_api_ctx,
-    read_entity_api_ctx_versions,
+    delete_entity,
+    get_context_entity_versions,
+    get_versioned_entity,
+    import_context_entity,
+    list_context_entities,
+    new_context_entity,
 )
-from digitalhub.entities.secret.builder import secret_from_dict, secret_from_parameters
 from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityNotExistsError
-from digitalhub.utils.io_utils import read_yaml
+from digitalhub.utils.exceptions import EntityNotExistsError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.secret._base.entity import Secret
@@ -68,8 +68,7 @@ def new_secret(
 
     if secret_value is None:
         raise ValueError("secret_value must be provided.")
-
-    obj = secret_from_parameters(
+    obj: Secret = new_context_entity(
         project=project,
         name=name,
         kind="secret",
@@ -79,7 +78,6 @@ def new_secret(
         embedded=embedded,
         **kwargs,
     )
-    obj.save()
     obj.set_secret_value(value=secret_value)
     return obj
 
@@ -127,14 +125,13 @@ def get_secret(
         else:
             raise EntityNotExistsError(f"Secret {identifier} not found.")
 
-    obj = read_entity_api_ctx(
+    return get_versioned_entity(
         identifier,
-        ENTITY_TYPE,
+        entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
         **kwargs,
     )
-    return secret_from_dict(obj)
 
 
 def get_secret_versions(
@@ -168,13 +165,12 @@ def get_secret_versions(
     >>> objs = get_secret_versions("my-secret-name",
     >>>                            project="my-project")
     """
-    obj = read_entity_api_ctx_versions(
+    return get_context_entity_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]:
@@ -197,12 +193,11 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     --------
     >>> objs = list_secrets(project="my-project")
     """
-    objs = list_entity_api_ctx(
+    return list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
-    return [secret_from_dict(obj) for obj in objs]
 
 
 def import_secret(file: str) -> Secret:
@@ -223,14 +218,7 @@ def import_secret(file: str) -> Secret:
     --------
     >>> obj = import_secret("my-secret.yaml")
     """
-    dict_obj: dict = read_yaml(file)
-    obj = secret_from_dict(dict_obj)
-    try:
-        obj.save()
-    except EntityAlreadyExistsError:
-        pass
-    finally:
-        return obj
+    return import_context_entity(file)
 
 
 def update_secret(entity: Secret) -> Secret:
@@ -292,7 +280,7 @@ def delete_secret(
     >>>                     project="my-project",
     >>>                     delete_all_versions=True)
     """
-    return delete_entity_api_ctx(
+    return delete_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/task/_base/entity.py

@@ -3,8 +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, run_from_parameters
+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
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -100,7 +101,7 @@ class Task(UnversionedEntity):
             Run object.
         """
         if kwargs["local_execution"]:
-            return run_from_parameters(**kwargs)
+            return build_entity_from_params(**kwargs)
         return new_run(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:

digitalhub/entities/task/crud.py

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