digitalhub 0.14.0b5__py3-none-any.whl → 0.14.9__py3-none-any.whl

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
     ------

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
     ##############################

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().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,38 +8,15 @@ 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:
-    """
-    Container for store class and configurator information.
-
-    Holds store class references and their associated configurators
-    for registration and instantiation in the store builder system.
-
-    Attributes
-    ----------
-    _store : Store
-        The store class to be instantiated.
-    _configurator : Configurator or None
-        The configurator class for store configuration, if required.
-    """
-
-    def __init__(self, store: Store, configurator: Configurator | None = None) -> None:
-        self._store = store
-        self._configurator = configurator
-
-
 class StoreBuilder:
     """
     Store factory and registry for managing data store instances.
@@ -58,14 +35,13 @@ class StoreBuilder:
     """
 
     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.
@@ -79,7 +55,7 @@ class StoreBuilder:
             The unique identifier for the store type (e.g., 's3', 'sql').
         store : Store
             The store class to register for this type.
-        configurator : Configurator, optional
+        configurator : Configurator
             The configurator class for store configuration.
             If None, the store will be instantiated without configuration.
 
@@ -89,7 +65,7 @@ class StoreBuilder:
             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")
 
@@ -122,21 +98,13 @@ class StoreBuilder:
 
         # 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/s3/configurator.py

@@ -4,75 +4,28 @@
 
 from __future__ import annotations
 
-from datetime import datetime, timedelta, timezone
-
 from botocore.config import Config
 
-from digitalhub.stores.client.dhcore.utils import refresh_token
-from digitalhub.stores.credentials.configurator import Configurator
-from digitalhub.stores.credentials.enums import CredsEnvVar
+from digitalhub.stores.configurator.configurator import configurator
+from digitalhub.stores.configurator.enums import ConfigurationVars, CredentialsVars
 
 
-class S3StoreConfigurator(Configurator):
+class S3StoreConfigurator:
     """
-    Configure the store by getting the credentials from user
-    provided config or from environment.
+    Configurator class for S3 store configuration and credentials management.
     """
 
-    keys = [
-        CredsEnvVar.S3_ENDPOINT_URL.value,
-        CredsEnvVar.S3_ACCESS_KEY_ID.value,
-        CredsEnvVar.S3_SECRET_ACCESS_KEY.value,
-        CredsEnvVar.S3_REGION.value,
-        CredsEnvVar.S3_SIGNATURE_VERSION.value,
-        CredsEnvVar.S3_SESSION_TOKEN.value,
-        CredsEnvVar.S3_PATH_STYLE.value,
-        CredsEnvVar.S3_CREDENTIALS_EXPIRATION.value,
-    ]
-    required_keys = [
-        CredsEnvVar.S3_ENDPOINT_URL.value,
-        CredsEnvVar.S3_ACCESS_KEY_ID.value,
-        CredsEnvVar.S3_SECRET_ACCESS_KEY.value,
-    ]
-
     def __init__(self):
-        super().__init__()
-        self.load_configs()
+        self._validate()
 
     ##############################
     # Configuration methods
     ##############################
 
-    def load_env_vars(self) -> None:
-        """
-        Loads the credentials from the environment variables.
-        """
-        env_creds = self._creds_handler.load_from_env(self.keys)
-        self._creds_handler.set_credentials(self._env, env_creds)
-
-    def load_file_vars(self) -> None:
-        """
-        Loads the credentials from a file.
-        """
-        file_creds = self._creds_handler.load_from_file(self.keys)
-        self._creds_handler.set_credentials(self._file, file_creds)
-
     def get_client_config(self) -> dict:
         """
         Gets S3 credentials (access key, secret key, session token, and other config).
 
-        Returns
-        -------
-        dict
-            Dictionary containing S3 credentials and configuration.
-        """
-        creds = self.evaluate_credentials()
-        return self.get_creds_dict(creds)
-
-    def get_creds_dict(self, creds: dict) -> dict:
-        """
-        Returns a dictionary containing the S3 credentials.
-
         Parameters
         ----------
         creds : dict
@@ -83,79 +36,42 @@ class S3StoreConfigurator(Configurator):
         dict
             A dictionary containing the S3 credentials.
         """
+        creds = configurator.get_config_creds()
         return {
-            "endpoint_url": creds[CredsEnvVar.S3_ENDPOINT_URL.value],
-            "aws_access_key_id": creds[CredsEnvVar.S3_ACCESS_KEY_ID.value],
-            "aws_secret_access_key": creds[CredsEnvVar.S3_SECRET_ACCESS_KEY.value],
-            "aws_session_token": creds[CredsEnvVar.S3_SESSION_TOKEN.value],
+            "endpoint_url": creds[ConfigurationVars.S3_ENDPOINT_URL.value],
+            "aws_access_key_id": creds[CredentialsVars.S3_ACCESS_KEY_ID.value],
+            "aws_secret_access_key": creds[CredentialsVars.S3_SECRET_ACCESS_KEY.value],
+            "aws_session_token": creds[CredentialsVars.S3_SESSION_TOKEN.value],
             "config": Config(
-                region_name=creds[CredsEnvVar.S3_REGION.value],
-                signature_version=creds[CredsEnvVar.S3_SIGNATURE_VERSION.value],
+                region_name=creds[ConfigurationVars.S3_REGION.value],
+                signature_version=creds[ConfigurationVars.S3_SIGNATURE_VERSION.value],
             ),
         }
 
