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

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,

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/entities/workflow/crud.py

@@ -2,17 +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,
-    read_entity_api_ctx_versions,
+    delete_entity,
+    get_context_entity_versions,
+    get_versioned_entity,
+    import_executable_entity,
+    list_context_entities,
+    new_context_entity,
 )
 from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.entities.workflow.builder import workflow_from_dict, workflow_from_parameters
-from digitalhub.utils.exceptions import EntityAlreadyExistsError
-from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.workflow._base.entity import Workflow
@@ -64,8 +62,7 @@ def new_workflow(
     >>>                    code_src="pipeline.py",
     >>>                    handler="pipeline-handler")
     """
-    check_context(project)
-    obj = workflow_from_parameters(
+    return new_context_entity(
         project=project,
         name=name,
         kind=kind,
@@ -75,8 +72,6 @@ def new_workflow(
         embedded=embedded,
         **kwargs,
     )
-    obj.save()
-    return obj
 
 
 def get_workflow(
@@ -114,14 +109,13 @@ def get_workflow(
     >>>                    project="my-project",
     >>>                    entity_id="my-workflow-id")
     """
-    obj = read_entity_api_ctx(
+    return get_versioned_entity(
         identifier,
-        ENTITY_TYPE,
+        entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
         **kwargs,
     )
-    return workflow_from_dict(obj)
 
 
 def get_workflow_versions(
@@ -155,13 +149,12 @@ def get_workflow_versions(
     >>> obj = get_workflow_versions("my-workflow-name"
     >>>                             project="my-project")
     """
-    obj = read_entity_api_ctx_versions(
+    return get_context_entity_versions(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         **kwargs,
     )
-    return [workflow_from_dict(o) for o in obj]
 
 
 def list_workflows(project: str, **kwargs) -> list[Workflow]:
@@ -184,12 +177,11 @@ def list_workflows(project: str, **kwargs) -> list[Workflow]:
     --------
     >>> objs = list_workflows(project="my-project")
     """
-    objs = list_entity_api_ctx(
+    return list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
-    return [workflow_from_dict(obj) for obj in objs]
 
 
 def import_workflow(file: str) -> Workflow:
@@ -210,25 +202,7 @@ def import_workflow(file: str) -> Workflow:
     --------
     >>> obj = import_workflow("my-workflow.yaml")
     """
-    dict_obj: dict | list[dict] = read_yaml(file)
-    if isinstance(dict_obj, list):
-        wkf_dict = dict_obj[0]
-        tsk_dicts = dict_obj[1:]
-    else:
-        wkf_dict = dict_obj
-        tsk_dicts = []
-
-    check_context(wkf_dict.get("project"))
-    obj = workflow_from_dict(wkf_dict)
-
-    obj.import_tasks(tsk_dicts)
-
-    try:
-        obj.save()
-    except EntityAlreadyExistsError:
-        pass
-    finally:
-        return obj
+    return import_executable_entity(file)
 
 
 def update_workflow(entity: Workflow) -> Workflow:
@@ -293,7 +267,7 @@ def delete_workflow(
     >>>                       project="my-project",
     >>>                       delete_all_versions=True)
     """
-    return delete_entity_api_ctx(
+    return delete_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/factory/api.py

@@ -13,22 +13,48 @@ if typing.TYPE_CHECKING:
     from digitalhub.runtimes._base import Runtime
 
 
-def build_entity(kind_to_build_from: str, *args, **kwargs) -> Entity:
+def build_entity_from_params(**kwargs) -> Entity:
     """
     Build an entity.
 
     Parameters
     ----------
-    kind_to_build_from : str
-        Entity type.
+    **kwargs
+        Entity parameters.
 
     Returns
     -------
     Entity
         Entity object.
     """
-    _raise_if_entity_builder_not_found(kind_to_build_from)
-    return factory.build_entity_from_params(kind_to_build_from, *args, **kwargs)
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    _raise_if_entity_builder_not_found(kind)
+    return factory.build_entity_from_params(kind, **kwargs)
+
+
+def build_entity_from_dict(obj: dict) -> Entity:
+    """
+    Build an entity from a dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary with entity data.
+
+    Returns
+    -------
+    Entity
+        Entity object.
+    """
+    try:
+        kind = obj["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    _raise_if_entity_builder_not_found(kind)
+    return factory.build_entity_from_dict(kind, obj)
 
 
 def build_spec(kind_to_build_from: str, **kwargs) -> Spec:
@@ -105,26 +131,6 @@ def build_runtime(kind_to_build_from: str, project: str) -> Runtime:
     return factory.build_runtime(kind_to_build_from, project)
 
 
-def build_entity_from_dict(kind_to_build_from: str, dict_data: dict) -> Entity:
-    """
-    Build an entity from a dictionary.
-
-    Parameters
-    ----------
-    kind_to_build_from : str
-        Entity type.
-    dict_data : dict
-        Dictionary with entity data.
-
-    Returns
-    -------
-    Entity
-        Entity object.
-    """
-    _raise_if_entity_builder_not_found(kind_to_build_from)
-    return factory.build_entity_from_dict(kind_to_build_from, dict_data)
-
-
 def get_entity_type_from_kind(kind: str) -> str:
     """
     Get entity type from builder.

digitalhub/factory/factory.py

@@ -62,23 +62,25 @@ class Factory:
             raise BuilderError(f"Builder {name} already exists.")
         self._runtime_builders[name] = builder()
 
-    def build_entity_from_params(self, kind_to_build_from: str, *args, **kwargs) -> Entity:
+    def build_entity_from_params(self, kind_to_build_from: str, **kwargs) -> Entity:
         """
-        Build an entity.
+        Build an entity from parameters.
 
         Parameters
         ----------
         kind_to_build_from : str
             Entity type.
+        **kwargs
+            Entity parameters.
 
         Returns
         -------
         Entity
             Entity object.
         """
-        return self._entity_builders[kind_to_build_from].build(*args, **kwargs)
+        return self._entity_builders[kind_to_build_from].build(**kwargs)
 
-    def build_entity_from_dict(self, kind_to_build_from: str, dict_data: dict) -> Entity:
+    def build_entity_from_dict(self, kind_to_build_from: str, obj: dict) -> Entity:
         """
         Build an entity from a dictionary.
 
@@ -94,7 +96,7 @@ class Factory:
         Entity
             Entity object.
         """
-        return self._entity_builders[kind_to_build_from].from_dict(dict_data)
+        return self._entity_builders[kind_to_build_from].from_dict(obj)
 
     def build_spec(self, kind_to_build_from: str, **kwargs) -> Spec:
         """

digitalhub/readers/_base/builder.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+import typing
+from abc import abstractmethod
+
+from digitalhub.utils.exceptions import BuilderError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.readers._base.reader import DataframeReader
+
+
+class ReaderBuilder:
+    ENGINE = None
+    DATAFRAME_CLASS = None
+
+    def __init__(self):
+        if self.ENGINE is None:
+            raise BuilderError("ENGINE must be set.")
+        if self.DATAFRAME_CLASS is None:
+            raise BuilderError("DATAFRAME_CLASS must be set.")
+
+    @abstractmethod
+    def build(self, **kwargs) -> DataframeReader:
+        """
+        Build reader object.
+        """

digitalhub/readers/api.py

@@ -0,0 +1,80 @@
+from __future__ import annotations
+
+import typing
+from typing import Any
+
+from digitalhub.readers.factory import factory
+
+if typing.TYPE_CHECKING:
+    from digitalhub.readers._base.reader import DataframeReader
+
+
+def get_reader_by_engine(engine: str | None = None) -> DataframeReader:
+    """
+    Get Dataframe reader.
+
+    Parameters
+    ----------
+    engine : str
+        Dataframe engine (pandas, polars, etc.).
+
+    Returns
+    -------
+    DataframeReader
+        Reader object.
+    """
+    if engine is None:
+        engine = factory.get_default()
+    try:
+        return factory.build(engine=engine)
+    except KeyError:
+        engines = factory.list_supported_engines()
+        msg = f"Unsupported dataframe engine: '{engine}'. Supported engines: {engines}"
+        raise ValueError(msg)
+
+
+def get_reader_by_object(obj: Any) -> DataframeReader:
+    """
+    Get Dataframe reader by object.
+
+    Parameters
+    ----------
+    obj : Any
+        Object to get reader from.
+
+    Returns
+    -------
+    DataframeReader
+        Reader object.
+    """
+    try:
+        obj_name = f"{obj.__class__.__module__}.{obj.__class__.__name__}"
+        return factory.build(dataframe=obj_name)
+    except KeyError:
+        types = factory.list_supported_dataframes()
+        msg = f"Unsupported dataframe type: '{obj}'. Supported types: {types}"
+        raise ValueError(msg)
+
+
+def get_supported_engines() -> list[str]:
+    """
+    Get supported engines.
+
+    Returns
+    -------
+    list
+        List of supported engines.
+    """
+    return factory.list_supported_engines()
+
+
+def get_supported_dataframes() -> list[str]:
+    """
+    Get supported dataframes.
+
+    Returns
+    -------
+    list
+        List of supported dataframes.
+    """
+    return factory.list_supported_dataframes()