digitalhub 0.13.0b3__py3-none-any.whl → 0.14.9__py3-none-any.whl

digitalhub/stores/{credentials → configurator}/enums.py

@@ -32,25 +32,20 @@ class SetCreds(Enum):
     DH_PROFILE = "DH_NAME"
 
 
-class CredsEnvVar(Enum):
+class ConfigurationVars(Enum):
     """
-    Supported credential environment variables.
+    List of supported configuration variables.
     """
+
     # S3
     S3_ENDPOINT_URL = "AWS_ENDPOINT_URL"
-    S3_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
-    S3_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
-    S3_SESSION_TOKEN = "AWS_SESSION_TOKEN"
     S3_REGION = "AWS_REGION"
     S3_SIGNATURE_VERSION = "S3_SIGNATURE_VERSION"
-    S3_CREDENTIALS_EXPIRATION = "AWS_CREDENTIALS_EXPIRATION"
     S3_PATH_STYLE = "S3_PATH_STYLE"
 
     # SQL
     DB_HOST = "DB_HOST"
     DB_PORT = "DB_PORT"
-    DB_USERNAME = "DB_USERNAME"
-    DB_PASSWORD = "DB_PASSWORD"
     DB_DATABASE = "DB_DATABASE"
     DB_PLATFORM = "DB_PLATFORM"
     DB_PG_SCHEMA = "DB_SCHEMA"
@@ -58,10 +53,32 @@ class CredsEnvVar(Enum):
     # DHCORE
     DHCORE_ENDPOINT = "DHCORE_ENDPOINT"
     DHCORE_ISSUER = "DHCORE_ISSUER"
+    DHCORE_WORKFLOW_IMAGE = "DHCORE_WORKFLOW_IMAGE"
+    DHCORE_CLIENT_ID = "DHCORE_CLIENT_ID"
+    DEFAULT_FILES_STORE = "DHCORE_DEFAULT_FILES_STORE"
+
+    # OAUTH2
+    OAUTH2_TOKEN_ENDPOINT = "OAUTH2_TOKEN_ENDPOINT"
+
+
+class CredentialsVars(Enum):
+    """
+    List of supported credential variables.
+    """
+
+    # S3
+    S3_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
+    S3_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
+    S3_SESSION_TOKEN = "AWS_SESSION_TOKEN"
+    S3_CREDENTIALS_EXPIRATION = "AWS_CREDENTIALS_EXPIRATION"
+
+    # SQL
+    DB_USERNAME = "DB_USERNAME"
+    DB_PASSWORD = "DB_PASSWORD"
+
+    # DHCORE
     DHCORE_USER = "DHCORE_USER"
     DHCORE_PASSWORD = "DHCORE_PASSWORD"
-    DHCORE_CLIENT_ID = "DHCORE_CLIENT_ID"
     DHCORE_ACCESS_TOKEN = "DHCORE_ACCESS_TOKEN"
     DHCORE_REFRESH_TOKEN = "DHCORE_REFRESH_TOKEN"
     DHCORE_PERSONAL_ACCESS_TOKEN = "DHCORE_PERSONAL_ACCESS_TOKEN"
-    DHCORE_WORKFLOW_IMAGE = "DHCORE_WORKFLOW_IMAGE"

digitalhub/stores/configurator/handler.py

