digitalhub 0.8.0b2__py3-none-any.whl → 0.8.0b4__py3-none-any.whl

digitalhub/entities/workflow/builder.py

@@ -1,77 +1,33 @@
 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
+import typing
 
+from digitalhub.factory.factory import factory
+from digitalhub.utils.exceptions import BuilderError
 
-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:
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.workflow._base.entity import Workflow
+
+
+def workflow_from_parameters(**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.
+    **kwargs
+        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,
-    )
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_params(kind, **kwargs)
 
 
 def workflow_from_dict(obj: dict) -> Workflow:
@@ -88,4 +44,8 @@ def workflow_from_dict(obj: dict) -> Workflow:
     Workflow
         Object instance.
     """
-    return Workflow.from_dict(obj)
+    try:
+        kind = obj["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_dict(kind, obj)

digitalhub/entities/workflow/crud.py

@@ -9,13 +9,13 @@ from digitalhub.entities._base.crud import (
     read_entity_api_ctx,
     read_entity_api_ctx_versions,
 )
-from digitalhub.entities.entity_types import EntityTypes
+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.entity import Workflow
+    from digitalhub.entities.workflow._base.entity import Workflow
 
 
 ENTITY_TYPE = EntityTypes.WORKFLOW.value
@@ -41,7 +41,7 @@ def new_workflow(
     name : str
         Object name.
     uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+        ID of the object.
     description : str
         Description of the object (human readable).
     labels : list[str]

digitalhub/factory/factory.py

@@ -0,0 +1,204 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.utils.exceptions import BuilderError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.entity import Entity
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
+    from digitalhub.entities._builders.entity import EntityBuilder
+    from digitalhub.runtimes._base import Runtime
+    from digitalhub.runtimes.builder import RuntimeBuilder
+
+
+class Factory:
+    """
+    Factory class for building entities and runtimes.
+    """
+
+    def __init__(self):
+        self._entity_builders: dict[str, EntityBuilder] = {}
+        self._runtime_builders: dict[str, RuntimeBuilder] = {}
+
+    def add_entity_builder(self, name: str, builder: EntityBuilder) -> None:
+        """
+        Add a builder to the factory.
+
+        Parameters
+        ----------
+        name : str
+            Builder name.
+        builder : EntityBuilder
+            Builder object.
+
+        Returns
+        -------
+        None
+        """
+        if name in self._entity_builders:
+            raise BuilderError(f"Builder {name} already exists.")
+        self._entity_builders[name] = builder()
+
+    def add_runtime_builder(self, name: str, builder: RuntimeBuilder) -> None:
+        """
+        Add a builder to the factory.
+
+        Parameters
+        ----------
+        name : str
+            Builder name.
+        builder : RuntimeBuilder
+            Builder object.
+
+        Returns
+        -------
+        None
+        """
+        if name in self._runtime_builders:
+            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:
+        """
+        Build an entity.
+
+        Parameters
+        ----------
+        kind_to_build_from : str
+            Entity type.
+
+        Returns
+        -------
+        Entity
+            Entity object.
+        """
+        self._raise_if_builder_not_found(kind_to_build_from)
+        return self._entity_builders[kind_to_build_from].build(*args, **kwargs)
+
+    def build_entity_from_dict(self, 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.
+        """
+        self._raise_if_builder_not_found(kind_to_build_from)
+        return self._entity_builders[kind_to_build_from].from_dict(dict_data)
+
+    def build_spec(self, kind_to_build_from: str, **kwargs) -> Spec:
+        """
+        Build an entity spec.
+
+        Parameters
+        ----------
+        kind_to_build_from : str
+            Entity type.
+
+        Returns
+        -------
+        Spec
+            Spec object.
+        """
+        self._raise_if_builder_not_found(kind_to_build_from)
+        return self._entity_builders[kind_to_build_from].build_spec(**kwargs)
+
+    def build_metadata(self, kind_to_build_from: str, **kwargs) -> Metadata:
+        """
+        Build an entity metadata.
+
+        Parameters
+        ----------
+        kind_to_build_from : str
+            Entity type.
+
+        Returns
+        -------
+        Metadata
+            Metadata object.
+        """
+        self._raise_if_builder_not_found(kind_to_build_from)
+        return self._entity_builders[kind_to_build_from].build_metadata(**kwargs)
+
+    def build_status(self, kind_to_build_from: str, **kwargs) -> Status:
+        """
+        Build an entity status.
+
+        Parameters
+        ----------
+        kind_to_build_from : str
+            Entity type.
+
+        Returns
+        -------
+        Status
+            Status object.
+        """
+        self._raise_if_builder_not_found(kind_to_build_from)
+        return self._entity_builders[kind_to_build_from].build_status(**kwargs)
+
+    def build_runtime(self, kind_to_build_from: str, project: str) -> Runtime:
+        """
+        Build a runtime.
+
+        Parameters
+        ----------
+        kind_to_build_from : str
+            Runtime type.
+        project : str
+            Project name.
+
+        Returns
+        -------
+        Runtime
+            Runtime object.
+        """
+        self._raise_if_builder_not_found(kind_to_build_from)
+        return self._runtime_builders[kind_to_build_from].build(project=project)
+
+    def get_entity_type_from_builder(self, kind: str) -> str:
+        """
+        Get entity type from builder.
+
+        Parameters
+        ----------
+        kind : str
+            Entity type.
+
+        Returns
+        -------
+        str
+            Entity type.
+        """
+        self._raise_if_builder_not_found(kind)
+        return self._entity_builders[kind].ENTITY_TYPE
+
+    def _raise_if_builder_not_found(self, kind: str) -> None:
+        """
+        Raise error if builder not found.
+
+        Parameters
+        ----------
+        kind : str
+            Entity type.
+
+        Returns
+        -------
+        None
+        """
+        if kind not in self._entity_builders:
+            raise BuilderError(f"Builder for kind '{kind}' not found.")
+
+
+factory = Factory()

