digitalhub 0.14.0b5__py3-none-any.whl → 0.14.0b7__py3-none-any.whl

digitalhub/stores/client/dhcore/http_handler.py

@@ -0,0 +1,133 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from requests import request
+
+from digitalhub.stores.client.dhcore.configurator import ClientDHCoreConfigurator
+from digitalhub.stores.client.dhcore.response_processor import ResponseProcessor
+from digitalhub.utils.exceptions import BackendError
+
+# Default timeout for requests (in seconds)
+DEFAULT_TIMEOUT = 60
+
+
+class HttpRequestHandler:
+    """
+    Handles HTTP request execution for DHCore client.
+
+    Encapsulates all HTTP communication logic including request execution,
+    automatic token refresh on authentication failures, and response processing.
+    Works in coordination with configurator for authentication and response
+    processor for parsing.
+    """
+
+    def __init__(self) -> None:
+        self._configurator = ClientDHCoreConfigurator()
+        self._response_processor = ResponseProcessor()
+
+    def prepare_request(self, method: str, api: str, **kwargs) -> dict:
+        """
+        Execute API call with full URL construction and authentication.
+
+        Parameters
+        ----------
+        method : str
+            HTTP method type (GET, POST, PUT, DELETE, etc.).
+        api : str
+            API endpoint path to call.
+        **kwargs : dict
+            Additional HTTP request arguments.
+
+        Returns
+        -------
+        dict
+            Response from the API call.
+        """
+        full_kwargs = self._set_auth(**kwargs)
+        url = self._build_url(api)
+        return self._execute_request(method, url, **full_kwargs)
+
+    def _execute_request(
+        self,
+        method: str,
+        url: str,
+        refresh: bool = True,
+        **kwargs,
+    ) -> dict:
+        """
+        Execute HTTP request with automatic handling.
+
+        Sends HTTP request with authentication, handles token refresh on 401 errors,
+        validates API version compatibility, and parses response. Uses 60-second
+        timeout by default.
+
+        Parameters
+        ----------
+        method : str
+            HTTP method (GET, POST, PUT, DELETE, etc.).
+        url : str
+            Complete URL to request.
+        refresh : bool, default True
+            Whether to attempt token refresh on authentication errors.
+            Set to False during refresh to prevent infinite recursion.
+        **kwargs : dict
+            Additional HTTP request arguments (headers, params, data, etc.).
+
+        Returns
+        -------
+        dict
+            Parsed response body as dictionary.
+        """
+        # Execute HTTP request
+        response = request(method, url, timeout=DEFAULT_TIMEOUT, **kwargs)
+
+        # Process response (version check, error parsing, dictify)
+        try:
+            return self._response_processor.process(response)
+        except BackendError as e:
+            # Handle authentication errors with token refresh
+            if response.status_code == 401 and refresh and self._configurator.refreshable_auth_types():
+                self._configurator.refresh_credentials(change_origin=True)
+                kwargs = self._configurator.get_auth_parameters(kwargs)
+                return self._execute_request(method, url, refresh=False, **kwargs)
+            raise e
+
+    def _set_auth(self, **kwargs) -> dict:
+        """
+        Prepare kwargs with authentication parameters.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Request parameters to augment with authentication.
+
+        Returns
+        -------
+        dict
+            kwargs enhanced with authentication parameters.
+        """
+        self._configurator.check_config()
+        return self._configurator.get_auth_parameters(kwargs)
+
+    def _build_url(self, api: str) -> str:
+        """
+        Build complete URL for API call.
+
+        Combines configured endpoint with API path, automatically removing
+        leading slashes for proper URL construction.
+
+        Parameters
+        ----------
+        api : str
+            API endpoint path. Leading slashes are automatically handled.
+
+        Returns
+        -------
+        str
+            Complete URL for the API call.
+        """
+        endpoint = self._configurator.get_endpoint()
+        return f"{endpoint}/{api.removeprefix('/')}"

digitalhub/stores/client/dhcore/response_processor.py

@@ -0,0 +1,102 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import typing
+from warnings import warn
+
+from requests.exceptions import JSONDecodeError
+
+from digitalhub.stores.client.dhcore.error_parser import ErrorParser
+from digitalhub.utils.exceptions import BackendError, ClientError
+
+if typing.TYPE_CHECKING:
+    from requests import Response
+
+
+# API levels that are supported
+MAX_API_LEVEL = 20
+MIN_API_LEVEL = 14
+LIB_VERSION = 14
+
+
+class ResponseProcessor:
+    """
+    Processes and validates HTTP responses from DHCore backend.
+
+    Handles API version validation, error parsing, and response body parsing
+    to dictionary. Supports API versions {MIN_API_LEVEL} to {MAX_API_LEVEL}.
+    """
+
+    def __init__(self) -> None:
+        self._error_parser = ErrorParser()
+
+    def process(self, response: Response) -> dict:
+        """
+        Process HTTP response with validation and parsing.
+
+        Performs API version compatibility check, error parsing for failed
+        responses, and JSON deserialization.
+
+        Parameters
+        ----------
+        response : Response
+            HTTP response object from backend.
+
+        Returns
+        -------
+        dict
+            Parsed response body as dictionary.
+        """
+        self._check_api_version(response)
+        self._error_parser.parse(response)
+        return self._parse_json(response)
+
+    def _check_api_version(self, response: Response) -> None:
+        """
+        Validate DHCore API version compatibility.
+
+        Checks backend API version against supported range and warns if backend
+        version is newer than library. Supported: {MIN_API_LEVEL} to {MAX_API_LEVEL}.
+
+        Parameters
+        ----------
+        response : Response
+            HTTP response containing X-Api-Level header.
+        """
+        if "X-Api-Level" not in response.headers:
+            return
+
+        core_api_level = int(response.headers["X-Api-Level"])
+        if not (MIN_API_LEVEL <= core_api_level <= MAX_API_LEVEL):
+            raise ClientError("Backend API level not supported.")
+
+        if LIB_VERSION < core_api_level:
+            warn("Backend API level is higher than library version. You should consider updating the library.")
+
+    @staticmethod
+    def _parse_json(response: Response) -> dict:
+        """
+        Parse HTTP response body to dictionary.
+
+        Converts JSON response to Python dictionary, treating empty responses
+        as valid and returning empty dict.
+
+        Parameters
+        ----------
+        response : Response
+            HTTP response object to parse.
+
+        Returns
+        -------
+        dict
+            Parsed response body as dictionary, or empty dict if body is empty.
+        """
+        try:
+            return response.json()
+        except JSONDecodeError:
+            if response.text == "":
+                return {}
+            raise BackendError("Backend response could not be parsed.")