@@ -0,0 +1,213 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import os
+from typing import Any
+
+from digitalhub.stores.configurator.enums import ConfigurationVars, CredentialsVars, SetCreds
+from digitalhub.stores.configurator.ini_module import (
+    load_file,
+    load_key,
+    load_profile,
+    set_current_profile,
+    write_file,
+)
+from digitalhub.utils.generic_utils import list_enum
+
+
+class ConfigurationHandler:
+    """
+    Handler for loading and writing configuration variables.
+    """
+
+    def __init__(self):
+        self._current_profile = self._read_current_profile()
+        self._configuration: dict[str, Any] = self.load_configuration()
+        self._credentials: dict[str, Any] = self.load_credentials()
+
+    @staticmethod
+    def _read_env(variables: list) -> dict:
+        """
+        Read configuration variables from the .dhcore file.
+
+        Parameters
+        ----------
+        variables : list
+            List of environment variable names to read.
+
+        Returns
+        -------
+        dict
+            Dictionary of environment variables.
+        """
+        return {var: os.getenv(var) for var in variables}
+
+    @staticmethod
+    def _read_file(variables: list, profile: str) -> dict:
+        """
+        Read configuration variables from the .dhcore file.
+
+        Parameters
+        ----------
+        variables : list
+            List of environment variable names to read.
+        profile : str
+            Profile name to read from.
+
+        Returns
+        -------
+        dict
+            Dictionary of configuration variables.
+        """
+        file = load_file()
+        return {var: load_key(file, profile, var) for var in variables}
+
+    ##############################
+    # Configuration methods
+    ##############################
+
+    def load_configuration(self) -> dict[str, Any]:
+        """
+        Load configuration with env > file precedence.
+
+        Returns
+        -------
+        dict
+            Merged configuration dictionary.
+        """
+        profile = self.get_current_profile()
+        variables = list_enum(ConfigurationVars)
+        env_config = self._read_env(variables)
+        file_config = self._read_file(variables, profile)
+        return {**file_config, **{k: v for k, v in env_config.items() if v is not None}}
+
+    def reload_configuration(self) -> None:
+        """
+        Reload configuration from environment and file.
+        """
+        self._configuration = self.load_configuration()
+
+    def get_configuration(self) -> dict[str, Any]:
+        """
+        Get the merged configuration dictionary.
+
+        Returns
+        -------
+        dict[str, Any]
+            The configuration dictionary.
+        """
+        return self._configuration
+
+    ##############################
+    # Credentials methods
+    ##############################
+
+    def load_credentials(self) -> dict[str, Any]:
+        """
+        Load credentials with file > env precedence.
+
+        Parameters
+        ----------
+        profile : str
+            Profile name to load credentials from.
+
+        Returns
+        -------
+        dict
+            Merged credentials dictionary.
+        """
+        variables = list_enum(CredentialsVars)
+        env_config = self._read_env(variables)
+        file_config = self._read_file(variables, self.get_current_profile())
+        return {**env_config, **{k: v for k, v in file_config.items() if v is not None}}
+
+    def reload_credentials(self) -> None:
+        """
+        Reload credentials from environment and file.
+        """
+        self._credentials = self.load_credentials()
+
+    def reload_credentials_from_env(self) -> None:
+        """
+        Reload credentials from environment where env > file precedence.
+        Its a partial reload only from env variables used as fallback.
+        """
+        variables = list_enum(CredentialsVars)
+        env_config = self._read_env(variables)
+        file_config = self._read_file(variables, self.get_current_profile())
+        self._credentials = {**file_config, **{k: v for k, v in env_config.items() if v is not None}}
+
+    def get_credentials(self) -> dict[str, Any]:
+        """
+        Get the merged credentials dictionary.
+
+        Returns
+        -------
+        dict[str, Any]
+            The credentials dictionary.
+        """
+        return self._credentials
+
+    ##############################
+    # Profile Methods
+    ##############################
+
+    @staticmethod
+    def _read_current_profile() -> str:
+        """
+        Read the current credentials profile name.
+
+        Returns
+        -------
+        str
+            Name of the credentials profile.
+        """
+        profile = os.getenv(SetCreds.DH_PROFILE.value)
+        if profile is not None:
+            return profile
+        file = load_file()
+        profile = load_profile(file)
+        if profile is not None:
+            return profile
+        return SetCreds.DEFAULT.value
+
+    def set_current_profile(self, profile: str) -> None:
+        """
+        Set the current credentials profile name.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile to set.
+        """
+        self._current_profile = profile
+        set_current_profile(profile)
+        self.reload_configuration()
+        self.reload_credentials()
+
+    def get_current_profile(self) -> str:
+        """
+        Get the current credentials profile name.
+
+        Returns
+        -------
+        str
+            Name of the current credentials profile.
+        """
+        return self._current_profile
+
+    def write_file(self, variables: dict) -> None:
+        """
+        Write variables to the .dhcore file for the current profile.
+
+        Parameters
+        ----------
+        infos : dict
+            Information to write.
+        profile : str
+            Profile name to write to.
+        """
+        write_file(variables, self._current_profile)