digitalhub/factory/utils.py

@@ -0,0 +1,90 @@
+from __future__ import annotations
+
+import importlib
+import importlib.metadata
+import pkgutil
+import re
+from types import ModuleType
+
+from digitalhub.factory.factory import factory
+
+
+def import_module(package: str) -> ModuleType:
+    """
+    Import modules from package name.
+
+    Parameters
+    ----------
+    package : str
+        Package name.
+
+    Returns
+    -------
+    ModuleType
+        Module.
+    """
+    try:
+        return importlib.import_module(package)
+    except ModuleNotFoundError:
+        raise ModuleNotFoundError(f"Package {package} not found.")
+    except Exception as e:
+        raise e
+
+
+def list_runtimes() -> list[str]:
+    """
+    List installed runtimes for digitalhub.
+
+    Returns
+    -------
+    list
+        List of installed runtimes names.
+    """
+    pattern = r"digitalhub_runtime_.*"
+    runtimes = []
+    try:
+        for _, name, _ in pkgutil.iter_modules():
+            if re.match(pattern, name):
+                runtimes.append(name)
+        return runtimes
+    except Exception:
+        raise RuntimeError("Error listing installed runtimes.")
+
+
+def register_runtimes_entities() -> None:
+    """
+    Register runtimes and related entities into registry.
+
+    Returns
+    -------
+    None
+    """
+    for package in list_runtimes():
+        module = import_module(package)
+        entity_builders = getattr(module, "entity_builders")
+        for entity_builder_tuple in entity_builders:
+            kind, builder = entity_builder_tuple
+            factory.add_entity_builder(kind, builder)
+
+        runtime_builders = getattr(module, "runtime_builders")
+        for runtime_builder_tuple in runtime_builders:
+            kind, builder = runtime_builder_tuple
+            factory.add_runtime_builder(kind, builder)
+
+
+def register_entities() -> None:
+    """
+    Register layer and related entities into registry.
+
+    Returns
+    -------
+    None
+    """
+    try:
+        module = import_module("digitalhub.entities.builders")
+        entities_builders_list = getattr(module, "entity_builders")
+        for entity_builder_tuple in entities_builders_list:
+            kind, builder = entity_builder_tuple
+            factory.add_entity_builder(kind, builder)
+    except Exception:
+        pass

