digitalhub 0.13.0b2__py3-none-any.whl → 0.13.0b4__py3-none-any.whl

digitalhub/stores/credentials/handler.py

@@ -7,104 +7,132 @@ from __future__ import annotations
 import os
 
 from digitalhub.stores.credentials.enums import SetCreds
-from digitalhub.stores.credentials.ini_module import load_from_file, read_env_from_file, set_current_env, write_config
+from digitalhub.stores.credentials.ini_module import (
+    load_file,
+    load_key,
+    load_profile,
+    set_current_profile,
+    write_config,
+)
 from digitalhub.stores.credentials.store import CredentialsStore
 
 
 class CredentialHandler:
     """
-    Configurator object used to configure clients and store credentials.
+    Handler for configuring clients and managing credentials.
+
+    Attributes
+    ----------
+    _creds_store : CredentialsStore
+        Store for credentials.
+    _profile : str
+        Current credentials profile name.
     """
 
     def __init__(self) -> None:
-        # Store
         self._creds_store = CredentialsStore()
+        self._profile = self._read_current_profile()
 
-        # Current credentials set (__default by default)
-        self._environment = os.getenv(SetCreds.DH_ENV.value, SetCreds.DEFAULT.value)
+    @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
 
     ##############################
     # Public methods
     ##############################
 
-    def set_current_env(self, creds_set: str) -> None:
+    def set_current_profile(self, creds_set: str) -> None:
         """
-        Set the current credentials set.
+        Set the current credentials profile name.
 
         Parameters
         ----------
         creds_set : str
-            Credentials set name.
+            Name of the credentials profile to set.
 
         Returns
         -------
         None
         """
-        self._environment = creds_set
-        set_current_env(creds_set)
+        self._profile = creds_set
+        set_current_profile(creds_set)
 
-    def get_current_env(self) -> str:
+    def get_current_profile(self) -> str:
         """
-        Get the current credentials set.
+        Get the current credentials profile name.
 
         Returns
         -------
         str
-            Credentials set name.
+            Name of the current credentials profile.
         """
-        return self._environment
+        return self._profile
 
-    def load_from_env(self, var: str) -> str | None:
+    def load_from_env(self, vars: list[str]) -> dict:
         """
-        Load variable from env.
+        Load variables from environment.
 
         Parameters
         ----------
-        var : str
-            Environment variable name.
+        vars : list of str
+            List of environment variable names to load.
 
         Returns
         -------
-        str | None
-            Environment variable value.
+        dict
+            Dictionary of environment variable values.
         """
-        env_var = os.getenv(var)
-        if env_var != "":
-            return env_var
+        return {var: os.getenv(var) for var in vars}
 
-    def load_from_file(self, var: str) -> str | None:
+    def load_from_file(self, vars: list[str]) -> dict:
         """
-        Load variable from config file.
+        Load variables from credentials config file.
 
         Parameters
         ----------
-        var : str
-            Environment variable name.
+        vars : list of str
+            List of variable names to load from file.
 
         Returns
         -------
-        str | None
-            Environment variable value.
+        dict
+            Dictionary of variable values from file.
         """
-        env_from_file = read_env_from_file()
-        if env_from_file is not None:
-            self._environment = env_from_file
-        return load_from_file(var)
+        file = load_file()
+        profile = load_profile(file)
+        if profile is not None:
+            self._profile = profile
+        return {var: load_key(file, self._profile, var) for var in vars}
 
     def write_env(self, creds: dict) -> None:
         """
-        Write the env variables to the .dhcore file.
+        Write credentials to the .dhcore file for the current profile.
 
         Parameters
         ----------
         creds : dict
-            Credentials.
+            Credentials to write.
 
         Returns
         -------
         None
         """
-        write_config(creds, self._environment)
+        write_config(creds, self._profile)
 
     ##############################
     # Credentials store methods
@@ -112,37 +140,37 @@ class CredentialHandler:
 
     def set_credentials(self, origin: str, creds: dict) -> None:
         """
-        Set credentials.
+        Set credentials for the current profile and origin.
 
         Parameters
         ----------
         origin : str
-            The origin of the credentials.
+            The origin of the credentials ('env' or 'file').
         creds : dict
-            The credentials.
+            Credentials to set.
 
         Returns
         -------
         None
         """
-        self._creds_store.set_credentials(self._environment, origin, creds)
+        self._creds_store.set_credentials(self._profile, origin, creds)
 
     def get_credentials(self, origin: str) -> dict:
         """
-        Get credentials from origin.
+        Get credentials for the current profile from the specified origin.
 
         Parameters
         ----------
         origin : str
-            The origin of the credentials.
+            The origin to get credentials from ('env' or 'file').
 
         Returns
         -------
         dict
-            The credentials.
+            Dictionary of credentials.
         """
