digitalhub 0.9.2__py3-none-any.whl → 0.10.0__py3-none-any.whl

digitalhub/client/dhcore/utils.py

@@ -4,7 +4,7 @@ import os
 import typing
 
 from digitalhub.client.api import get_client
-from digitalhub.client.dhcore.enums import AuthType, DhcoreEnvVar
+from digitalhub.client.dhcore.enums import DhcoreEnvVar
 
 if typing.TYPE_CHECKING:
     from digitalhub.client.dhcore.client import ClientDHCore
@@ -21,8 +21,7 @@ def set_dhcore_env(
     """
     Function to set environment variables for DHCore config.
     Note that if the environment variable is already set, it
-    will be overwritten. It also ovverides the remote client
-    configuration.
+    will be overwritten.
 
     Parameters
     ----------
@@ -56,47 +55,8 @@ def set_dhcore_env(
     if client_id is not None:
         os.environ[DhcoreEnvVar.CLIENT_ID.value] = client_id
 
-    update_client_from_env()
-
-
-def update_client_from_env() -> None:
-    """
-    Function to update client from environment variables.
-
-    Returns
-    -------
-    None
-    """
     client: ClientDHCore = get_client(local=False)
-
-    # Update endpoint
-    endpoint = os.getenv(DhcoreEnvVar.ENDPOINT.value)
-    if endpoint is not None:
-        client._endpoint_core = endpoint
-
-    # Update auth
-
-    # If token is set, it will override the other auth options
-    access_token = os.getenv(DhcoreEnvVar.ACCESS_TOKEN.value)
-    refresh_token = os.getenv(DhcoreEnvVar.REFRESH_TOKEN.value)
-    client_id = os.getenv(DhcoreEnvVar.CLIENT_ID.value)
-
-    if access_token is not None:
-        if refresh_token is not None:
-            client._refresh_token = refresh_token
-        if client_id is not None:
-            client._client_id = client_id
-        client._access_token = access_token
-        client._auth_type = AuthType.OAUTH2.value
-        return
-
-    # Otherwise, if user and password are set, basic auth will be used
-    username = os.getenv(DhcoreEnvVar.USER.value)
-    password = os.getenv(DhcoreEnvVar.PASSWORD.value)
-    if username is not None and password is not None:
-        client._user = username
-        client._password = password
-        client._auth_type = AuthType.BASIC.value
+    client._configurator.configure()
 
 
 def refresh_token() -> None:
@@ -108,4 +68,4 @@ def refresh_token() -> None:
     None
     """
     client: ClientDHCore = get_client(local=False)
-    client._get_new_access_token()
+    client._configurator.get_new_access_token()

digitalhub/client/local/api_builder.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from digitalhub.client._base.api_builder import ClientApiBuilder
+from digitalhub.client.local.enums import LocalClientVar
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
 from digitalhub.utils.exceptions import BackendError
 
@@ -63,15 +64,16 @@ class ClientLocalApiBuilder(ClientApiBuilder):
             BackendOperations.DELETE.value,
         ):
             return f"{API_BASE}/{entity_type}/{kwargs['entity_name']}"
-        elif operation == BackendOperations.SHARE.value:
-            raise BackendError("Share API not implemented for Local.")
-        raise BackendError(f"Invalid operation '{operation}' for entity type '{entity_type}' in Local.")
+        raise BackendError(f"API for operation '{operation}' for entity type '{entity_type}' not implemented in Local.")
 
     def build_api_context(self, operation: str, **kwargs) -> str:
         """
         Build the context API for the client.
         """
-        entity_type = kwargs["entity_type"] + "s"
+        try:
+            entity_type = kwargs["entity_type"] + "s"
+        except KeyError:
+            pass
         project = kwargs["project"]
         if operation in (
             BackendOperations.CREATE.value,
@@ -84,17 +86,10 @@ class ClientLocalApiBuilder(ClientApiBuilder):
             BackendOperations.DELETE.value,
         ):
             return f"{API_CONTEXT}/{project}/{entity_type}/{kwargs['entity_id']}"
-        elif operation == BackendOperations.LOGS.value:
-            raise BackendError("Logs run API not implemented for Local.")
-        elif operation == BackendOperations.STOP.value:
-            raise BackendError("Stop run API not implemented for Local.")
-        elif operation == BackendOperations.RESUME.value:
-            raise BackendError("Resume run API not implemented for Local.")
-        elif operation == BackendOperations.DATA.value:
-            raise BackendError("Secret API (read/set value) not implemented for Local.")
-        elif operation == BackendOperations.FILES.value:
-            raise BackendError("Files API not implemented for Local.")
-        elif operation == BackendOperations.SEARCH.value:
-            raise BackendError("Search API not implemented for Local.")
-
-        raise BackendError(f"Invalid operation '{operation}' for entity type '{entity_type}' in Local.")
+        elif operation in (
+            BackendOperations.LOGS.value,
+            BackendOperations.FILES.value,
+            BackendOperations.METRICS.value,
+        ):
+            return LocalClientVar.EMPTY.value
+        raise BackendError(f"API for operation '{operation}' for entity type '{entity_type}' not implemented in Local.")