digitalhub/readers/builder.py

@@ -6,7 +6,7 @@ from typing import Any
 from digitalhub.readers.registry import REGISTRY_DATAFRAME, REGISTRY_FRAMEWORK
 
 if typing.TYPE_CHECKING:
-    from digitalhub.readers.objects.base import DataframeReader
+    from digitalhub.readers._base.readers import DataframeReader
 
 
 def get_reader_by_engine(engine: str) -> DataframeReader:

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

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

digitalhub/readers/registry.py

@@ -5,7 +5,7 @@ REGISTRY_DATAFRAME = {}
 DATAFRAME_TYPES = []
 
 try:
-    from digitalhub.readers.objects.pandas import DataframeReaderPandas
+    from digitalhub.readers.pandas.readers import DataframeReaderPandas
 
     REGISTRY_FRAMEWORK["pandas"] = DataframeReaderPandas
     REGISTRY_DATAFRAME["pandas.core.frame.DataFrame"] = DataframeReaderPandas

digitalhub/runtimes/builder.py

@@ -2,52 +2,35 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.registry.registry import registry
-from digitalhub.registry.utils import import_class
+from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
-    from digitalhub.registry.models import RegistryEntry
-    from digitalhub.runtimes.base import Runtime
+    from digitalhub.runtimes._base import Runtime
     from digitalhub.runtimes.kind_registry import KindRegistry
 
 
-def build_runtime(kind: str, project: str) -> Runtime:
+class RuntimeBuilder:
     """
-    Build runtime object. The builder takes in input a kind.
-    This kind can derive from functions, tasks, or runs, and
-    is inserted in the global kind registry where the runtimes
-    pakages are registered.
-    The builder requires the module path where the Runtime
-    subclass is defined and the class name. It requires also
-    the kind registry module, kind registry class and the project
-    name.
-
-    Parameters
-    ----------
-    kind : str
-        The type of runtime to build.
-    project : str
-        The project name.
-
-    Returns
-    -------
-    Runtime
-        Runtime object.
+    Builder class for building runtimes.
     """
-    infos: RegistryEntry = getattr(registry, kind)
-    cls = import_class(infos.runtime.module, infos.runtime.class_name)
-    kind_registry = get_kind_registry(kind)
-    return cls(kind_registry, project)
 
-
-def get_kind_registry(kind: str) -> KindRegistry:
-    """
-    Get kind registry.
-
-    Returns
-    -------
-    KindRegistry
-        Kind registry.
-    """
-    infos: RegistryEntry = getattr(registry, kind)
-    return import_class(infos.runtime.kind_registry_module, infos.runtime.kind_registry_class_name)
+    # Class variables
+    RUNTIME_CLASS: Runtime = None
+    KIND_REGISTRY: KindRegistry = None
+
+    def __init__(self) -> None:
+        if self.RUNTIME_CLASS is None:
+            raise BuilderError("RUNTIME_CLASS must be set")
+        if self.KIND_REGISTRY is None:
+            raise BuilderError("KIND_REGISTRY must be set")
+
+    def build(self, *args, **kwargs) -> Runtime:
+        """
+        Build runtime object.
+
+        Returns
+        -------
+        Runtime
+            Runtime object.
+        """
+        return self.RUNTIME_CLASS(self.KIND_REGISTRY, *args, **kwargs)

digitalhub/runtimes/kind_registry.py

