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

digitalhub/stores/client/local/params_builder.py

@@ -1,120 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
-from digitalhub.stores.client._base.params_builder import ClientParametersBuilder
-
-
-class ClientLocalParametersBuilder(ClientParametersBuilder):
-    """
-    This class is used to build the parameters for the Local client calls.
-    """
-
-    def build_parameters(self, category: str, operation: str, **kwargs) -> dict:
-        """
-        Build the parameters for the client call.
-
-        Parameters
-        ----------
-        category : str
-            API category.
-        operation : str
-            API operation.
-        **kwargs : dict
-            Parameters to build.
-
-        Returns
-        -------
-        dict
-            Parameters formatted.
-        """
-        if category == ApiCategories.BASE.value:
-            return self.build_parameters_base(operation, **kwargs)
-        return self.build_parameters_context(operation, **kwargs)
-
-    def build_parameters_base(self, operation: str, **kwargs) -> dict:
-        """
-        Build the base parameters for the client call.
-
-        Parameters
-        ----------
-        operation : str
-            API operation.
-        **kwargs : dict
-            Parameters to build.
-
-        Returns
-        -------
-        dict
-            Parameters formatted.
-        """
-        kwargs = self._set_params(**kwargs)
-        if operation == BackendOperations.DELETE.value:
-            if (cascade := kwargs.pop("cascade", None)) is not None:
-                kwargs["params"]["cascade"] = str(cascade).lower()
-        return kwargs
-
-    def build_parameters_context(self, operation: str, **kwargs) -> dict:
-        """
-        Build the context parameters for the client call.
-
-        Parameters
-        ----------
-        operation : str
-            API operation.
-        **kwargs : dict
-            Parameters to build.
-
-        Returns
-        -------
-        dict
-            Parameters formatted.
-        """
-        kwargs = self._set_params(**kwargs)
-
-        # Handle read
-        if operation == BackendOperations.READ_ALL_VERSIONS.value:
-            kwargs["params"]["versions"] = "all"
-            kwargs["params"]["name"] = kwargs.pop("entity_name")
-        # Handle delete
-        elif operation == BackendOperations.DELETE.value:
-            # Handle cascade
-            if cascade := kwargs.pop("cascade", None) is not None:
-                kwargs["params"]["cascade"] = str(cascade).lower()
-
-            # Handle delete all versions
-            entity_id = kwargs.pop("entity_id")
-            entity_name = kwargs.pop("entity_name")
-            if not kwargs.pop("delete_all_versions", False):
-                if entity_id is None:
-                    raise ValueError(
-                        "If `delete_all_versions` is False, `entity_id` must be provided,"
-                        " either as an argument or in key `identifier`.",
-                    )
-            else:
-                kwargs["params"]["name"] = entity_name
-        return kwargs
-
-    @staticmethod
-    def _set_params(**kwargs) -> dict:
-        """
-        Format params parameter.
-
-        Parameters
-        ----------
-        **kwargs : dict
-            Keyword arguments.
-
-        Returns
-        -------
-        dict
-            Parameters with initialized params.
-        """
-        if not kwargs:
-            kwargs = {}
-        if "params" not in kwargs:
-            kwargs["params"] = {}
-        return kwargs

digitalhub/stores/credentials/__init__.py

@@ -1,3 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0

digitalhub/stores/credentials/configurator.py