digitalhub/client/local/client.py

@@ -2,10 +2,13 @@ from __future__ import annotations
 
 from copy import deepcopy
 from datetime import datetime, timezone
+from typing import Any
 
 from digitalhub.client._base.client import Client
 from digitalhub.client.local.api_builder import ClientLocalApiBuilder
+from digitalhub.client.local.enums import LocalClientVar
 from digitalhub.client.local.key_builder import ClientLocalKeyBuilder
+from digitalhub.client.local.params_builder import ClientLocalParametersBuilder
 from digitalhub.utils.exceptions import BackendError
 
 
@@ -26,13 +29,14 @@ class ClientLocal(Client):
         super().__init__()
         self._api_builder = ClientLocalApiBuilder()
         self._key_builder = ClientLocalKeyBuilder()
+        self._params_builder = ClientLocalParametersBuilder()
         self._db: dict[str, dict[str, dict]] = {}
 
     ##############################
     # CRUD
     ##############################
 
-    def create_object(self, api: str, obj: dict, **kwargs) -> dict:
+    def create_object(self, api: str, obj: Any, **kwargs) -> dict:
         """
         Create an object in local.
 
@@ -48,6 +52,11 @@ class ClientLocal(Client):
         dict
             The created object.
         """
+        if api == LocalClientVar.EMPTY.value:
+            return {}
+        if not isinstance(obj, dict):
+            raise TypeError("Object must be a dictionary")
+
         entity_type, _, context_api = self._parse_api(api)
         try:
             # Check if entity_type is valid
@@ -114,6 +123,8 @@ class ClientLocal(Client):
         dict
             The read object.
         """
+        if api == LocalClientVar.EMPTY.value:
+            return {}
         entity_type, entity_id, context_api = self._parse_api(api)
         if entity_id is None:
             msg = self._format_msg(4)
@@ -155,7 +166,7 @@ class ClientLocal(Client):
             msg = self._format_msg(3, entity_type=entity_type, entity_id=entity_id)
             raise BackendError(msg)
 
-    def update_object(self, api: str, obj: dict, **kwargs) -> dict:
+    def update_object(self, api: str, obj: Any, **kwargs) -> dict:
         """
         Update an object in local.
 