-    def evaluate_credentials(self) -> dict:
-        """
-        Evaluates and returns the current valid credentials.
-        If the credentials are expired and were loaded from file,
-        it refreshes them.
-
-        Returns
-        -------
-        dict
-            The current valid credentials.
-        """
-        creds = self.get_credentials(self._origin)
-        expired = creds[CredsEnvVar.S3_CREDENTIALS_EXPIRATION.value]
-        if self._origin == self._file and self._is_expired(expired):
-            refresh_token()
-            self.load_file_vars()
-            creds = self.get_credentials(self._origin)
-        return creds
-
-    def get_file_config(self) -> dict:
-        """
-        Returns the credentials loaded from file.
-
-        Returns
-        -------
-        dict
-            The credentials loaded from file.
-        """
-        creds = self.get_credentials(self._file)
-        return self.get_creds_dict(creds)
-
-    def get_env_config(self) -> dict:
+    def _validate(self) -> None:
         """
-        Returns the credentials loaded from environment variables.
-
-        Returns
-        -------
-        dict
-            The credentials loaded from environment variables.
+        Validate if all required keys are present in the configuration.
         """
-        creds = self.get_credentials(self._env)
-        return self.get_creds_dict(creds)
+        required_keys = [
+            ConfigurationVars.S3_ENDPOINT_URL.value,
+            CredentialsVars.S3_ACCESS_KEY_ID.value,
+            CredentialsVars.S3_SECRET_ACCESS_KEY.value,
+        ]
+        current_keys = configurator.get_config_creds()
+        missing_keys = []
+        for key in required_keys:
+            if key not in current_keys or current_keys[key] is None:
+                missing_keys.append(key)
+        if missing_keys:
+            raise ValueError(f"Missing required variables for S3 store: {', '.join(missing_keys)}")
 
-    @staticmethod
-    def _is_expired(timestamp: str | None) -> bool:
+    def eval_retry(self) -> bool:
         """
-        Determines whether a given timestamp is after the current UTC time.
-
-        Parameters
-        ----------
-        timestamp : str or None
-            Timestamp string in the format 'YYYY-MM-DDTHH:MM:SSZ'.
+        Evaluate the status of retry lifecycle.
 
         Returns
         -------
         bool
-            True if the given timestamp is later than the current UTC time,
-            otherwise False.
+            True if a retry action was performed, otherwise False.
         """
-        if timestamp is None:
-            return False
-        dt = datetime.strptime(timestamp, "%Y-%m-%dT%H:%M:%SZ")
-        dt = dt.replace(tzinfo=timezone.utc)
-        now = datetime.now(timezone.utc) + timedelta(seconds=120)
-        return dt < now
+        return configurator.eval_retry()

digitalhub/stores/data/s3/store.py

@@ -4,7 +4,6 @@
 
 from __future__ import annotations
 
-import typing
 from io import BytesIO
 from pathlib import Path
 from typing import Any, Type
@@ -16,16 +15,12 @@ from boto3.s3.transfer import TransferConfig
 from botocore.exceptions import ClientError, NoCredentialsError
 
 from digitalhub.stores.data._base.store import Store
+from digitalhub.stores.data.s3.configurator import S3StoreConfigurator
 from digitalhub.stores.readers.data.api import get_reader_by_object
 from digitalhub.utils.exceptions import ConfigError, 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:
-    from digitalhub.stores.credentials.configurator import Configurator
-    from digitalhub.stores.data.s3.configurator import S3StoreConfigurator
-
-
 # Type aliases
 S3Client = Type["botocore.client.S3"]
 
@@ -38,9 +33,9 @@ class S3Store(Store):
     artifacts on S3 based storage.
     """
 
-    def __init__(self, configurator: Configurator | None = None) -> None:
-        super().__init__(configurator)
-        self._configurator: S3StoreConfigurator
+    def __init__(self) -> None:
+        super().__init__()
+        self._configurator: S3StoreConfigurator = S3StoreConfigurator()
 
     ##############################
     # I/O methods
@@ -646,7 +641,7 @@ class S3Store(Store):
         """
         return boto3.client("s3", **cfg)
 
-    def _check_factory(self, s3_path: str, retry: bool = True) -> tuple[S3Client, str]:
+    def _check_factory(self, s3_path: str) -> tuple[S3Client, str]:
         """
         Checks if the S3 bucket collected from the URI is accessible.
 
@@ -654,29 +649,21 @@ class S3Store(Store):
         ----------
         s3_path : str
             Path to the S3 bucket (e.g., 's3://bucket/path').
-        retry : bool, optional
-            Whether to retry the operation if a ConfigError is raised. Default is True.
 
         Returns
         -------
         tuple of S3Client and str
             Tuple containing the S3 client object and the name of the S3 bucket.
-
-        Raises
-        ------
-        ConfigError
-            If access to the specified bucket is not available and retry is False.
         """
         bucket = self._get_bucket(s3_path)
+        cfg = self._configurator.get_client_config()
+        client = self._get_client(cfg)
         try:
-            cfg = self._configurator.get_client_config()
-            client = self._get_client(cfg)
             self._check_access_to_storage(client, bucket)
             return client, bucket
         except ConfigError as e:
-            if retry:
-                self._configurator.eval_change_origin()
-                return self._check_factory(s3_path, False)
+            if self._configurator.eval_retry():
+                return self._check_factory(s3_path)
             raise e
 
     def _check_access_to_storage(self, client: S3Client, bucket: str) -> None: