digitalhub 0.10.2__py3-none-any.whl → 0.11.0b1__py3-none-any.whl

digitalhub/factory/utils.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import importlib
-import importlib.metadata
 import pkgutil
 import re
 from types import ModuleType
@@ -11,17 +10,24 @@ from digitalhub.factory.factory import factory
 
 def import_module(package: str) -> ModuleType:
     """
-    Import modules from package name.
+    Import a module dynamically by package name.
 
     Parameters
     ----------
     package : str
-        Package name.
+        The fully qualified package name to import.
 
     Returns
     -------
     ModuleType
-        Module.
+        The imported module object.
+
+    Raises
+    ------
+    ModuleNotFoundError
+        If the specified package cannot be found.
+    RuntimeError
+        If any other error occurs during import.
     """
     try:
         return importlib.import_module(package)
@@ -33,12 +39,20 @@ def import_module(package: str) -> ModuleType:
 
 def list_runtimes() -> list[str]:
     """
-    List installed runtimes for digitalhub.
+    List all installed DigitalHub runtime packages.
+
+    Scans installed packages for those matching the pattern
+    'digitalhub_runtime_*'.
 
     Returns
     -------
     list[str]
-        List of installed runtimes names.
+        List of runtime package names.
+
+    Raises
+    ------
+    RuntimeError
+        If an error occurs while scanning for runtime packages.
     """
     pattern = r"digitalhub_runtime_.*"
     runtimes: list[str] = []
@@ -53,11 +67,10 @@ def list_runtimes() -> list[str]:
 
 def register_runtimes_entities() -> None:
     """
-    Register runtimes and related entities into registry.
+    Register all runtime builders and their entities into the factory.
 
-    Returns
-    -------
-    None
+    Imports each runtime package and registers its entity and runtime
+    builders with the global factory instance.
     """
     for package in list_runtimes():
         module = import_module(package)
@@ -74,11 +87,15 @@ def register_runtimes_entities() -> None:
 
 def register_entities() -> None:
     """
-    Register layer and related entities into registry.
+    Register core entity builders into the factory.
 
-    Returns
-    -------
-    None
+    Imports the core entities module and registers all entity builders
+    with the global factory instance.
+
+    Raises
+    ------
+    RuntimeError
+        If registration of core entities fails.
     """
     try:
         module = import_module("digitalhub.entities.builders")

digitalhub/runtimes/_base.py

@@ -3,14 +3,14 @@ from __future__ import annotations
 from abc import abstractmethod
 from typing import Any, Callable
 
-from digitalhub.factory.api import get_action_from_task_kind
+from digitalhub.factory.factory import factory
 from digitalhub.utils.exceptions import EntityError
 from digitalhub.utils.logger import LOGGER
 
 
 class Runtime:
     """
-    Base Runtime class.
+    Base Runtime class for executing tasks in the DigitalHub platform.
 
     Runtimes are the entities responsible for the actual execution
     of a given run. They are highly specialized components which
@@ -25,13 +25,13 @@ class Runtime:
     @abstractmethod
     def build(self, executable: dict, task: dict, run: dict) -> dict:
         """
-        Build run spec.
+        Build run specification from executable, task and run configurations.
         """
 
     @abstractmethod
     def run(self, run: dict) -> dict:
         """
-        Execute run task.
+        Execute run task based on the run specification.
         """
 
     ##############################
@@ -40,9 +40,10 @@ class Runtime:
 
     def _validate_task(self, run: dict) -> str:
         """
-        Check if task is allowed. This presumes that the
-        runtime holds a list of allowed actions in the self.allowed_actions
-        attribute.
+        Check if task is allowed by validating against allowed actions.
+
+        This method presumes that the runtime holds a list of allowed actions
+        in the self.allowed_actions attribute.
 
         Parameters
         ----------
@@ -52,7 +53,12 @@ class Runtime:
         Returns
         -------
         str