-        return self._creds_store.get_credentials(self._environment, origin)
+        return self._creds_store.get_credentials(self._profile, origin)
 
 
-# Define global configurator
+# Define global credential handler
 creds_handler = CredentialHandler()

digitalhub/stores/credentials/ini_module.py

@@ -9,22 +9,23 @@ from pathlib import Path
 
 from digitalhub.utils.exceptions import ClientError
 
-# File where to write DHCORE_ACCESS_TOKEN and DHCORE_REFRESH_TOKEN
-# It's used because we inject the variables in jupyter env,
-# but refresh token is only available once. Is it's used, we cannot
-# overwrite it with coder, so we need to store the new one in a file,
-# preserved for jupyter restart
+# File where to write credementials
 ENV_FILE = Path.home() / ".dhcore.ini"
 
 
 def load_file() -> ConfigParser:
     """
-    Load current credentials set from the .dhcore.ini file.
+    Load the credentials configuration from the .dhcore.ini file.
 
     Returns
     -------
     ConfigParser
-        Credentials set name.
+        Parsed configuration file object.
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be read.
     """
     try:
         file = ConfigParser()
@@ -34,45 +35,71 @@ def load_file() -> ConfigParser:
         raise ClientError(f"Failed to read env file: {e}")
 
 
-def load_from_file(var: str) -> str | None:
+def load_profile(file: ConfigParser) -> str | None:
     """
-    Load variable from config file.
+    Load the current credentials profile name from the .dhcore.ini file.
 
     Parameters
     ----------
+    file : ConfigParser
+        Parsed configuration file object.
+
+    Returns
+    -------
+    str or None
+        Name of the credentials profile, or None if not found.
+    """
+    try:
+        return file["DEFAULT"]["current_environment"]
+    except KeyError:
+        return
+
+
+def load_key(file: ConfigParser, profile: str, key: str) -> str | None:
+    """
+    Load a specific key value from the credentials profile in the
+    .dhcore.ini file.
+
+    Parameters
+    ----------
+    file : ConfigParser
+        Parsed configuration file object.
     profile : str
-        Credentials set name.
-    var : str
-        Environment variable name.
+        Name of the credentials profile.
+    key : str
+        Name of the key to retrieve.
 
     Returns
     -------
-    str | None
-        Environment variable value.
+    str or None
+        Value of the key, or None if not found.
     """
     try:
-        cfg = load_file()
-        profile = cfg["DEFAULT"]["current_environment"]
-        return cfg[profile].get(var)
+        return file[profile][key]
     except KeyError:
         return
 
 
 def write_config(creds: dict, environment: str) -> None:
     """
-    Write the env variables to the .dhcore.ini file.
-    It will overwrite any existing env variables.
+    Write credentials to the .dhcore.ini file for the specified environment.
+    Overwrites any existing values for that environment.
 
     Parameters
     ----------
     creds : dict
-        Credentials.
+        Dictionary of credentials to write.
     environment : str
-        Credentials set name.
+        Name of the credentials profile/environment.
 
     Returns
     -------
     None
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be written.
     """
     try:
         cfg = load_file()
@@ -93,18 +120,23 @@ def write_config(creds: dict, environment: str) -> None:
         raise ClientError(f"Failed to write env file: {e}")
 
 
-def set_current_env(environment: str) -> None:
+def set_current_profile(environment: str) -> None:
     """
-    Set the current credentials set.
+    Set the current credentials profile in the .dhcore.ini file.
 
     Parameters
     ----------
     environment : str
-        Credentials set name.
+        Name of the credentials profile to set as current.
 
     Returns
     -------
     None
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be written.
     """
     try:
         cfg = load_file()
@@ -118,12 +150,12 @@ def set_current_env(environment: str) -> None:
 
 def read_env_from_file() -> str | None:
     """
-    Read the current credentials set from the .dhcore.ini file.
+    Read the current credentials profile name from the .dhcore.ini file.
 
     Returns
     -------
-    str
-        Credentials set name.
+    str or None
+        Name of the current credentials profile, or None if not found.
     """
     try:
         cfg = load_file()

digitalhub/stores/credentials/store.py

@@ -11,7 +11,14 @@ from digitalhub.stores.credentials.enums import CredsOrigin
 
 class CredentialsStore:
     """
-    Credentials store to store and retrieve credentials.
+    Store and retrieve credentials for different profiles and origins.
+
+    Attributes
+    ----------
+    _file_creds : dict of str to dict
+        Credentials stored by profile from file origin.
+    _env_creds : dict of str to Any
+        Credentials stored from environment origin.
     """
 
     def __init__(self) -> None:
@@ -26,6 +33,19 @@ class CredentialsStore:
     ) -> None:
         """
         Set all credentials for a given profile and origin.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile.
+        origin : str
+            Origin of the credentials ('env' or 'file').
+        credentials : dict of str to Any
+            Dictionary of credentials to set.
+
+        Returns
+        -------
+        None
         """
         if origin == CredsOrigin.ENV.value:
             for key, value in credentials.items():
