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

digitalhub/factory/api.py

@@ -0,0 +1,271 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.factory.factory import factory
+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.runtimes._base import Runtime
+
+
+def build_entity(kind_to_build_from: str, *args, **kwargs) -> Entity:
+    """
+    Build an entity.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    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)
+
+
+def build_spec(kind_to_build_from: str, **kwargs) -> Spec:
+    """
+    Build an entity spec.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    Returns
+    -------
+    Spec
+        Spec object.
+    """
+    _raise_if_entity_builder_not_found(kind_to_build_from)
+    return factory.build_spec(kind_to_build_from, **kwargs)
+
+
+def build_metadata(kind_to_build_from: str, **kwargs) -> Metadata:
+    """
+    Build an entity metadata.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    Returns
+    -------
+    Metadata
+        Metadata object.
+    """
+    _raise_if_entity_builder_not_found(kind_to_build_from)
+    return factory.build_metadata(kind_to_build_from, **kwargs)
+
+
+def build_status(kind_to_build_from: str, **kwargs) -> Status:
+    """
+    Build an entity status.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    Returns
+    -------
+    Status
+        Status object.
+    """
+    _raise_if_entity_builder_not_found(kind_to_build_from)
+    return factory.build_status(kind_to_build_from, **kwargs)
+
+
+def build_runtime(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.
+    """
+    _raise_if_runtime_builder_not_found(kind_to_build_from)
+    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.
+
+    Parameters
+    ----------
+    kind : str
+        Entity type.
+
+    Returns
+    -------
+    str
+        Entity type.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_entity_type_from_kind(kind)
+
+
+def get_all_kinds(kind: str) -> list[str]:
+    """
+    Get all kinds.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+
+    Returns
+    -------
+    list[str]
+        All entities runtime kinds.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_all_kinds(kind)
+
+
+def get_executable_kind(kind: str) -> str:
+    """
+    Get executable kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+
+    Returns
+    -------
+    str
+        Executable kind.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_executable_kind(kind)
+
+
+def get_task_kind_from_action(kind: str, action: str) -> str:
+    """
+    Get task kinds from action.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+    action : str
+        Action.
+
+    Returns
+    -------
+    str
+        Task kind.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_task_kind_from_action(kind, action)
+
+
+def get_action_from_task_kind(kind: str, task_kind: str) -> str:
+    """
+    Get action from task.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+    task_kind : str
+        Task kind.
+
+    Returns
+    -------
+    str
+        Action.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_action_from_task_kind(kind, task_kind)
+
+
+def get_run_kind(kind: str) -> str:
+    """
+    Get run kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+
+    Returns
+    -------
+    str
+        Run kind.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_run_kind(kind)
+
+
+def _raise_if_entity_builder_not_found(kind: str) -> None:
+    """
+    Raise error if entity builder not found.
+
+    Parameters
+    ----------
+    kind : str
+        Entity type.
+
+    Returns
+    -------
+    None
+    """
+    if kind not in factory._entity_builders:
+        raise BuilderError(f"Builder for kind '{kind}' not found.")
+
+
+def _raise_if_runtime_builder_not_found(kind: str) -> None:
+    """
+    Raise error if runtime builder not found.
+
+    Parameters
+    ----------
+    kind : str
+        Runtime type.
+
+    Returns
+    -------
+    None
+    """
+    if kind not in factory._runtime_builders:
+        raise BuilderError(f"Builder for kind '{kind}' not found.")

digitalhub/factory/factory.py

@@ -5,11 +5,12 @@ import typing
 from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.builder import EntityBuilder
     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.entities._base.runtime_entity.builder import RuntimeEntityBuilder
     from digitalhub.runtimes._base import Runtime
     from digitalhub.runtimes.builder import RuntimeBuilder
 
@@ -20,10 +21,10 @@ class Factory:
     """
 
     def __init__(self):
-        self._entity_builders: dict[str, EntityBuilder] = {}
+        self._entity_builders: dict[str, EntityBuilder | RuntimeEntityBuilder] = {}
         self._runtime_builders: dict[str, RuntimeBuilder] = {}
 