-            Action to execute.
+            The validated action name to execute.
+
+        Raises
+        ------
+        RuntimeError
+            If the run specification is malformed or task is not allowed.
         """
         try:
             task_kind = run["spec"]["task"].split(":")[0]
@@ -62,7 +68,7 @@ class Runtime:
             raise RuntimeError(msg)
 
         try:
-            return get_action_from_task_kind(task_kind, task_kind)
+            return factory.get_action_from_task_kind(task_kind, task_kind)
         except EntityError:
             msg = f"Task {task_kind} not allowed."
             LOGGER.exception(msg)
@@ -71,7 +77,7 @@ class Runtime:
     @staticmethod
     def _execute(func: Callable, *args, **kwargs) -> Any:
         """
-        Execute function.
+        Execute a function with provided arguments safely.
 
         Parameters
         ----------
@@ -85,7 +91,12 @@ class Runtime:
         Returns
         -------
         Any
-            Function result.
+            Function return value.
+
+        Raises
+        ------
+        RuntimeError
+            If any exception occurs during function execution.
         """
         try:
             return func(*args, **kwargs)

digitalhub/runtimes/builder.py

@@ -10,10 +10,23 @@ if typing.TYPE_CHECKING:
 
 class RuntimeBuilder:
     """
-    Builder class for building runtimes.
+    Builder class for instantiating runtime objects.
+
+    This class implements the Builder pattern to create Runtime instances.
+    Subclasses must set the RUNTIME_CLASS class variable to specify which
+    Runtime implementation to build.
+
+    Attributes
+    ----------
+    RUNTIME_CLASS : Runtime
+        The Runtime class to be instantiated by this builder.
+
+    Raises
+    ------
+    BuilderError
+        If RUNTIME_CLASS is not set in the implementing class.
     """
 
-    # Class variables
     RUNTIME_CLASS: Runtime = None
 
     def __init__(self) -> None:
@@ -27,6 +40,6 @@ class RuntimeBuilder:
         Returns
         -------
         Runtime
-            Runtime object.
+            A new instance of the configured Runtime class.
         """
         return self.RUNTIME_CLASS(project, *args, **kwargs)

digitalhub/runtimes/enums.py

@@ -5,7 +5,17 @@ from enum import Enum
 
 class RuntimeEnvVar(Enum):
     """
-    Environment variables.
+    Environment variables used by runtime execution environments.
+
+    These variables are automatically set in the runtime context
+    and can be accessed during task execution.
+
+    Values
+    ------
+    PROJECT : str
+        Environment variable name for the current project identifier
+    RUN_ID : str
+        Environment variable name for the current run identifier
     """
 
     PROJECT = "PROJECT_NAME"

digitalhub/stores/client/dhcore/client.py

@@ -276,6 +276,7 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
+        self._configurator.check_config()
         if kwargs is None:
             kwargs = {}
         url = self._configurator.build_url(api)

digitalhub/stores/client/dhcore/configurator.py