@@ -1,210 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-from abc import abstractmethod
-
-from digitalhub.stores.credentials.enums import CredsOrigin
-from digitalhub.stores.credentials.handler import creds_handler
-from digitalhub.utils.exceptions import ConfigError
-
-
-class Configurator:
-    """
-    Base configurator for credentials management.
-
-    Attributes
-    ----------
-    keys : list of str
-        List of credential keys to manage.
-    required_keys : list of str
-        List of required credential keys.
-    _env : str
-        Environment origin identifier.
-    _file : str
-        File origin identifier.
-    _creds_handler : object
-        Credentials handler instance.
-    """
-
-    # Must be set in implementing class
-    keys: list[str] = []
-    required_keys: list[str] = []
-
-    # Origin of the credentials
-    _env = CredsOrigin.ENV.value
-    _file = CredsOrigin.FILE.value
-
-    # Credentials handler
-    _creds_handler = creds_handler
-
-    def __init__(self):
-        self._current_profile = self._creds_handler.get_current_profile()
-        self.load_configs()
-        self._changed_origin = False
-        self._origin = self.set_origin()
-
-    ##############################
-    # Configuration
-    ##############################
-
-    def load_configs(self) -> None:
-        """
-        Load the configuration from both environment and file sources.
-
-        Returns
-        -------
-        None
-        """
-        self.load_env_vars()
-        self.load_file_vars()
-
-    @abstractmethod
-    def load_env_vars(self) -> None:
-        ...
-
-    @abstractmethod
-    def load_file_vars(self) -> None:
-        ...
-
-    def check_config(self) -> None:
-        """
-        Check if the current profile has changed and reload
-        the file credentials if needed.
-
-        Returns
-        -------
-        None
-        """
-        if (current := self._creds_handler.get_current_profile()) != self._current_profile:
-            self.load_file_vars()
-            self._current_profile = current
-
-    def set_origin(self) -> str:
-        """
-        Determine the default origin for credentials (env or file).
-
-        Returns
-        -------
-        str
-            The selected origin ('env' or 'file').
-
-        Raises
-        ------
-        ConfigError
-            If required credentials are missing in both sources.
-        """
-        origin = self._env
-
-        env_creds = self._creds_handler.get_credentials(self._env)
-        missing_env = self._check_credentials(env_creds)
-
-        file_creds = self._creds_handler.get_credentials(self._file)
-        missing_file = self._check_credentials(file_creds)
-
-        msg = ""
-        if missing_env:
-            msg = f"Missing required vars in env: {', '.join(missing_env)}"
-            origin = self._file
-            self._changed_origin = True
-        elif missing_file:
-            msg += f"Missing required vars in .dhcore.ini file: {', '.join(missing_file)}"
-
-        if missing_env and missing_file:
-            raise ConfigError(msg)
-
-        return origin
-
-    def eval_change_origin(self) -> None:
-        """
-        Attempt to change the origin of credentials.
-        Raise error if already evaluated.
-
-        Returns
-        -------
-        None
-        """
-        try:
-            self.change_origin()
-        except ConfigError:
-            raise ConfigError("Credentials origin already evaluated. Please check your credentials.")
-
-    def change_origin(self) -> None:
-        """
-        Change the origin of credentials from env to file or vice versa.
-
-        Returns
-        -------
-        None
-        """
-        if self._changed_origin:
-            raise ConfigError("Origin has already been changed.")
-        if self._origin == self._env:
-            self.change_to_file()
-        self.change_to_env()
-
-    def change_to_file(self) -> None:
-        """
-        Set the credentials origin to file.
-
-        Returns
-        -------
-        None
-        """
-        if self._origin == self._env:
-            self._changed_origin = True
-        self._origin = CredsOrigin.FILE.value
-
-    def change_to_env(self) -> None:
-        """
-        Set the credentials origin to environment.
-
-        Returns
-        -------
-        None
-        """
-        if self._origin == self._file:
-            self._changed_origin = True
-        self._origin = CredsOrigin.ENV.value
-
-    ##############################
-    # Credentials
-    ##############################
-
-    def get_credentials(self, origin: str) -> dict:
-        """
-        Retrieve credentials for the specified origin.
-
-        Parameters
-        ----------
-        origin : str
-            The origin to retrieve credentials from ('env' or 'file').
-
-        Returns
-        -------
-        dict
-            Dictionary of credentials.
-        """
-        return self._creds_handler.get_credentials(origin)
-
-    def _check_credentials(self, creds: dict) -> list[str]:
-        """
-        Check for missing required credentials in a dictionary.
-
-        Parameters
-        ----------
-        creds : dict
-            Dictionary of credentials to check.
-
-        Returns
-        -------
-        list of str
-            List of missing required credential keys.
-        """
-        missing_keys = []
-        for k, v in creds.items():
-            if v is None and k in self.required_keys:
-                missing_keys.append(k)
-        return missing_keys

digitalhub/stores/credentials/handler.py