-    def add_entity_builder(self, name: str, builder: EntityBuilder) -> None:
+    def add_entity_builder(self, name: str, builder: EntityBuilder | RuntimeEntityBuilder) -> None:
         """
         Add a builder to the factory.
 
@@ -75,7 +76,6 @@ class Factory:
         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:
@@ -94,7 +94,6 @@ class Factory:
         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:
@@ -111,7 +110,6 @@ class Factory:
         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:
@@ -128,7 +126,6 @@ class Factory:
         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:
@@ -145,7 +142,6 @@ class Factory:
         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:
@@ -164,10 +160,9 @@ class Factory:
         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:
+    def get_entity_type_from_kind(self, kind: str) -> str:
         """
         Get entity type from builder.
 
@@ -181,24 +176,91 @@ class Factory:
         str
             Entity type.
         """
-        self._raise_if_builder_not_found(kind)
-        return self._entity_builders[kind].ENTITY_TYPE
+        return self._entity_builders[kind].get_entity_type()
 
-    def _raise_if_builder_not_found(self, kind: str) -> None:
+    def get_executable_kind(self, kind: str) -> str:
         """
-        Raise error if builder not found.
+        Get executable kind.
 
         Parameters
         ----------
         kind : str
-            Entity type.
+            Kind.
 
         Returns
         -------
-        None
+        str
+            Executable kind.
+        """
+        return self._entity_builders[kind].get_executable_kind()
+
+    def get_action_from_task_kind(self, kind: str, task_kind: str) -> str:
+        """
+        Get action from task.
+
+        Parameters
+        ----------
+        kind : str
+            Kind.
+        task_kind : str
+            Task kind.
+
+        Returns
+        -------
+        str
+            Action.
+        """
+        return self._entity_builders[kind].get_action_from_task_kind(task_kind)
+
+    def get_task_kind_from_action(self, kind: str, action: str) -> list[str]:
+        """
+        Get task kinds from action.
+
+        Parameters
+        ----------
+        kind : str
+            Kind.
+        action : str
+            Action.
+
+        Returns
+        -------
+        list[str]
+            Task kinds.
+        """
+        return self._entity_builders[kind].get_task_kind_from_action(action)
+
+    def get_run_kind(self, kind: str) -> str:
+        """
+        Get run kind.
+
+        Parameters
+        ----------
+        kind : str
+            Kind.
+
+        Returns
+        -------
+        str
+            Run kind.
+        """
+        return self._entity_builders[kind].get_run_kind()
+
+    def get_all_kinds(self, kind: str) -> list[str]:
+        """
+        Get all kinds.
+
+        Parameters
+        ----------
+        kind : str
+            Kind.
+
+        Returns
+        -------
+        list[str]
+            All kinds.
         """
-        if kind not in self._entity_builders:
-            raise BuilderError(f"Builder for kind '{kind}' not found.")
+        return self._entity_builders[kind].get_all_kinds()
 
 
 factory = Factory()

digitalhub/runtimes/_base.py

@@ -1,15 +1,12 @@
 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:
     """
@@ -22,8 +19,7 @@ class Runtime:
     libraries, code, external tools etc.
     """
 
-    def __init__(self, kind_registry: KindRegistry, project: str) -> None:
-        self.kind_registry = kind_registry
+    def __init__(self, project: str) -> None:
         self.project = project
 
     @abstractmethod
@@ -73,7 +69,7 @@ class Runtime:
             raise RuntimeError(msg)
 
         try:
-            return self.get_action_from_task_kind(task_kind)
+            return get_action_from_task_kind(task_kind, task_kind)
         except EntityError:
             msg = f"Task {task_kind} not allowed."
             LOGGER.exception(msg)
@@ -104,61 +100,3 @@ 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

@@ -6,7 +6,6 @@ from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
     from digitalhub.runtimes._base import Runtime
-    from digitalhub.runtimes.kind_registry import KindRegistry
 
 
 class RuntimeBuilder:
@@ -16,15 +15,12 @@ class RuntimeBuilder:
 
     # 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:
+    def build(self, project: str, *args, **kwargs) -> Runtime:
         """
         Build runtime object.
 
@@ -33,4 +29,4 @@ class RuntimeBuilder:
         Runtime
             Runtime object.
         """
-        return self.RUNTIME_CLASS(self.KIND_REGISTRY, *args, **kwargs)
+        return self.RUNTIME_CLASS(project, *args, **kwargs)

{digitalhub-0.8.0b5.dist-info → digitalhub-0.8.0b6.dist-info}/METADATA

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