digitalhub/stores/{credentials → configurator}/ini_module.py

@@ -92,9 +92,6 @@ def write_config(creds: dict, environment: str) -> None:
     environment : str
         Name of the credentials profile/environment.
 
-    Returns
-    -------
-    None
 
     Raises
     ------
@@ -120,6 +117,37 @@ def write_config(creds: dict, environment: str) -> None:
         raise ClientError(f"Failed to write env file: {e}")
 
 
+def write_file(variables: dict, profile: str) -> None:
+    """
+    Write variables to the .dhcore.ini file for the specified profile.
+    Overwrites any existing values for that profile.
+
+    Parameters
+    ----------
+    variables : dict
+        Dictionary of variables to write.
+    profile : str
+        Name of the credentials profile to write to.
+    """
+    try:
+        cfg = load_file()
+
+        sections = cfg.sections()
+        if profile not in sections:
+            cfg.add_section(profile)
+
+        cfg["DEFAULT"]["current_environment"] = profile
+        for k, v in variables.items():
+            cfg[profile][k] = str(v)
+
+        ENV_FILE.touch(exist_ok=True)
+        with open(ENV_FILE, "w") as inifile:
+            cfg.write(inifile)
+
+    except Exception as e:
+        raise ClientError(f"Failed to write env file: {e}")
+
+
 def set_current_profile(environment: str) -> None:
     """
     Set the current credentials profile in the .dhcore.ini file.
@@ -129,9 +157,6 @@ def set_current_profile(environment: str) -> None:
     environment : str
         Name of the credentials profile to set as current.
 
-    Returns
-    -------
-    None
 
     Raises
     ------
@@ -146,19 +171,3 @@ def set_current_profile(environment: str) -> None:
 
     except Exception as e:
         raise ClientError(f"Failed to write env file: {e}")
-
-
-def read_env_from_file() -> str | None:
-    """
-    Read the current credentials profile name from the .dhcore.ini file.
-
-    Returns
-    -------
-    str or None
-        Name of the current credentials profile, or None if not found.
-    """
-    try:
-        cfg = load_file()
-        return cfg["DEFAULT"]["current_environment"]
-    except Exception:
-        return None

digitalhub/stores/data/_base/store.py

@@ -16,7 +16,6 @@ from digitalhub.utils.types import SourcesOrListOfSources
 from digitalhub.utils.uri_utils import has_local_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores.credentials.configurator import Configurator
     from digitalhub.stores.readers.data._base.reader import DataframeReader
 
 
@@ -25,9 +24,6 @@ class Store:
     Store abstract class.
     """
 
-    def __init__(self, configurator: Configurator | None = None) -> None:
-        self._configurator = configurator
-
     ##############################
     # I/O methods
     ##############################
@@ -114,10 +110,6 @@ class Store:
         src : str
             The source path.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError
@@ -135,10 +127,6 @@ class Store:
         dst : str
             The destination path.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError
@@ -158,10 +146,6 @@ class Store:
         overwrite : bool
             Specify if overwrite an existing file.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError
@@ -179,10 +163,6 @@ class Store:
         ----------
         path : str | Path
             The path to build.