@@ -1,176 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-import os
-
-from digitalhub.stores.credentials.enums import SetCreds
-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:
-    """
-    Handler for configuring clients and managing credentials.
-
-    Attributes
-    ----------
-    _creds_store : CredentialsStore
-        Store for credentials.
-    _profile : str
-        Current credentials profile name.
-    """
-
-    def __init__(self) -> None:
-        self._creds_store = CredentialsStore()
-        self._profile = self._read_current_profile()
-
-    @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_profile(self, creds_set: str) -> None:
-        """
-        Set the current credentials profile name.
-
-        Parameters
-        ----------
-        creds_set : str
-            Name of the credentials profile to set.
-
-        Returns
-        -------
-        None
-        """
-        self._profile = creds_set
-        set_current_profile(creds_set)
-
-    def get_current_profile(self) -> str:
-        """
-        Get the current credentials profile name.
-
-        Returns
-        -------
-        str
-            Name of the current credentials profile.
-        """
-        return self._profile
-
-    def load_from_env(self, vars: list[str]) -> dict:
-        """
-        Load variables from environment.
-
-        Parameters
-        ----------
-        vars : list of str
-            List of environment variable names to load.
-
-        Returns
-        -------
-        dict
-            Dictionary of environment variable values.
-        """
-        return {var: os.getenv(var) for var in vars}
-
-    def load_from_file(self, vars: list[str]) -> dict:
-        """
-        Load variables from credentials config file.
-
-        Parameters
-        ----------
-        vars : list of str
-            List of variable names to load from file.
-
-        Returns
-        -------
-        dict
-            Dictionary of variable values from file.
-        """
-        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 credentials to the .dhcore file for the current profile.
-
-        Parameters
-        ----------
-        creds : dict
-            Credentials to write.
-
-        Returns
-        -------
-        None
-        """
-        write_config(creds, self._profile)
-
-    ##############################
-    # Credentials store methods
-    ##############################
-
-    def set_credentials(self, origin: str, creds: dict) -> None:
-        """
-        Set credentials for the current profile and origin.
-
-        Parameters
-        ----------
-        origin : str
-            The origin of the credentials ('env' or 'file').
-        creds : dict
-            Credentials to set.
-
-        Returns
-        -------
-        None
-        """
-        self._creds_store.set_credentials(self._profile, origin, creds)
-
-    def get_credentials(self, origin: str) -> dict:
-        """
-        Get credentials for the current profile from the specified origin.
-
-        Parameters
-        ----------
-        origin : str
-            The origin to get credentials from ('env' or 'file').
-
-        Returns
-        -------
-        dict
-            Dictionary of credentials.
-        """
-        return self._creds_store.get_credentials(self._profile, origin)
-
-
-# Define global credential handler
-creds_handler = CredentialHandler()

digitalhub/stores/credentials/store.py

@@ -1,81 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-from typing import Any
-
-from digitalhub.stores.credentials.enums import CredsOrigin
-
-
-class CredentialsStore:
-    """
-    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:
-        self._file_creds: dict[str, dict[str, Any]] = {}
-        self._env_creds: dict[str, Any] = {}
-
-    def set_credentials(
-        self,
-        profile: str,
-        origin: str,
-        credentials: dict[str, Any],
-    ) -> 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():
-                self._env_creds[key] = value
-            return
-        if profile not in self._file_creds:
-            self._file_creds[profile] = {}
-        for key, value in credentials.items():
-            self._file_creds[profile][key] = value
-
-    def get_credentials(
-        self,
-        profile: str,
-        origin: str,
-    ) -> 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
-        return self._file_creds[profile]

digitalhub/stores/data/enums.py

@@ -1,15 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-from enum import Enum
-
-
-class StoreEnv(Enum):
-    """
-    Environment variables for data stores.
-    """
-
-    DEFAULT_FILES_STORE = "DHCORE_DEFAULT_FILES_STORE"

digitalhub/stores/data/s3/utils.py

@@ -1,78 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
-#
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-from pathlib import Path
-from urllib.parse import urlparse
-
-from boto3 import client as boto3_client
-
-from digitalhub.stores.credentials.enums import CredsOrigin
-from digitalhub.stores.data.s3.configurator import S3StoreConfigurator
-from digitalhub.utils.exceptions import StoreError
-
-
-def get_bucket_name(path: str) -> str:
-    """
-    Extract the bucket name from an S3 path.
-
-    Parameters
-    ----------
-    path : str
-        S3 URI (e.g., 's3://bucket/key').
-
-    Returns
-    -------
-    str
-        The bucket name extracted from the URI.
-    """
-    return urlparse(path).netloc
-
-
-def get_bucket_and_key(path: str) -> tuple[str, str]:
-    """
-    Extract the bucket name and key from an S3 path.
-
-    Parameters
-    ----------
-    path : str
-        S3 URI (e.g., 's3://bucket/key').
-
-    Returns
-    -------
-    tuple of str
-        Tuple containing (bucket, key) extracted from the URI.
-    """
-    parsed = urlparse(path)
-    return parsed.netloc, parsed.path
-
-
-def get_s3_source(bucket: str, key: str, filename: Path) -> None:
-    """
-    Download an object from S3 and save it to a local file.
-
-    Parameters
-    ----------
-    bucket : str
-        S3 bucket name.
-    key : str
-        S3 object key.
-    filename : Path
-        Local path where the downloaded object will be saved.
-
-    Returns
-    -------
-    None
-    """
-    # Try to get client from environment variables
-    try:
-        cfg = S3StoreConfigurator().get_boto3_client_config(CredsOrigin.ENV.value)
-        s3 = boto3_client("s3", **cfg)
-        s3.download_file(bucket, key, filename)
-
-    # Fallback to file
-    except StoreError:
-        cfg = S3StoreConfigurator().get_boto3_client_config(CredsOrigin.FILE.value)
-        s3.download_file(bucket, key, filename)