@@ -31,10 +31,29 @@ class ClientDHCoreConfigurator:
     Configurator object used to configure the client.
     """
 
+    def __init__(self) -> None:
+        self._current_env = configurator.get_current_env()
+
     ##############################
     # Configuration methods
     ##############################
 
+    def check_config(self) -> None:
+        """
+        Check if the config is valid.
+
+        Parameters
+        ----------
+        config : dict
+            Configuration dictionary.
+
+        Returns
+        -------
+        None
+        """
+        if configurator.get_current_env() != self._current_env:
+            self.configure()
+
     def configure(self, config: dict | None = None) -> None:
         """
         Configure the client attributes with config (given or from

digitalhub/stores/client/dhcore/utils.py

@@ -68,4 +68,5 @@ def refresh_token() -> None:
     None
     """
     client: ClientDHCore = get_client(local=False)
+    client._configurator.check_config()
     client._configurator.get_new_access_token()

digitalhub/stores/configurator/configurator.py

@@ -3,7 +3,8 @@ from __future__ import annotations
 import os
 
 from digitalhub.stores.configurator.credentials_store import CredentialsStore
-from digitalhub.stores.configurator.ini_module import load_from_file, write_config
+from digitalhub.stores.configurator.enums import SetCreds
+from digitalhub.stores.configurator.ini_module import load_from_file, read_env_from_file, set_current_env, write_config
 
 
 class EnvConfigurator:
@@ -16,7 +17,7 @@ class EnvConfigurator:
         self._creds_store = CredentialsStore()
 
         # Current credentials set (__default by default)
-        self._environment = "__default"
+        self._environment = os.getenv(SetCreds.DH_ENV.value, SetCreds.DEFAULT.value)
 
     ##############################
     # Public methods
@@ -36,6 +37,7 @@ class EnvConfigurator:
         None
         """
         self._environment = creds_set
+        set_current_env(creds_set)
 
     def get_current_env(self) -> str:
         """
@@ -105,6 +107,7 @@ class EnvConfigurator:
         str | None
             Environment variable value.
         """
+        self._environment = read_env_from_file()
         return load_from_file(var)
 
     def write_env(self, key_to_include: list[str] | None = None) -> None:

digitalhub/stores/configurator/enums.py

@@ -10,3 +10,12 @@ class CredsOrigin(Enum):
 
     ENV = "env"
     FILE = "file"
+
+
+class SetCreds(Enum):
+    """
+    List supported environments.
+    """
+
+    DEFAULT = "__default"
+    DH_ENV = "DH_NAME"

digitalhub/stores/configurator/ini_module.py

@@ -13,6 +13,23 @@ from digitalhub.utils.exceptions import ClientError
 ENV_FILE = Path.home() / ".dhcore.ini"
 
 
+def load_file() -> ConfigParser:
+    """
+    Load current credentials set from the .dhcore.ini file.
+
+    Returns
+    -------
+    ConfigParser
+        Credentials set name.
+    """
+    try:
+        file = ConfigParser()
+        file.read(ENV_FILE)
+        return file
+    except Exception as e:
+        raise ClientError(f"Failed to read env file: {e}")
+
+
 def load_from_file(var: str) -> str | None:
     """
     Load variable from config file.
@@ -29,9 +46,8 @@ def load_from_file(var: str) -> str | None:
     str | None
         Environment variable value.
     """
-    cfg = ConfigParser()
-    cfg.read(ENV_FILE)
     try:
+        cfg = load_file()
         profile = cfg["DEFAULT"]["current_environment"]
         return cfg[profile].get(var)
     except KeyError:
@@ -55,8 +71,7 @@ def write_config(creds: dict, environment: str) -> None:
     None
     """
     try:
-        cfg = ConfigParser()
-        cfg.read(ENV_FILE)
+        cfg = load_file()
 
         sections = cfg.sections()
         if environment not in sections:
@@ -72,3 +87,42 @@ def write_config(creds: dict, environment: str) -> None:
 
     except Exception as e:
         raise ClientError(f"Failed to write env file: {e}")
+
+
+def set_current_env(environment: str) -> None:
+    """
+    Set the current credentials set.
+
+    Parameters
+    ----------
+    environment : str
+        Credentials set name.
+
+    Returns
+    -------
+    None
+    """
+    try:
+        cfg = load_file()
+        cfg["DEFAULT"]["current_environment"] = environment
+        with open(ENV_FILE, "w") as inifile:
+            cfg.write(inifile)
+
+    except Exception as e:
+        raise ClientError(f"Failed to write env file: {e}")
+
+
+def read_env_from_file() -> str:
+    """
+    Read the current credentials set from the .dhcore.ini file.
+
+    Returns
+    -------
+    str
+        Credentials set name.
+    """
+    try:
+        cfg = load_file()
+        return cfg["DEFAULT"]["current_environment"]
+    except Exception as e:
+        raise ClientError(f"Failed to read env file: {e}")

digitalhub/stores/data/api.py

@@ -8,7 +8,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.stores.data._base.store import Store
 
 
-def get_store(project: str, uri: str, config: dict | None = None) -> Store:
+def get_store(project: str, uri: str) -> Store:
     """
     Get store instance by URI.
 
@@ -26,4 +26,4 @@ def get_store(project: str, uri: str, config: dict | None = None) -> Store:
     Store
         Store instance.
     """
-    return store_builder.get(uri, config)
+    return store_builder.get(project, uri)

digitalhub/stores/data/builder.py

@@ -44,9 +44,9 @@ class StoreBuilder:
     """
 
     def __init__(self) -> None:
-        self._instances: dict[str, Store] = {}
+        self._instances: dict[str, dict[str, Store]] = {}
 
-    def build(self, store_type: str, config: dict | None = None) -> None:
+    def build(self, project: str, store_type: str) -> None:
         """
         Build a store instance and register it.
 
@@ -55,7 +55,6 @@ class StoreBuilder:
         store_type : str
             Store type.
         config : dict
-            Store configuration.
 
         Returns
         -------
@@ -64,9 +63,9 @@ class StoreBuilder:
         env = get_current_env()
         if env not in self._instances:
             self._instances[env] = {}
-        self._instances[env][store_type] = _get_class_from_type(store_type)(config)
+        self._instances[env][store_type] = _get_class_from_type(store_type)()
 
-    def get(self, uri: str, config: dict | None = None) -> Store:
+    def get(self, project: str, uri: str) -> Store:
         """
         Get a store instance by URI.
 
@@ -87,7 +86,7 @@ class StoreBuilder:
         try:
             return self._instances[env][store_type]
         except KeyError:
-            self.build(store_type, config)
+            self.build(project, store_type)
             return self._instances[env][store_type]
 
 

digitalhub/stores/data/enums.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class StoreEnv(Enum):
+    """
+    Environment variables for data stores.
+    """
+
+    DEFAULT_FILES_STORE = "DEFAULT_FILES_STORE"

digitalhub/stores/data/local/store.py

@@ -17,9 +17,6 @@ class LocalStore(Store):
     artifacts on local filesystem based storage.
     """
 
-    def __init__(self, config: dict | None = None) -> None:
-        super().__init__()
-
     ##############################
     # I/O methods
     ##############################

digitalhub/stores/data/remote/store.py

@@ -16,9 +16,6 @@ class RemoteStore(Store):
     artifacts from remote HTTP based storage.
     """
 
-    def __init__(self, config: dict | None = None) -> None:
-        super().__init__()
-
     ##############################
     # I/O methods
     ##############################

digitalhub/stores/data/s3/configurator.py

@@ -18,7 +18,6 @@ class S3StoreConfigurator:
         S3StoreEnv.ENDPOINT_URL,
         S3StoreEnv.ACCESS_KEY_ID,
         S3StoreEnv.SECRET_ACCESS_KEY,
-        S3StoreEnv.BUCKET_NAME,
     ]
     optional_vars = [
         S3StoreEnv.REGION,
@@ -26,29 +25,13 @@ class S3StoreConfigurator:
         S3StoreEnv.SESSION_TOKEN,
     ]
 
