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

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()

digitalhub/readers/factory.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+
+import typing
+
+if typing.TYPE_CHECKING:
+    from digitalhub.readers._base.builder import ReaderBuilder
+    from digitalhub.readers._base.reader import DataframeReader
+
+
+class ReaderFactory:
+    """
+    Reader factory class.
+    """
+
+    def __init__(self) -> None:
+        self._engine_builders: dict[str, ReaderBuilder] = None
+        self._dataframe_builders: dict[str, ReaderBuilder] = None
+        self._default: str = None
+
+    def add_builder(self, engine: str, dataframe: str, builder: ReaderBuilder) -> None:
+        """
+        Add a builder to the factory.
+
+        Parameters
+        ----------
+        name : str
+            Reader name.
+        builder : DataframeReader
+            Builder object.
+
+        Returns
+        -------
+        None
+        """
+        if self._engine_builders is None:
+            self._engine_builders = {}
+        if engine in self._engine_builders:
+            raise ValueError(f"Engine {engine} already exists.")
+        self._engine_builders[engine] = builder
+
+        if self._dataframe_builders is None:
+            self._dataframe_builders = {}
+        if dataframe in self._dataframe_builders:
+            raise ValueError(f"Dataframe {dataframe} already exists.")
+        self._dataframe_builders[dataframe] = builder
+
+    def build(self, engine: str | None = None, dataframe: str | None = None, **kwargs) -> DataframeReader:
+        """
+        Build reader object.
+
+        Parameters
+        ----------
+        engine : str | None
+            Engine name.
+        dataframe : str | None
+            Dataframe name.
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        DataframeReader
+            Reader object.
+        """
+        if (engine is None) == (dataframe is None):
+            raise ValueError("Either engine or dataframe must be provided.")
+        if engine is not None:
+            return self._engine_builders[engine].build(**kwargs)
+        return self._dataframe_builders[dataframe].build(**kwargs)
+
+    def list_supported_engines(self) -> list[str]:
+        """
+        List supported engines.
+
+        Returns
+        -------
+        list[str]
+            List of supported engines.
+        """
+        return list(self._engine_builders.keys())
+
+    def list_supported_dataframes(self) -> list[str]:
+        """
+        List supported dataframes.
+
+        Returns
+        -------
+        list[str]
+            List of supported dataframes.
+        """
+        return list(self._dataframe_builders.keys())
+
+    def set_default(self, engine: str) -> None:
+        """
+        Set default engine.
+
+        Parameters
+        ----------
+        engine : str
+            Engine name.
+
+        Returns
+        -------
+        None
+        """
+        if engine not in self._engine_builders:
+            raise ValueError(f"Engine {engine} not found.")
+        self._default = engine
+
+    def get_default(self) -> str:
+        """
+        Get default engine.
+
+        Returns
+        -------
+        str
+            Default engine.
+        """
+        if self._default is None:
+            raise ValueError("No default engine set.")
+        return self._default
+
+
+factory = ReaderFactory()
+
+try:
+    from digitalhub.readers.pandas.builder import ReaderBuilderPandas
+
+    factory.add_builder(ReaderBuilderPandas.ENGINE, ReaderBuilderPandas.DATAFRAME_CLASS, ReaderBuilderPandas())
+    factory.set_default(ReaderBuilderPandas.ENGINE)
+
+except ImportError:
+    pass

digitalhub/readers/pandas/builder.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from digitalhub.readers._base.builder import ReaderBuilder
+from digitalhub.readers.pandas.reader import DataframeReaderPandas
+
+
+class ReaderBuilderPandas(ReaderBuilder):
+    """
+    Pandas reader builder.
+    """
+
+    ENGINE = "pandas"
+    DATAFRAME_CLASS = "pandas.core.frame.DataFrame"
+
+    def build(self, **kwargs) -> DataframeReaderPandas:
+        """
+        Build reader object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        DataframeReaderPandas
+            Pandas reader object.
+        """
+        return DataframeReaderPandas(**kwargs)

digitalhub/readers/pandas/{readers.py → reader.py}

@@ -7,7 +7,7 @@ import numpy as np
 import pandas as pd
 from pandas.errors import ParserError
 
-from digitalhub.readers._base.readers import DataframeReader
+from digitalhub.readers._base.reader import DataframeReader
 from digitalhub.utils.data_utils import build_data_preview, get_data_preview
 
 

digitalhub/stores/api.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.stores.builder import store_builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores._base.store import Store, StoreParameters
+
+
+def set_store(store_cfg: StoreParameters) -> None:
+    """
+    Set a new store instance with the given configuration.
+
+    Parameters
+    ----------
+    store_cfg : StoreParameters
+        Store configuration.
+
+    Returns
+    -------
+    None
+    """
+    store_builder.build(store_cfg)
+
+
+def get_store(uri: str) -> Store:
+    """
+    Get store instance by uri.
+
+    Parameters
+    ---------
+    uri : str
+        URI to parse.
+
+    Returns
+    -------
+    Store
+        Store instance.
+    """
+    return store_builder.get(uri)
+
+
+def get_default_store() -> Store:
+    """
+    Get the default store instance. The default store is the one that
+    can persist artifacts and dataitems.
+
+    Returns
+    -------
+    Store
+        Default store instance.
+    """
+    return store_builder.default()

digitalhub/stores/builder.py

@@ -208,50 +208,4 @@ def get_env_store_config(scheme: str) -> StoreParameters:
     raise ValueError(f"Unsupported scheme {scheme}")
 
 
-def set_store(store_cfg: StoreParameters) -> None:
-    """
-    Set a new store instance with the given configuration.
-
-    Parameters
-    ----------
-    store_cfg : StoreParameters
-        Store configuration.
-
-    Returns
-    -------
-    None
-    """
-    store_builder.build(store_cfg)
-
-
-def get_store(uri: str) -> Store:
-    """
-    Get store instance by uri.
-
-    Parameters
-    ---------
-    uri : str
-        URI to parse.
-
-    Returns
-    -------
-    Store
-        Store instance.
-    """
-    return store_builder.get(uri)
-
-
-def get_default_store() -> Store:
-    """
-    Get the default store instance. The default store is the one that
-    can persist artifacts and dataitems.
-
-    Returns
-    -------
-    Store
-        Default store instance.
-    """
-    return store_builder.default()
-
-
 store_builder = StoreBuilder()

{digitalhub-0.8.0b7.dist-info → digitalhub-0.8.0b10.dist-info}/METADATA

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