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

digitalhub/entities/task/status.py

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

digitalhub/entities/{utils/utils.py → utils.py}

@@ -2,9 +2,9 @@ from __future__ import annotations
 
 from pathlib import Path
 
-from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.utils.env_utils import get_s3_bucket
 from digitalhub.utils.file_utils import get_file_mime_type
-from digitalhub.utils.s3_utils import get_s3_bucket
 from digitalhub.utils.uri_utils import check_local_path
 
 
@@ -182,21 +182,3 @@ 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/builder.py

@@ -0,0 +1,91 @@
+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.workflow.entity import Workflow
+
+
+def workflow_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,
+) -> Workflow:
+    """
+    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
+    -------
+    Workflow
+        Object instance.
+    """
+    name = build_name(name)
+    uuid = build_uuid(uuid)
+    spec = build_spec(
+        kind,
+        **kwargs,
+    )
+    metadata = build_metadata(
+        kind,
+        project=project,
+        name=name,
+        version=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+    )
+    status = build_status(
+        kind,
+    )
+    return Workflow(
+        project=project,
+        name=name,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def workflow_from_dict(obj: dict) -> Workflow:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Workflow
+        Object instance.
+    """
+    return Workflow.from_dict(obj)

digitalhub/entities/workflow/crud.py

@@ -2,18 +2,20 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.context.builder import check_context
 from digitalhub.entities._base.crud import (
-    delete_entity,
-    get_context_entity_versions,
-    get_versioned_entity,
-    import_executable_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.entities.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
+    from digitalhub.entities.workflow.entity import Workflow
 
 
 ENTITY_TYPE = EntityTypes.WORKFLOW.value
@@ -26,7 +28,7 @@ def new_workflow(
     uuid: str | None = None,
     description: str | None = None,
     labels: list[str] | None = None,
-    embedded: bool = False,
+    embedded: bool = True,
     **kwargs,
 ) -> Workflow:
     """
@@ -39,7 +41,7 @@ def new_workflow(
     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]
@@ -62,7 +64,8 @@ def new_workflow(
     >>>                    code_src="pipeline.py",
     >>>                    handler="pipeline-handler")
     """
-    return new_context_entity(
+    check_context(project)
+    obj = workflow_from_parameters(
         project=project,
         name=name,
         kind=kind,
@@ -72,6 +75,8 @@ def new_workflow(
         embedded=embedded,
         **kwargs,
     )
+    obj.save()
+    return obj
 
 
 def get_workflow(
@@ -109,13 +114,14 @@ def get_workflow(
     >>>                    project="my-project",
     >>>                    entity_id="my-workflow-id")
     """
-    return get_versioned_entity(
+    obj = read_entity_api_ctx(
         identifier,
-        entity_type=ENTITY_TYPE,
+        ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
         **kwargs,
     )
+    return workflow_from_dict(obj)
 
 
 def get_workflow_versions(
@@ -149,12 +155,13 @@ def get_workflow_versions(
     >>> obj = get_workflow_versions("my-workflow-name"
     >>>                             project="my-project")
     """
-    return get_context_entity_versions(
+    obj = read_entity_api_ctx_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]:
@@ -177,11 +184,12 @@ def list_workflows(project: str, **kwargs) -> list[Workflow]:
     --------
     >>> objs = list_workflows(project="my-project")
     """
-    return list_context_entities(
+    objs = list_entity_api_ctx(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
     )
+    return [workflow_from_dict(obj) for obj in objs]
 
 
 def import_workflow(file: str) -> Workflow:
@@ -202,7 +210,25 @@ def import_workflow(file: str) -> Workflow:
     --------
     >>> obj = import_workflow("my-workflow.yaml")
     """
-    return import_executable_entity(file)
+    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
 
 
 def update_workflow(entity: Workflow) -> Workflow:
@@ -267,7 +293,7 @@ def delete_workflow(
     >>>                       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/workflow/{_base/entity.py → entity.py}

@@ -2,16 +2,16 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.executable.entity import ExecutableEntity
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.factory.api import get_run_kind, get_task_kind_from_action
+from digitalhub.entities._base.entity.executable import ExecutableEntity
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.runtimes.builder import get_kind_registry
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.entity.metadata import Metadata
-    from digitalhub.entities.run._base.entity import Run
-    from digitalhub.entities.workflow._base.spec import WorkflowSpec
-    from digitalhub.entities.workflow._base.status import WorkflowStatus
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.run.entity import Run
+    from digitalhub.entities.workflow.spec import WorkflowSpec
+    from digitalhub.entities.workflow.status import WorkflowStatus
 
 
 class Workflow(ExecutableEntity):
@@ -60,9 +60,12 @@ class Workflow(ExecutableEntity):
         if action is None:
             action = "pipeline"
 
+        # Get kind registry
+        kind_reg = get_kind_registry(self.kind)
+
         # Get task and run kind
-        task_kind = get_task_kind_from_action(self.kind, action)
-        run_kind = get_run_kind(self.kind)
+        task_kind = kind_reg.get_task_kind_from_action(action=action)
+        run_kind = kind_reg.get_run_kind()
 
         # Create or update new task
         task = self._get_or_create_task(task_kind)

digitalhub/entities/workflow/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.spec.base import Spec, SpecParams
+
+
+class WorkflowSpec(Spec):
+    """
+    Workflow specifications.
+    """
+
+
+class WorkflowParams(SpecParams):
+    """
+    Workflow parameters.
+    """

digitalhub/entities/workflow/status.py

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

digitalhub/readers/builder.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import typing
+from typing import Any
+
+from digitalhub.readers.registry import REGISTRY_DATAFRAME, REGISTRY_FRAMEWORK
+
+if typing.TYPE_CHECKING:
+    from digitalhub.readers.objects.base import DataframeReader
+
+
+def get_reader_by_engine(engine: str) -> DataframeReader:
+    """
+    Get Dataframe reader.
+
+    Parameters
+    ----------
+    engine : str
+        Dataframe engine (pandas, polars, etc.).
+
+    Returns
+    -------
+    DataframeReader
+        Reader object.
+    """
+    try:
+        return REGISTRY_FRAMEWORK[engine]()
+    except KeyError:
+        engines = list(REGISTRY_FRAMEWORK.keys())
+        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 REGISTRY_DATAFRAME[obj_name]()
+    except KeyError:
+        types = list(REGISTRY_DATAFRAME.keys())
+        msg = f"Unsupported dataframe type: {obj}. Supported types: {types}"
+        raise ValueError(msg)

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

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

digitalhub/readers/registry.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+REGISTRY_FRAMEWORK = {}
+REGISTRY_DATAFRAME = {}
+DATAFRAME_TYPES = []
+
+try:
+    from digitalhub.readers.objects.pandas import DataframeReaderPandas
+
+    REGISTRY_FRAMEWORK["pandas"] = DataframeReaderPandas
+    REGISTRY_DATAFRAME["pandas.core.frame.DataFrame"] = DataframeReaderPandas
+    DATAFRAME_TYPES.append("pandas.core.frame.DataFrame")
+
+except ImportError:
+    pass

digitalhub/registry/models.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class RuntimeEntry(BaseModel):
+    """
+    Model for Runtime entry.
+    It specifies the module path and the runtime class name.
+    """
+
+    module: str
+    """Module path."""
+
+    class_name: str
+    """Class name."""
+
+    kind_registry_module: str
+    """Kind registry module path."""
+
+    kind_registry_class_name: str
+    """Kind registry class name."""
+
+
+class SpecEntry(BaseModel):
+    """
+    Model for Spec entry.
+    It specifies the module path, the spec class name
+    and the spec pydantic class validator.
+    """
+
+    module: str
+    """Module path."""
+
+    class_name: str
+    """Class name."""
+
+    parameters_validator: str
+    """Class name of the parameter validator."""
+
+
+class StatusEntry(BaseModel):
+    """
+    Model for Status entry.
+    It specifies the module path and the status class name.
+    """
+
+    module: str
+    """Module path."""
+
+    class_name: str
+    """Class name."""
+
+
+class MetadataEntry(BaseModel):
+    """
+    Model for Metadata entry.
+    It specifies the module path and the metadata class name.
+    """
+
+    module: str
+    """Module path."""
+
+    class_name: str
+    """Class name."""
+
+
+class RegistryEntry(BaseModel):
+    """
+    Basic entry model for every entity.
+    Functions, tasks and runs specify also the runtime field.
+    """
+
+    entity_type: str
+    """Entity type."""
+
+    spec: SpecEntry
+    """Spec infos."""
+
+    status: StatusEntry
+    """Status infos."""
+
+    metadata: MetadataEntry
+    """Metadata infos."""
+
+    runtime: RuntimeEntry = None
+    """Runtime infos."""

digitalhub/registry/registry.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from digitalhub.registry.models import RegistryEntry
+
+
+class GlobalEntityRegistry:
+    """
+    Global entity registry where all entities classpaths are stored.
+    It keeps track of all entities that are registered in the system.
+    """
+
+    def register(self, entity_kind: str, entry: dict) -> None:
+        """
+        Register an entity kind.
+
+        Parameters
+        ----------
+        entity_kind : str
+            Entity kind to be registered.
+        entry : dict
+            Entry to be registered.
+
+        Returns
+        -------
+        None
+
+        """
+        if hasattr(self, entity_kind):
+            raise ValueError(f"Entity kind {entity_kind} already registered")
+        entry = RegistryEntry(**entry)
+        setattr(self, entity_kind, entry)
+
+    def update(self, entity_kind: str, entry: dict) -> None:
+        """
+        Update an entity kind.
+
+        Parameters
+        ----------
+        entity_kind : str
+            Entity kind to be updated.
+        entry : dict
+            Entry to be updated.
+
+        Returns
+        -------
+        None
+        """
+        if hasattr(self, entity_kind):
+            entry = RegistryEntry(**entry)
+            setattr(self, entity_kind, entry)
+        else:
+            raise ValueError(f"Entity kind {entity_kind} not registered")
+
+    def get_entity_type(self, entity_kind: str) -> str:
+        """
+        Get entity type from kind.
+
+        Parameters
+        ----------
+        entity_kind : str
+            Entity kind.
+
+        Returns
+        -------
+        str
+            Entity type.
+        """
+        if not hasattr(self, entity_kind):
+            raise ValueError(f"Entity kind {entity_kind} not registered")
+        entry: RegistryEntry = getattr(self, entity_kind)
+        return entry.entity_type
+
+
+registry = GlobalEntityRegistry()