-    def __init__(self, config: dict | None = None) -> None:
-        self.configure(config)
+    def __init__(self, config: dict) -> None:
+        ...
 
     ##############################
     # Configuration methods
     ##############################
 
-    def configure(self, config: dict | None = None) -> None:
-        """
-        Configure the store by getting the credentials from user
-        provided config or from environment.
-
-        Parameters
-        ----------
-        config : dict
-            Configuration dictionary.
-
-        Returns
-        -------
-        None
-        """
-        self._get_env_config()
-
     def get_boto3_client_config(self, origin: str) -> dict:
         """
         Get S3 credentials (access key, secret key,

digitalhub/stores/data/s3/store.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import typing
 from io import BytesIO
 from pathlib import Path
 from typing import Any, Type
@@ -8,7 +7,7 @@ from urllib.parse import urlparse
 
 import boto3
 import botocore.client  # pylint: disable=unused-import
-from botocore.exceptions import ClientError
+from botocore.exceptions import ClientError, NoCredentialsError
 
 from digitalhub.stores.configurator.enums import CredsOrigin
 from digitalhub.stores.data._base.store import Store
@@ -19,9 +18,6 @@ from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.file_utils import get_file_info_from_s3, get_file_mime_type
 from digitalhub.utils.types import SourcesOrListOfSources
 
-if typing.TYPE_CHECKING:
-    pass
-
 # Type aliases
 S3Client = Type["botocore.client.S3"]
 
@@ -32,10 +28,8 @@ class S3Store(Store):
     artifacts on S3 based storage.
     """
 