-
-        Returns
-        -------
-        None
         """
         if not isinstance(path, Path):
             path = Path(path)

digitalhub/stores/data/api.py

@@ -7,9 +7,9 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.api import get_context
-from digitalhub.stores.credentials.handler import creds_handler
+from digitalhub.stores.configurator.configurator import configurator
+from digitalhub.stores.configurator.enums import ConfigurationVars
 from digitalhub.stores.data.builder import store_builder
-from digitalhub.stores.data.enums import StoreEnv
 
 if typing.TYPE_CHECKING:
     from digitalhub.stores.data._base.store import Store
@@ -34,16 +34,14 @@ def get_default_store(project: str) -> str:
     ValueError
         If no default store is found.
     """
-    var = StoreEnv.DEFAULT_FILES_STORE.value
+    var = ConfigurationVars.DEFAULT_FILES_STORE.value
 
     context = get_context(project)
-    store = context.config.get(var.lower())
+    store = context.config.get(var.lower().replace("dhcore_", ""))
     if store is not None:
         return store
 
-    store = creds_handler.load_from_env([var]).get(var)
-    if store is None:
-        store = creds_handler.load_from_file([var]).get(var)
+    store = configurator.get_configuration().get(var)
 
     if store is None or store == "":
         raise ValueError(

digitalhub/stores/data/builder.py

@@ -8,77 +8,103 @@ import typing
 
 from digitalhub.stores.data.local.store import LocalStore
 from digitalhub.stores.data.remote.store import RemoteStore
-from digitalhub.stores.data.s3.configurator import S3StoreConfigurator
 from digitalhub.stores.data.s3.store import S3Store
-from digitalhub.stores.data.sql.configurator import SqlStoreConfigurator
 from digitalhub.stores.data.sql.store import SqlStore
 from digitalhub.utils.uri_utils import SchemeCategory, map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores.credentials.configurator import Configurator
     from digitalhub.stores.data._base.store import Store
     from digitalhub.utils.exceptions import StoreError
 
 
-class StoreInfo:
-    def __init__(self, store: Store, configurator: Configurator | None = None) -> None:
-        self._store = store
-        self._configurator = configurator
-
-
 class StoreBuilder:
     """
-    Store builder class.
+    Store factory and registry for managing data store instances.
+
+    Provides registration, instantiation, and caching of data store
+    instances based on URI schemes. Supports various store types
+    including S3, SQL, local, and remote stores with their respective
+    configurators.
+
+    Attributes
+    ----------
+    _builders : dict[str, StoreInfo]
+        Registry of store types mapped to their StoreInfo instances.
+    _instances : dict[str, Store]
+        Cache of instantiated store instances by store type.
     """
 
     def __init__(self) -> None:
-        self._builders: dict[str, StoreInfo] = {}
+        self._builders: dict[str, Store] = {}
         self._instances: dict[str, dict[str, Store]] = {}
 
     def register(
         self,
         store_type: str,
         store: Store,
-        configurator: Configurator | None = None,
     ) -> None:
+        """
+        Register a store type with its class and optional configurator.
+
+        Adds a new store type to the builder registry, associating it
+        with a store class and optional configurator for later instantiation.
+
+        Parameters
+        ----------
+        store_type : str
+            The unique identifier for the store type (e.g., 's3', 'sql').
+        store : Store
+            The store class to register for this type.
+        configurator : Configurator
+            The configurator class for store configuration.
+            If None, the store will be instantiated without configuration.
+
+        Raises
+        ------
+        StoreError
+            If the store type is already registered in the builder.
+        """
         if store_type not in self._builders:
-            self._builders[store_type] = StoreInfo(store, configurator)
+            self._builders[store_type] = store
         else:
             raise StoreError(f"Store type {store_type} already registered")
 
     def get(self, uri: str) -> Store:
         """
-        Get a store instance by URI, building it if necessary.
+        Get or create a store instance based on URI scheme.
+
+        Determines the appropriate store type from the URI scheme,
+        instantiates the store if not already cached, and returns
+        the store instance. Store instances are cached for reuse.
 
         Parameters
         ----------
         uri : str
-            URI to parse.
+            The URI to parse for determining the store type.
+            The scheme (e.g., 's3://', 'sql://') determines which
+            store type to instantiate.
 
         Returns
         -------
         Store
-            The store instance.
+            The store instance appropriate for handling the given URI.
+
+        Raises
+        ------
+        KeyError
+            If no store is registered for the URI scheme.
         """
         store_type = map_uri_scheme(uri)
 
         # Build the store instance if not already present
         if store_type not in self._instances:
-            store_info = self._builders[store_type]
-            store_cls = store_info._store
-            cfgrt_cls = store_info._configurator
-
-            if cfgrt_cls is None:
-                store = store_cls()
-            else:
-                store = store_cls(cfgrt_cls())
-            self._instances[store_type] = store
+            self._instances[store_type] = self._builders[store_type]()
 
         return self._instances[store_type]
 
 
 store_builder = StoreBuilder()
-store_builder.register(SchemeCategory.S3.value, S3Store, S3StoreConfigurator)
-store_builder.register(SchemeCategory.SQL.value, SqlStore, SqlStoreConfigurator)
+store_builder.register(SchemeCategory.S3.value, S3Store)
+store_builder.register(SchemeCategory.SQL.value, SqlStore)
 store_builder.register(SchemeCategory.LOCAL.value, LocalStore)
 store_builder.register(SchemeCategory.REMOTE.value, RemoteStore)

digitalhub/stores/data/local/store.py

@@ -4,7 +4,6 @@
 
 from __future__ import annotations
 
-import shutil
 from pathlib import Path
 from typing import Any
 
@@ -180,105 +179,3 @@ class LocalStore(Store):
         reader = get_reader_by_object(df)
         reader.write_df(df, dst, extension=extension, **kwargs)
         return dst
-
-    ##############################
-    # Private I/O methods
-    ##############################
-
-    def _get_src_dst_files(self, src: Path, dst: Path) -> list[str]:
-        """
-        Copy files from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        list[str]
-            Returns the list of destination and source paths of the
-            copied files.
-        """
-        return [self._get_src_dst_file(i, dst) for i in src.rglob("*") if i.is_file()]
-
-    def _get_src_dst_file(self, src: Path, dst: Path) -> str:
-        """
-        Copy file from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        str
-        """
-        dst_pth = self._copy_file(src, dst, True)
-        return str(dst_pth), str(src)
-
-    def _copy_dir(self, src: Path, dst: Path, overwrite: bool) -> list[str]:
-        """
-        Download file from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        list[str]
-        """
-        dst = self._rebuild_path(dst, src)
-        shutil.copytree(src, dst, dirs_exist_ok=overwrite)
-        return [str(i) for i in dst.rglob("*") if i.is_file()]
-
-    def _copy_file(self, src: Path, dst: Path, overwrite: bool) -> str:
-        """
-        Copy file from source to destination.
-
-        Parameters
-        ----------
-        src : Path
-            The source path.
-        dst : Path
-            The destination path.
-
-        Returns
-        -------
-        str
-        """
-        dst = self._rebuild_path(dst, src)
-        self._check_overwrite(dst, overwrite)
-        return str(shutil.copy2(src, dst))
-
-    def _rebuild_path(self, dst: Path, src: Path) -> Path:
-        """
-        Rebuild path.
-
-        Parameters
-        ----------
-        dst : Path
-            The destination path.
-        src : Path
-            The source path.
-
-        Returns
-        -------
-        Path
-            The rebuilt path.
-        """
-        if dst.is_dir():
-            if src.is_absolute():
-                raise StoreError("Source must be a relative path if the destination is a directory.")
-            dst = dst / src
-        self._build_path(dst)
-        return dst

digitalhub/stores/data/remote/store.py

@@ -174,10 +174,6 @@ class RemoteStore(Store):
         src : str
             The source location.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         HTTPError