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

digitalhub/registry/utils.py

@@ -0,0 +1,150 @@
+from __future__ import annotations
+
+import importlib
+import importlib.metadata
+import pkgutil
+import re
+from types import ModuleType
+
+
+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 import_class(module_to_import: str, class_name: str) -> type:
+    """
+    Import class from implemented module.
+
+    Parameters
+    ----------
+    module_to_import : str
+        Module name.
+    class_name : str
+        Class name.
+
+    Returns
+    -------
+    type
+        Class.
+    """
+    module = import_module(module_to_import)
+    try:
+        return getattr(module, class_name)
+    except AttributeError:
+        raise ModuleNotFoundError(f"Module {module_to_import} has no '{class_name}' class.")
+
+
+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():
+        import_module(package)
+
+
+def register_entities() -> None:
+    """
+    Register layer and related entities into registry.
+
+    Returns
+    -------
+    None
+    """
+    # Try ot import registry from entities.registries module
+    try:
+        import_module(f"digitalhub.entities.registries")
+    except Exception:
+        pass
+
+
+def create_info(
+    root: str,
+    entity_type: str,
+    prefix: str,
+    suffix: str | None = "",
+    runtime_info: dict | None = None,
+) -> dict:
+    """
+    Create entity info.
+
+    Parameters
+    ----------
+    root : str
+        Root module.
+    entity_type : str
+        Entity type.
+    prefix : str
+        Entity prefix.
+    suffix : str
+        Entity suffix.
+    runtime_info : dict
+        Runtime info.
+
+    Returns
+    -------
+    dict
+        Entity info.
+    """
+    dict_ = {
+        "entity_type": entity_type,
+        "spec": {
+            "module": f"{root}.{entity_type}.spec",
+            "class_name": f"{prefix}Spec{suffix}",
+            "parameters_validator": f"{prefix}Params{suffix}",
+        },
+        "status": {
+            "module": f"{root}.{entity_type}.status",
+            "class_name": f"{prefix}Status{suffix}",
+        },
+        "metadata": {
+            "module": "digitalhub.entities._base.metadata",
+            "class_name": "Metadata",
+        },
+    }
+    # Add runtime only if provided
+    # (in functions, tasks, runs and workflows)
+    if runtime_info is not None:
+        dict_["runtime"] = runtime_info
+    return dict_

digitalhub/runtimes/{_base.py → base.py}

@@ -1,12 +1,15 @@
 from __future__ import annotations
 
+import typing
 from abc import abstractmethod
 from typing import Any, Callable
 
-from digitalhub.factory.api import get_action_from_task_kind
 from digitalhub.utils.exceptions import EntityError
 from digitalhub.utils.logger import LOGGER
 
+if typing.TYPE_CHECKING:
+    from digitalhub.runtimes.kind_registry import KindRegistry
+
 
 class Runtime:
     """
@@ -19,7 +22,8 @@ class Runtime:
     libraries, code, external tools etc.
     """
 
-    def __init__(self, project: str) -> None:
+    def __init__(self, kind_registry: KindRegistry, project: str) -> None:
+        self.kind_registry = kind_registry
         self.project = project
 
     @abstractmethod
@@ -69,7 +73,7 @@ class Runtime:
             raise RuntimeError(msg)
 
         try:
-            return get_action_from_task_kind(task_kind, task_kind)
+            return self.get_action_from_task_kind(task_kind)
         except EntityError:
             msg = f"Task {task_kind} not allowed."
             LOGGER.exception(msg)
@@ -100,3 +104,61 @@ class Runtime:
             msg = "Something got wrong during function execution."
             LOGGER.exception(msg)
             raise RuntimeError(msg)
+
+    ##############################
+    # Wrapper registry methods
+    ##############################
+
+    def get_executable_kind(self) -> str:
+        """
+        Get executable kind.
+
+        Returns
+        -------
+        str
+            Executable kind.
+        """
+        return self.kind_registry.get_executable_kind()
+
+    def get_task_kind_from_action(self, action: str) -> str:
+        """
+        Get task kind from action.
+
+        Parameters
+        ----------
+        action : str
+            Task action.
+
+        Returns
+        -------
+        str
+            Task kind.
+        """
+        return self.kind_registry.get_task_kind_from_action(action)
+
+    def get_action_from_task_kind(self, kind: str) -> str:
+        """
+        Get action from task.
+
+        Parameters
+        ----------
+        kind : str
+            Task kind.
+
+        Returns
+        -------
+        str
+            Action.
+        """
+        return self.kind_registry.get_action_from_task_kind(kind)
+
+    def get_run_kind(self) -> str:
+        """
+        Get run kind.
+
+        Returns
+        -------
+        str
+            Run kind.
+        """
+        return self.kind_registry.get_run_kind()

digitalhub/runtimes/builder.py

@@ -2,31 +2,52 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.utils.exceptions import BuilderError
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
 
 if typing.TYPE_CHECKING:
-    from digitalhub.runtimes._base import Runtime
+    from digitalhub.registry.models import RegistryEntry
+    from digitalhub.runtimes.base import Runtime
+    from digitalhub.runtimes.kind_registry import KindRegistry
 
 
-class RuntimeBuilder:
+def build_runtime(kind: str, project: str) -> Runtime:
     """
-    Builder class for building runtimes.
+    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.
     """
+    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)
 
-    # Class variables
-    RUNTIME_CLASS: Runtime = None
 
-    def __init__(self) -> None:
-        if self.RUNTIME_CLASS is None:
-            raise BuilderError("RUNTIME_CLASS must be set")
-
-    def build(self, project: str, *args, **kwargs) -> Runtime:
-        """
-        Build runtime object.
+def get_kind_registry(kind: str) -> KindRegistry:
+    """
+    Get kind registry.
 