-    def __init__(self, config: dict | None = None) -> None:
-        super().__init__()
+    def __init__(self) -> None:
         self._configurator = S3StoreConfigurator()
-        self._configurator.configure(config)
 
     ##############################
     # I/O methods
@@ -655,7 +649,7 @@ class S3Store(Store):
         """
         try:
             client.head_bucket(Bucket=bucket)
-        except ClientError:
+        except (ClientError, NoCredentialsError):
             raise StoreError("No access to s3 bucket!")
 
     @staticmethod

digitalhub/stores/data/sql/configurator.py

@@ -12,31 +12,21 @@ class SqlStoreConfigurator:
     provided config or from environment.
     """
 
-    variables = [SqlStoreEnv.USERNAME, SqlStoreEnv.PASSWORD, SqlStoreEnv.HOST, SqlStoreEnv.PORT, SqlStoreEnv.DATABASE]
+    required_vars = [
+        SqlStoreEnv.USERNAME,
+        SqlStoreEnv.PASSWORD,
+        SqlStoreEnv.HOST,
+        SqlStoreEnv.PORT,
+        SqlStoreEnv.DATABASE,
+    ]
 
-    def __init__(self, config: dict | None = None) -> None:
-        self.configure(config)
+    def __init__(self) -> None:
+        self.config = self.configure()
 
     ##############################
     # Configuration methods
     ##############################
 
-    def configure(self, config: dict | None = None) -> None:
-        """
-        Configure the store by getting the credentials from user
-        provided config or from environment.
-
-        Parameters
-        ----------
-        config : dict
-            Configuration dictionary.
-
-        Returns
-        -------
-        None
-        """
-        self._get_env_config()
-
     def get_sql_conn_string(self, origin: str) -> str:
         """
         Get the connection string from environment variables.
@@ -74,7 +64,7 @@ class SqlStoreConfigurator:
         dict
             The credentials.
         """
-        credentials = {var.value: configurator.load_from_env(var.value) for var in self.variables}
+        credentials = {var.value: configurator.load_from_env(var.value) for var in self.required_vars}
         self._set_credentials(credentials)
         return credentials
 
@@ -87,7 +77,7 @@ class SqlStoreConfigurator:
         dict
             The credentials.
         """
-        credentials = {var.value: configurator.load_from_file(var.value) for var in self.variables}
+        credentials = {var.value: configurator.load_from_file(var.value) for var in self.required_vars}
         self._set_credentials(credentials)
         return credentials
 

digitalhub/stores/data/sql/store.py

@@ -27,10 +27,8 @@ class SqlStore(Store):
     artifacts on SQL based storage.
     """
 
-    def __init__(self, config: dict | None = None) -> None:
-        super().__init__()
+    def __init__(self) -> None:
         self._configurator = SqlStoreConfigurator()
-        self._configurator.configure(config)
 
     ##############################
     # I/O methods