@@ -43,6 +63,18 @@ class CredentialsStore:
     ) -> dict[str, Any]:
         """
         Get all credentials for a given profile and origin.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile.
+        origin : str
+            Origin of the credentials ('env' or 'file').
+
+        Returns
+        -------
+        dict of str to Any
+            Dictionary of credentials for the profile and origin.
         """
         if origin == CredsOrigin.ENV.value:
             return self._env_creds

digitalhub/stores/data/_base/store.py

@@ -186,9 +186,14 @@ class Store:
         """
         if not isinstance(path, Path):
             path = Path(path)
-        if path.suffix != "":
-            path = path.parent
-        path.mkdir(parents=True, exist_ok=True)
+        # If the path does not exist, we need to infer if it's a file or directory
+        if path.suffix and not path.name.startswith("."):
+            # Looks like a file, use parent
+            dir_path = path.parent
+        else:
+            # Looks like a directory (even if it contains dots)
+            dir_path = path
+        dir_path.mkdir(parents=True, exist_ok=True)
 
     @staticmethod
     def _build_temp() -> Path:

digitalhub/stores/data/api.py

@@ -17,53 +17,57 @@ if typing.TYPE_CHECKING:
 
 def get_default_store(project: str) -> str:
     """
-    Get default store URI.
+    Returns the default store URI for a given project.
 
     Parameters
     ----------
     project : str
-        Project name.
+        The name of the project.
 
     Returns
     -------
     str
-        Default store URI.
+        The default store URI.
+
+    Raises
+    ------
+    ValueError
+        If no default store is found.
     """
+    var = StoreEnv.DEFAULT_FILES_STORE.value
+
     context = get_context(project)
-    store = context.config.get(StoreEnv.DEFAULT_FILES_STORE.value.lower())
+    store = context.config.get(var.lower().replace("dhcore_", ""))
     if store is not None:
         return store
 
-    store = creds_handler.load_from_env(StoreEnv.DEFAULT_FILES_STORE.value)
+    store = creds_handler.load_from_env([var]).get(var)
     if store is None:
-        store = creds_handler.load_from_file(StoreEnv.DEFAULT_FILES_STORE.value)
+        store = creds_handler.load_from_file([var]).get(var)
 
     if store is None or store == "":
         raise ValueError(
             "No default store found. "
             "Please set a default store "
-            f"in your environment (e.g. export {StoreEnv.DEFAULT_FILES_STORE.value}=) "
+            f"in your environment (e.g. export {var}=) "
+            " in the .dhcore.ini file "
             "or set it in project config."
         )
     return store
 
 
-def get_store(project: str, uri: str) -> Store:
+def get_store(uri: str) -> Store:
     """
-    Get store instance by URI.
+    Returns a store instance for the given URI.
 
     Parameters
-    ---------
-    project : str
-        Project name.
+    ----------
     uri : str
-        URI to parse.
-    config : dict
-        Store configuration.
+        The URI to parse.
 
     Returns
     -------
     Store
-        Store instance.
+        The store instance corresponding to the URI.
     """
     return store_builder.get(uri)

digitalhub/stores/data/builder.py

@@ -6,7 +6,6 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.stores.credentials.api import get_current_env
 from digitalhub.stores.data.local.store import LocalStore
 from digitalhub.stores.data.remote.store import RemoteStore
 from digitalhub.stores.data.s3.configurator import S3StoreConfigurator
@@ -22,6 +21,20 @@ if typing.TYPE_CHECKING:
 
 
 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
@@ -29,7 +42,19 @@ class StoreInfo:
 
 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:
@@ -42,6 +67,31 @@ class StoreBuilder:
         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, optional
+            The configurator class for store configuration.
+            If None, the store will be instantiated without configuration.
+
+        Returns
+        -------
+        None
+
+        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)
         else:
@@ -49,27 +99,33 @@ class StoreBuilder:
 
     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.
         """
-        env_profile = get_current_env()
         store_type = map_uri_scheme(uri)
 
-        # Ensure env exists in _instances
-        if env_profile not in self._instances:
-            self._instances[env_profile] = {}
-
         # Build the store instance if not already present
-        if store_type not in self._instances[env_profile]:
+        if store_type not in self._instances:
             store_info = self._builders[store_type]
             store_cls = store_info._store
             cfgrt_cls = store_info._configurator
@@ -78,9 +134,9 @@ class StoreBuilder:
                 store = store_cls()
             else:
                 store = store_cls(cfgrt_cls())
-            self._instances[env_profile][store_type] = store
+            self._instances[store_type] = store
 
-        return self._instances[env_profile][store_type]
+        return self._instances[store_type]
 
 
 store_builder = StoreBuilder()