@@ -171,6 +182,11 @@ class ClientLocal(Client):
         dict
             The updated object.
         """
+        if api == LocalClientVar.EMPTY.value:
+            return {}
+        if not isinstance(obj, dict):
+            raise TypeError("Object must be a dictionary")
+
         entity_type, entity_id, context_api = self._parse_api(api)
         try:
             # API example

digitalhub/client/local/enums.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class LocalClientVar(Enum):
+    """
+    Variables for Local.
+    """
+
+    EMPTY = "EMPTY"

digitalhub/client/local/params_builder.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+from digitalhub.client._base.params_builder import ClientParametersBuilder
+from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
+
+
+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/configurator/api.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from digitalhub.configurator.configurator import configurator
+
+
+def set_current_env(environment: str) -> None:
+    """
+    Set the current credentials set.
+
+    Parameters
+    ----------
+    environment : str
+        Credentials set name.
+
+    Returns
+    -------
+    None
+    """
+    configurator.set_current_env(environment)
+
+
+def get_current_env() -> str:
+    """
+    Get the current credentials set.
+
+    Returns
+    -------
+    str
+        Credentials set name.
+    """
+    return configurator.get_current_env()

digitalhub/configurator/configurator.py

@@ -0,0 +1,195 @@
+from __future__ import annotations
+
+import os
+
+from digitalhub.configurator.credentials_store import CredentialsStore
+from digitalhub.configurator.ini_module import load_from_config, write_config
+
+
+class EnvConfigurator:
+    """
+    Configurator object used to configure clients and store credentials.
+    """
+
+    def __init__(self) -> None:
+        # Store
+        self._creds_store = CredentialsStore()
+
+        # Current credentials set (__default by default)
+        self._environment = "__default"
+
+    ##############################
+    # Public methods
+    ##############################
+
+    def set_current_env(self, creds_set: str) -> None:
+        """
+        Set the current credentials set.
+
+        Parameters
+        ----------
+        creds_set : str
+            Credentials set name.
+
+        Returns
+        -------
+        None
+        """
+        self._environment = creds_set
+
+    def get_current_env(self) -> str:
+        """
+        Get the current credentials set.
+
+        Returns
+        -------
+        str
+            Credentials set name.
+        """
+        return self._environment
+
+    ##############################
+    # Private methods
+    ##############################
+
+    def load_var(self, var_name: str) -> str | None:
+        """
+        Get env variable from credentials store, env or file (in order).
+
+        Parameters
+        ----------
+        var_name : str
+            Environment variable name.
+
+        Returns
+        -------
+        str | None
+            Environment variable value.
+        """
+        var = self.get_credential(var_name)
+        if var is None:
+            var = self.load_from_env(var_name)
+        if var is None:
+            var = self.load_from_config(var_name)
+        return var
+
+    def load_from_env(self, var: str) -> str | None:
+        """
+        Load variable from env.
+
+        Parameters
+        ----------
+        var : str
+            Environment variable name.
+
+        Returns
+        -------
+        str | None
+            Environment variable value.
+        """
+        env_var = os.getenv(var)
+        if env_var != "":
+            return env_var
+
+    def load_from_config(self, var: str) -> str | None:
+        """
+        Load variable from config file.
+
+        Parameters
+        ----------
+        var : str
+            Environment variable name.
+
+        Returns
+        -------
+        str | None
+            Environment variable value.
+        """
+        return load_from_config(var)
+
+    def write_env(self, key_to_include: list[str] | None = None) -> None:
+        """
+        Write the env variables to the .dhcore file.
+        It will overwrite any existing env variables.
+
+        Parameters
+        ----------
+        key_to_include : list[str]
+            List of keys to include.
+
+        Returns
+        -------
+        None
+        """
+        if key_to_include is None:
+            key_to_include = []
+        creds = self.get_credential_list(key_to_include)
+        write_config(creds, self._environment)
+
+    ##############################
+    # Credentials store methods
+    ##############################
+
+    def set_credential(self, key: str, value: str) -> None:
+        """
+        Register a credential value.
+
+        Parameters
+        ----------
+        key : str
+            The key.
+        value : str
+            The value.
+
+        Returns
+        -------
+        None
+        """
+        self._creds_store.set(self._environment, key, value)
+
+    def get_credential(self, key: str) -> dict:
+        """
+        Get single credential value from key.
+
+        Parameters
+        ----------
+        key : str
+            The key.
+
+        Returns
+        -------
+        dict
+            The credential.
+        """
+        return self._creds_store.get(self._environment, key)
+
+    def get_all_credentials(self) -> dict:
+        """
+        Get all the credentials from the current credentials set.
+
+        Returns
+        -------
+        dict
+            The credentials.
+        """
+        return self._creds_store.get_all(self._environment)
+
+    def get_credential_list(self, keys: list[str]) -> list[str]:
+        """
+        Get the list of credentials.
+
+        Parameters
+        ----------
+        keys : list[str]
+            The list of keys.
+
+        Returns
+        -------
+        list[str]
+            The list of credentials.
+        """
+        return {k: v for k, v in self.get_all_credentials().items() if k in keys}
+
+
+# Define global configurator
+configurator = EnvConfigurator()

digitalhub/configurator/credentials_store.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+
+class CredentialsStore:
+    """
+    Credentials store to store and retrieve credentials.
+    """
+
+    def __init__(self) -> None:
+        self._credentials: dict[str, dict] = {}
+
+    def set(self, profile: str, key: str, value: str) -> None:
+        """
+        Set credentials.
+
+        Parameters
+        ----------
+        profile : str
+            The profile of the credentials.
+        key : str
+            The key of the credentials.
+        value : str
+            The value of the credentials.
+
+        Returns
+        -------
+        None
+        """
+        if profile not in self._credentials:
+            self._credentials[profile] = {}
+        self._credentials[profile][key] = value
+
+    def get(self, profile: str, key: str) -> str | None:
+        """
+        Get credentials.
+
+        Parameters
+        ----------
+        profile : str
+            The profile of the credentials.
+        key : str
+            The key of the credentials.
+
+        Returns
+        -------
+        str | None
+            The value of the credentials.
+        """
+        return self._credentials.get(profile, {}).get(key)
+
+    def get_all(self, profile: str) -> dict[str, str]:
+        """
+        Get all credentials.
+
+        Parameters
+        ----------
+        profile : str
+            The profile of the credentials.
+
+        Returns
+        -------
+        dict[str, str]
+            The credentials.
+        """
+        return self._credentials.get(profile, {})

digitalhub/configurator/ini_module.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from configparser import ConfigParser
+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
+ENV_FILE = Path.home() / ".dhcore.ini"
+
+
+def load_from_config(var: str) -> str | None:
+    """
+    Load variable from config file.
+
+    Parameters
+    ----------
+    profile : str
+        Credentials set name.
+    var : str
+        Environment variable name.
+
+    Returns
+    -------
+    str | None
+        Environment variable value.
+    """
+    cfg = ConfigParser()
+    cfg.read(ENV_FILE)
+    try:
+        profile = cfg["DEFAULT"]["current_environment"]
+        return cfg[profile].get(var)
+    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.
+
+    Parameters
+    ----------
+    creds : dict
+        Credentials.
+    environment : str
+        Credentials set name.
+
+    Returns
+    -------
+    None
+    """
+    try:
+        cfg = ConfigParser()
+        cfg.read(ENV_FILE)
+
+        sections = cfg.sections()
+        if environment not in sections:
+            cfg.add_section(environment)
+
+        cfg["DEFAULT"]["current_environment"] = environment
+        for k, v in creds.items():
+            cfg[environment][k] = 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}")