@@ -168,3 +168,17 @@ class KindRegistry:
             Executable kind.
         """
         return self.data.executable.kind
+
+    def get_all_kinds(self) -> list[str]:
+        """
+        Get all kinds.
+
+        Returns
+        -------
+        list[str]
+            All kinds.
+        """
+        exec_kind = self.get_executable_kind()
+        run_kind = self.get_run_kind()
+        task_kinds = [task.kind for task in self.data.task]
+        return [exec_kind, run_kind, *task_kinds]

digitalhub/runtimes/utils.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.factory.factory import factory
+
+if typing.TYPE_CHECKING:
+    from digitalhub.runtimes.kind_registry import KindRegistry
+
+
+def get_kind_registry(kind: str, project: str) -> KindRegistry:
+    """
+    Get kind registry.
+
+    Parameters
+    ----------
+    kind : str
+        Kind of the runtime.
+    project : str
+        Project name.
+
+    Returns
+    -------
+    KindRegistry
+        Kind registry.
+    """
+    runtime = factory.build_runtime(kind, project)
+    return runtime.kind_registry

digitalhub/stores/builder.py

@@ -5,16 +5,16 @@ import typing
 
 from pydantic import ValidationError
 
-from digitalhub.stores.objects.base import StoreParameters
-from digitalhub.stores.objects.local import LocalStore, LocalStoreConfig
-from digitalhub.stores.objects.remote import RemoteStore, RemoteStoreConfig
-from digitalhub.stores.objects.s3 import S3Store, S3StoreConfig
-from digitalhub.stores.objects.sql import SqlStore, SQLStoreConfig
+from digitalhub.stores._base.store import StoreParameters
+from digitalhub.stores.local.store import LocalStore, LocalStoreConfig
+from digitalhub.stores.remote.store import RemoteStore, RemoteStoreConfig
+from digitalhub.stores.s3.store import S3Store, S3StoreConfig
+from digitalhub.stores.sql.store import SqlStore, SQLStoreConfig
 from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores.objects.base import Store
+    from digitalhub.stores._base.store import Store
 
 
 REGISTRY_STORES = {

digitalhub/stores/{objects/local.py → local/store.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 import shutil
 from pathlib import Path
 
-from digitalhub.stores.objects.base import Store, StoreConfig
+from digitalhub.stores._base.store import Store, StoreConfig
 from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.file_utils import get_file_info_from_local
 

digitalhub/stores/{objects/remote.py → remote/store.py}

@@ -4,7 +4,7 @@ from pathlib import Path
 
 import requests
 
-from digitalhub.stores.objects.base import Store, StoreConfig
+from digitalhub.stores._base.store import Store, StoreConfig
 from digitalhub.utils.exceptions import StoreError
 
 

digitalhub/stores/{objects/s3.py → s3/store.py}

@@ -9,7 +9,7 @@ import boto3
 import botocore.client  # pylint: disable=unused-import
 from botocore.exceptions import ClientError
 
-from digitalhub.stores.objects.base import Store, StoreConfig
+from digitalhub.stores._base.store import Store, StoreConfig
 from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.file_utils import get_file_info_from_s3, get_file_mime_type
 

digitalhub/stores/{objects/sql.py → sql/store.py}

@@ -9,7 +9,7 @@ from sqlalchemy.engine import Engine
 from sqlalchemy.engine.row import LegacyRow
 from sqlalchemy.exc import SQLAlchemyError
 
-from digitalhub.stores.objects.base import Store, StoreConfig
+from digitalhub.stores._base.store import Store, StoreConfig
 from digitalhub.utils.exceptions import StoreError
 
 

digitalhub/utils/exceptions.py

@@ -1,6 +1,12 @@
 from __future__ import annotations
 
 
+class BuilderError(Exception):
+    """
+    Raised when incontered errors on builders.
+    """
+
+
 class StoreError(Exception):
     """
     Raised when incontered errors on stores.