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

digitalhub/stores/data/sql/configurator.py

@@ -4,81 +4,22 @@
 
 from __future__ import annotations
 
-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 SqlStoreConfigurator(Configurator):
+class SqlStoreConfigurator:
     """
-    SQL store configuration manager for database connections.
-
-    Handles credential management and configuration for SQL database
-    connections. Loads credentials from environment variables or
-    configuration files and provides connection string generation
-    for database access.
-
-    Attributes
-    ----------
-    keys : list[str]
-        List of all supported credential keys for SQL connections.
-    required_keys : list[str]
-        List of mandatory credential keys that must be provided.
+    Configurator class for SQL store configuration and credentials management.
     """
 
-    keys = [
-        CredsEnvVar.DB_USERNAME.value,
-        CredsEnvVar.DB_PASSWORD.value,
-        CredsEnvVar.DB_HOST.value,
-        CredsEnvVar.DB_PORT.value,
-        CredsEnvVar.DB_DATABASE.value,
-        CredsEnvVar.DB_PLATFORM.value,
-    ]
-    required_keys = [
-        CredsEnvVar.DB_USERNAME.value,
-        CredsEnvVar.DB_PASSWORD.value,
-        CredsEnvVar.DB_HOST.value,
-        CredsEnvVar.DB_PORT.value,
-        CredsEnvVar.DB_DATABASE.value,
-    ]
-
     def __init__(self):
-        super().__init__()
-        self.load_configs()
-
-    ##############################
-    # Configuration methods
-    ##############################
-
-    def load_env_vars(self) -> None:
-        """
-        Load database credentials from environment variables.
-
-        Retrieves SQL database connection credentials from the system
-        environment variables and stores them in the configurator's
-        credential handler for use in database connections.
-        """
-        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:
-        """
-        Load database credentials from configuration file.
-
-        Retrieves SQL database connection credentials from a
-        configuration file and stores them in the configurator's
-        credential handler for use in database connections.
-        """
-        file_creds = self._creds_handler.load_from_file(self.keys)
-        self._creds_handler.set_credentials(self._file, file_creds)
+        self._validate()
 
     def get_sql_conn_string(self) -> str:
         """
         Generate PostgreSQL connection string from stored credentials.
 
-        Constructs a PostgreSQL connection string using the configured
-        database credentials including username, password, host, port,
-        and database name.
-
         Returns
         -------
         str
@@ -86,11 +27,11 @@ class SqlStoreConfigurator(Configurator):
             'postgresql://username:password@host:port/database'
         """
         creds = self.get_sql_credentials()
-        user = creds[CredsEnvVar.DB_USERNAME.value]
-        password = creds[CredsEnvVar.DB_PASSWORD.value]
-        host = creds[CredsEnvVar.DB_HOST.value]
-        port = creds[CredsEnvVar.DB_PORT.value]
-        database = creds[CredsEnvVar.DB_DATABASE.value]
+        user = creds[CredentialsVars.DB_USERNAME.value]
+        password = creds[CredentialsVars.DB_PASSWORD.value]
+        host = creds[ConfigurationVars.DB_HOST.value]
+        port = creds[ConfigurationVars.DB_PORT.value]
+        database = creds[ConfigurationVars.DB_DATABASE.value]
         return f"postgresql://{user}:{password}@{host}:{port}/{database}"
 
     def get_sql_credentials(self) -> dict:
@@ -108,5 +49,42 @@ class SqlStoreConfigurator(Configurator):
             Keys correspond to database connection parameters such as
             username, password, host, port, database, and platform.
         """
-        creds = self.get_credentials(self._origin)
-        return {key: creds.get(key) for key in self.keys}
+        keys = [
+            CredentialsVars.DB_USERNAME.value,
+            CredentialsVars.DB_PASSWORD.value,
+            ConfigurationVars.DB_HOST.value,
+            ConfigurationVars.DB_PORT.value,
+            ConfigurationVars.DB_DATABASE.value,
+        ]
+        creds = configurator.get_config_creds()
+        return {key: creds.get(key) for key in keys}
+
+    def eval_retry(self) -> bool:
+        """
+        Evaluate the status of retry lifecycle.
+
+        Returns
+        -------
+        bool
+            True if a retry should be attempted, False otherwise.
+        """
+        return configurator.eval_retry()
+
+    def _validate(self) -> None:
+        """
+        Validate if all required keys are present in the configuration.
+        """
+        required_keys = [
+            ConfigurationVars.DB_HOST.value,
+            ConfigurationVars.DB_PORT.value,
+            ConfigurationVars.DB_DATABASE.value,
+            CredentialsVars.DB_USERNAME.value,
+            CredentialsVars.DB_PASSWORD.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 SQL store: {', '.join(missing_keys)}")

digitalhub/stores/data/sql/store.py

@@ -15,6 +15,7 @@ from sqlalchemy.engine import Engine
 from sqlalchemy.exc import SQLAlchemyError
 
 from digitalhub.stores.data._base.store import Store
+from digitalhub.stores.data.sql.configurator import SqlStoreConfigurator
 from digitalhub.stores.readers.data.api import get_reader_by_object
 from digitalhub.utils.exceptions import ConfigError, StoreError
 from digitalhub.utils.types import SourcesOrListOfSources
@@ -22,8 +23,8 @@ from digitalhub.utils.types import SourcesOrListOfSources
 if typing.TYPE_CHECKING:
     from sqlalchemy.engine.row import Row
 
-    from digitalhub.stores.credentials.configurator import Configurator
-    from digitalhub.stores.data.sql.configurator import SqlStoreConfigurator
+
+ENGINE_CONNECTION_TIMEOUT = 30
 
 
 class SqlStore(Store):
@@ -41,9 +42,9 @@ class SqlStore(Store):
         and connection parameters.
     """
 