digitalhub/stores/client/dhcore/utils.py

@@ -4,65 +4,12 @@
 
 from __future__ import annotations
 
-import os
 import typing
 
 from digitalhub.stores.client.api import get_client
-from digitalhub.stores.credentials.enums import CredsEnvVar
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores.client.dhcore.client import ClientDHCore
-
-
-def set_dhcore_env(
-    endpoint: str | None = None,
-    user: str | None = None,
-    password: str | None = None,
-    access_token: str | None = None,
-    refresh_token: str | None = None,
-    client_id: str | None = None,
-) -> None:
-    """
-    Set DHCore environment variables and reload client configuration.
-
-    Updates environment variables for DHCore configuration and automatically
-    reloads the client configurator to apply new settings. Overwrites existing
-    environment variables if already set.
-
-    Parameters
-    ----------
-    endpoint : str, optional
-        DHCore backend endpoint URL.
-    user : str, optional
-        Username for basic authentication.
-    password : str, optional
-        Password for basic authentication.
-    access_token : str, optional
-        OAuth2 access token.
-    refresh_token : str, optional
-        OAuth2 refresh token.
-    client_id : str, optional
-        OAuth2 client identifier.
-
-    Returns
-    -------
-    None
-    """
-    if endpoint is not None:
-        os.environ[CredsEnvVar.DHCORE_ENDPOINT.value] = endpoint
-    if user is not None:
-        os.environ[CredsEnvVar.DHCORE_USER.value] = user
-    if password is not None:
-        os.environ[CredsEnvVar.DHCORE_PASSWORD.value] = password
-    if access_token is not None:
-        os.environ[CredsEnvVar.DHCORE_ACCESS_TOKEN.value] = access_token
-    if refresh_token is not None:
-        os.environ[CredsEnvVar.DHCORE_REFRESH_TOKEN.value] = refresh_token
-    if client_id is not None:
-        os.environ[CredsEnvVar.DHCORE_CLIENT_ID.value] = client_id
-
-    client: ClientDHCore = get_client(local=False)
-    client._configurator.load_env_vars()
+    pass
 
 
 def refresh_token() -> None:
@@ -72,15 +19,10 @@ def refresh_token() -> None:
     Uses the refresh token stored in client configuration to obtain a new
     access token. Requires OAuth2 authentication configuration.
 
-    Returns
-    -------
-    None
 
     Raises
     ------
     ClientError
         If client not properly configured or token refresh fails.
     """
-    client: ClientDHCore = get_client(local=False)
-    client._configurator.check_config()
-    client._configurator.refresh_credentials()
+    get_client(local=False).refresh_token()

digitalhub/stores/client/local/client.py

@@ -570,9 +570,9 @@ class ClientLocal(Client):
         ----------
         error_code : int
             Error code identifying the type of error.
-        entity_type : str, optional
+        entity_type : str
             Entity type that caused the error.
-        entity_id : str, optional
+        entity_id : str
             Entity ID that caused the error.
 
         Returns

digitalhub/stores/credentials/api.py

@@ -15,10 +15,6 @@ def set_current_profile(environment: str) -> None:
     ----------
     environment : str
         Name of the credentials profile to set.
-
-    Returns
-    -------
-    None
     """
     creds_handler.set_current_profile(environment)
 

digitalhub/stores/credentials/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
     ------
@@ -129,9 +126,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/builder.py

@@ -79,7 +79,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.
 

digitalhub/stores/data/s3/store.py

@@ -654,7 +654,7 @@ class S3Store(Store):
         ----------
         s3_path : str
             Path to the S3 bucket (e.g., 's3://bucket/path').
-        retry : bool, optional
+        retry : bool
             Whether to retry the operation if a ConfigError is raised. Default is True.
 
         Returns

digitalhub/stores/data/sql/store.py

@@ -159,9 +159,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 +209,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 +238,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
@@ -374,7 +374,7 @@ class SqlStore(Store):
 
         Parameters
         ----------
-        schema : str, optional
+        schema : str
             The database schema to set in the search path.
             If provided, sets the PostgreSQL search_path option.
 
@@ -412,7 +412,7 @@ class SqlStore(Store):
         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

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.0b7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.14.0b5
+Version: 0.14.0b7
 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>