-        Returns
-        -------
-        Runtime
-            Runtime object.
-        """
-        return self.RUNTIME_CLASS(project, *args, **kwargs)
+    Returns
+    -------
+    KindRegistry
+        Kind registry.
+    """
+    infos: RegistryEntry = getattr(registry, kind)
+    return import_class(infos.runtime.kind_registry_module, infos.runtime.kind_registry_class_name)

digitalhub/runtimes/kind_registry.py

@@ -0,0 +1,170 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from digitalhub.utils.exceptions import EntityError
+
+
+class TaskModel(BaseModel):
+    """
+    Task model.
+    """
+
+    kind: str
+    action: str
+
+
+class RunModel(BaseModel):
+    """
+    Run model.
+    """
+
+    kind: str
+
+
+class ExecutableModel(BaseModel):
+    """
+    Executable model.
+    """
+
+    kind: str
+
+
+class DataModel(BaseModel):
+    """
+    Data model.
+    """
+
+    executable: ExecutableModel
+    task: list[TaskModel]
+    run: RunModel
+
+
+class KindRegistry:
+
+    """
+    Kind registry module for runtimes.
+    """
+
+    def __init__(self, data: dict[str, dict[str, str]]) -> None:
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        data : dict[str, dict[str, str]]
+            Data to validate.
+
+        Examples
+        --------
+        >>> data = {
+        ...     "executable": {
+        ...         "kind": "executable-kind"
+        ...     },
+        ...     "run": {
+        ...         "kind": "run-kind"
+        ...     },
+        ...     "task": [
+        ...         {"kind": "task-kind-0", "action": "action-0"},
+        ...         {"kind": "task-kind-1", "action": "action-1"},
+        ...         {"kind": "task-kind-2", "action": "action-2"},
+        ...     ]
+        ... }
+        """
+        validated_data = self._validate_data(data)
+        self.data = validated_data
+
+    def _validate_data(self, data: dict[str, dict[str, str]]) -> DataModel:
+        """
+        Validate data.
+
+        Parameters
+        ----------
+        data : dict[str, dict[str, str]]
+            Data to validate.
+
+        Raises
+        ------
+        EntityError
+            If data is not valid.
+        """
+        try:
+            return DataModel(**data)
+        except Exception as e:
+            raise EntityError("Invalid data.") from e
+
+    def get_task_kind_from_action(self, action: str) -> str:
+        """
+        Get task kind from action.
+
+        Parameters
+        ----------
+        action : str
+            Task action.
+
+        Returns
+        -------
+        str
+            Task kind.
+
+        Raises
+        ------
+        EntityError
+            If action is not allowed.
+        """
+        try:
+            for task in self.data.task:
+                if task.action == action:
+                    return task.kind
+        except StopIteration:
+            msg = f"Action {action} not allowed."
+            raise EntityError(msg)
+
+    def get_action_from_task_kind(self, kind: str) -> str:
+        """
+        Get action from task.
+
+        Parameters
+        ----------
+        kind : str
+            Task kind.
+
+        Returns
+        -------
+        str
+            Action.
+
+        Raises
+        ------
+        EntityError
+            If task is not allowed.
+        """
+        try:
+            for task in self.data.task:
+                if task.kind == kind:
+                    return task.action
+        except StopIteration:
+            msg = f"Task {kind} not allowed."
+            raise EntityError(msg)
+
+    def get_run_kind(self) -> str:
+        """
+        Get run kind.
+
+        Returns
+        -------
+        str
+            Run kind.
+        """
+        return self.data.run.kind
+
+    def get_executable_kind(self) -> str:
+        """
+        Get executable kind.
+
+        Returns
+        -------
+        str
+            Executable kind.
+        """
+        return self.data.executable.kind

digitalhub/stores/builder.py

@@ -5,16 +5,16 @@ import typing
 
 from pydantic import ValidationError
 
-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.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.utils.exceptions import StoreError
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores._base.store import Store
+    from digitalhub.stores.objects.base import Store
 
 
 REGISTRY_STORES = {
@@ -208,4 +208,50 @@ 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/stores/{local/store.py → objects/local.py}

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

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

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

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

@@ -9,7 +9,7 @@ import boto3
 import botocore.client  # pylint: disable=unused-import
 from botocore.exceptions import ClientError
 
-from digitalhub.stores._base.store import Store, StoreConfig
+from digitalhub.stores.objects.base 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/{sql/store.py → objects/sql.py}

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

digitalhub/{client/dhcore/utils.py → utils/env_utils.py}

@@ -3,10 +3,10 @@ from __future__ import annotations
 import os
 import typing
 
-from digitalhub.client.api import check_client_exists, get_client
+from digitalhub.client.builder import check_client_exists, get_client
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.dhcore.client import ClientDHCore
+    from digitalhub.client.objects.dhcore import ClientDHCore
 
 
 def set_dhcore_env(
@@ -109,3 +109,15 @@ def refresh_token() -> None:
     """
     client: ClientDHCore = get_client(local=False)
     client._get_new_access_token()
+
+
+def get_s3_bucket() -> str | None:
+    """
+    Function to get S3 bucket name.
+
+    Returns
+    -------
+    str
+        The S3 bucket name.
+    """
+    return os.getenv("S3_BUCKET_NAME", "datalake")

digitalhub/utils/exceptions.py

@@ -1,12 +1,6 @@
 from __future__ import annotations
 
 
-class BuilderError(Exception):
-    """
-    Raised when incontered errors on builders.
-    """
-
-
 class StoreError(Exception):
     """
     Raised when incontered errors on stores.
@@ -59,9 +53,3 @@ class EntityError(Exception):
     """
     Raised when incontered errors on entities.
     """
-
-
-class ContextError(Exception):
-    """
-    Raised when context errors.
-    """