-    def __init__(self, configurator: Configurator | None = None) -> None:
-        super().__init__(configurator)
-        self._configurator: SqlStoreConfigurator
+    def __init__(self) -> None:
+        super().__init__()
+        self._configurator: SqlStoreConfigurator = SqlStoreConfigurator()
 
     ##############################
     # I/O methods
@@ -70,7 +71,7 @@ class SqlStore(Store):
         dst : Path
             The destination path on the local filesystem where the
             Parquet file will be saved.
-        overwrite : bool, default False
+        overwrite : bool
             Whether to overwrite existing files at the destination path.
 
         Returns
@@ -159,9 +160,9 @@ class SqlStore(Store):
         path : SourcesOrListOfSources
             The SQL URI path to read from in the format
             'sql://database/schema/table'. Only single paths are supported.
-        file_format : str, optional
+        file_format : str
             File format specification (not used for SQL operations).
-        engine : str, optional
+        engine : str
             DataFrame engine to use (e.g., 'pandas', 'polars').
             If None, uses the default engine.
         **kwargs : dict
@@ -209,7 +210,7 @@ class SqlStore(Store):
         path : str
             The SQL URI path specifying the database connection
             in the format 'sql://database/schema/table'.
-        engine : str, optional
+        engine : str
             DataFrame engine to use for result processing
             (e.g., 'pandas', 'polars'). If None, uses the default.
 
@@ -238,7 +239,7 @@ class SqlStore(Store):
         dst : str
             The destination SQL URI in the format
             'sql://database/schema/table' or 'sql://database/table'.
-        extension : str, optional
+        extension : str
             File extension parameter (not used for SQL operations).
         **kwargs : dict
             Additional keyword arguments passed to the DataFrame's
@@ -350,22 +351,7 @@ class SqlStore(Store):
     # Helper methods
     ##############################
 
-    def _get_connection_string(self) -> str:
-        """
-        Retrieve the database connection string from the configurator.
-
-        Gets the PostgreSQL connection string using the configured
-        database credentials (username, password, host, port, database).
-
-        Returns
-        -------
-        str
-            The PostgreSQL connection string in the format
-            'postgresql://username:password@host:port/database'.
-        """
-        return self._configurator.get_sql_conn_string()
-
-    def _get_engine(self, schema: str | None = None) -> Engine:
+    def _get_engine(self, connection_string: str, schema: str | None = None) -> Engine:
         """
         Create a SQLAlchemy engine from the connection string.
 
@@ -374,7 +360,9 @@ class SqlStore(Store):
 
         Parameters
         ----------
-        schema : str, optional
+        connection_string : str
+            The database connection string.
+        schema : str
             The database schema to set in the search path.
             If provided, sets the PostgreSQL search_path option.
 
@@ -382,57 +370,34 @@ class SqlStore(Store):
         -------
         Engine
             A configured SQLAlchemy engine instance.
-
-        Raises
-        ------
-        StoreError
-            If the connection string is invalid or engine creation fails.
         """
-        connection_string = self._get_connection_string()
-        if not isinstance(connection_string, str):
-            raise StoreError("Connection string must be a string.")
-        try:
-            connect_args = {"connect_timeout": 30}
-            if schema is not None:
-                connect_args["options"] = f"-csearch_path={schema}"
-            return create_engine(connection_string, connect_args=connect_args)
-        except Exception as ex:
-            raise StoreError(f"Something wrong with connection string. Arguments: {str(ex.args)}")
-
-    def _check_factory(self, retry: bool = True, schema: str | None = None) -> Engine:
+        connect_args = {"connect_timeout": ENGINE_CONNECTION_TIMEOUT}
+        if schema is not None:
+            connect_args["options"] = f"-csearch_path={schema}"
+        return create_engine(connection_string, connect_args=connect_args)
+
+    def _check_factory(self, schema: str | None = None) -> Engine:
         """
         Validate database accessibility and return a working engine.
 
-        Creates and tests a database engine, with retry capability if
-        the initial connection fails. Handles configuration changes
-        and ensures the database is accessible before returning.
-
         Parameters
         ----------
-        retry : bool, default True
-            Whether to attempt a retry with different configuration
-            if the initial connection fails.
-        schema : str, optional
+        schema : str
             The database schema to configure in the engine.
 
         Returns
         -------
         Engine
             A validated SQLAlchemy engine with confirmed database access.
-
-        Raises
-        ------
-        ConfigError
-            If database access fails and retry is exhausted or disabled.
         """
+        connection_string = self._configurator.get_sql_conn_string()
+        engine = self._get_engine(connection_string, schema)
         try:
-            engine = self._get_engine(schema)
             self._check_access_to_storage(engine)
             return engine
         except ConfigError as e:
-            if retry:
-                self._configurator.eval_change_origin()
-                return self._check_factory(retry=False, schema=schema)
+            if self._configurator.eval_retry():
+                return self._check_factory(schema=schema)
             raise e
 
     @staticmethod

digitalhub/utils/generic_utils.py

@@ -95,10 +95,6 @@ def requests_chunk_download(source: str, filename: Path) -> None:
         URL to download the file from.
     filename : Path
         Path where to save the downloaded file.
-
-    Returns
-    -------
-    None
     """
     with requests.get(source, stream=True) as r:
         r.raise_for_status()
@@ -117,10 +113,6 @@ def extract_archive(path: Path, filename: Path) -> None:
         Directory where to extract the archive.
     filename : Path
         Path to the zip archive file.
-
-    Returns
-    -------
-    None
     """
     with ZipFile(filename, "r") as zip_file:
         zip_file.extractall(path)
@@ -256,10 +248,6 @@ def carriage_return_warn(string: str) -> None:
     ----------
     string : str
         The string to check.
-
-    Returns
-    -------
-    None
     """
     if "\r\n" in string:
         warn("String contains a carriage return. It may not be parsed correctly from remote runtimes.")

digitalhub/utils/git_utils.py

@@ -47,10 +47,6 @@ def clone_repository(path: Path, url: str) -> None:
         Path where to save the repository.
     url : str
         URL of the repository.
-
-    Returns
-    -------
-    None
     """
     clean_path(path)
     checkout_object = get_checkout_object(url)
@@ -85,10 +81,6 @@ def clean_path(path: Path) -> None:
     ----------
     path : Path
         Path to clean.
-
-    Returns
-    -------
-    None
     """
 
     shutil.rmtree(path, ignore_errors=True)

digitalhub/utils/io_utils.py

@@ -23,10 +23,6 @@ def write_yaml(filepath: str | Path, obj: dict | list[dict]) -> None:
         The YAML file path to write.
     obj : dict or list of dict
         The dict or list of dicts to write.
-
-    Returns
-    -------
-    None
     """
     if isinstance(obj, list):
         with open(filepath, "w", encoding="utf-8") as out_file:
@@ -46,10 +42,6 @@ def write_text(filepath: Path, text: str) -> None:
         The file path to write.
     text : str
         The text to write.
-
-    Returns
-    -------
-    None
     """
     filepath.write_text(text, encoding="utf-8")
 

digitalhub/utils/store_utils.py

@@ -32,7 +32,7 @@ def get_sql_engine(schema: str | None = None) -> Engine:
 
     Parameters
     ----------
-    schema : str, optional
+    schema : str
         The schema to connect to, by default None.
 
     Returns

{digitalhub-0.14.0b5.dist-info → digitalhub-0.14.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.14.0b5
+Version: 0.14.9
 Summary: Python SDK for Digitalhub
 Project-URL: Homepage, https://github.com/scc-digitalhub/digitalhub-sdk
 Author-email: Fondazione Bruno Kessler <digitalhub@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
@@ -230,10 +230,10 @@ Requires-Dist: jsonschema; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Provides-Extra: full
-Requires-Dist: mlflow; extra == 'full'
+Requires-Dist: mlflow==2.19; extra == 'full'
 Requires-Dist: pandas; extra == 'full'
 Provides-Extra: mlflow
-Requires-Dist: mlflow; extra == 'mlflow'
+Requires-Dist: mlflow==2.19; extra == 'mlflow'
 Provides-Extra: pandas
 Requires-Dist: pandas; extra == 'pandas'
 Description-Content-Type: text/markdown