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

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,194 @@
+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_credentials(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_cred_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_credentials(self, key: str) -> dict:
+        """
+        Get the credentials.
+
+        Parameters
+        ----------
+        key : str
+            The key.
+
+        Returns
+        -------
+        dict
+            The credentials.
+        """
+        return self._creds_store.get(self._environment, key)
+
+    def get_all_cred(self) -> dict:
+        """
+        Get all the credentials.
+
+        Returns
+        -------
+        dict
+            The credentials.
+        """
+        return self._creds_store.get_all(self._environment)
+
+    def get_cred_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_cred().items() if k in keys}
+
+
+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}")

digitalhub/entities/_base/_base/entity.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from digitalhub.utils.generic_utils import dict_to_json
+from digitalhub.utils.generic_utils import dump_json
 
 
 class Base:
@@ -40,7 +40,7 @@ class Base:
         str
             A json string containing the attributes of the entity instance.
         """
-        return dict_to_json(self.to_dict())
+        return dump_json(self.to_dict())
 
     def _any_setter(self, **kwargs) -> None:
         """

digitalhub/entities/_base/material/entity.py

@@ -34,6 +34,9 @@ class MaterialEntity(VersionedEntity):
         self.spec: MaterialSpec
         self.status: MaterialStatus
 
+        # Init files info
+        self._init_files_info()
+
     def save(self, update: bool = False) -> MaterialEntity:
         """
         Save entity into backend.
@@ -77,7 +80,7 @@ class MaterialEntity(VersionedEntity):
         list[str]
             List of file paths.
         """
-        store = get_store(self.spec.path)
+        store = get_store(self.project, self.spec.path)
         paths = self.get_file_paths()
         dst = store._build_temp()
         return store.download(self.spec.path, dst=dst, src=paths)
@@ -126,7 +129,7 @@ class MaterialEntity(VersionedEntity):
         >>> print(path)
         dataitem/data.csv
         """
-        store = get_store(self.spec.path)
+        store = get_store(self.project, self.spec.path)
         paths = self.get_file_paths()
 
         if destination is None:
@@ -164,7 +167,7 @@ class MaterialEntity(VersionedEntity):
         >>> entity.upload('./data')
         """
         # Get store and upload object
-        store = get_store(self.spec.path)
+        store = get_store(self.project, self.spec.path)
         paths = store.upload(source, self.spec.path)
 
         # Update files info
@@ -175,6 +178,17 @@ class MaterialEntity(VersionedEntity):
     #  Public Helpers
     ##############################
 
+    def _init_files_info(self) -> None:
+        """
+        Initialize files info.
+
+        Returns
+        -------
+        None
+        """
+        if self.status.files is None:
+            self.status.files = []
+
     def add_files_info(self, files: list[dict]) -> None:
         """
         Add a file to the status.
@@ -202,8 +216,6 @@ class MaterialEntity(VersionedEntity):
         list[str]
             Paths of the files in the status.
         """
-        if self.status.files is None:
-            self.status.files = []
         return [f.get("path") for f in self.status.files]
 
     ##############################
@@ -225,7 +237,8 @@ class MaterialEntity(VersionedEntity):
         """
         if files_info is None:
             return
-        self.refresh()
+        if self.status.files:
+            self.refresh()
         self.add_files_info(files_info)
         self.save(update=True)
 

digitalhub/entities/_base/material/utils.py

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from pathlib import Path
 
+from digitalhub.stores.s3.utils import get_s3_bucket_from_env
 from digitalhub.utils.file_utils import eval_zip_type
-from digitalhub.utils.s3_utils import get_s3_bucket
 from digitalhub.utils.uri_utils import S3Schemes, has_local_scheme
 
 
@@ -91,7 +91,7 @@ def build_log_path_from_source(
         Log path.
     """
     scheme = eval_zip_sources(source)
-    path = f"{scheme}://{get_s3_bucket()}/{project}/{entity_type}/{name}/{uuid}"
+    path = f"{scheme}://{get_s3_bucket_from_env()}/{project}/{entity_type}/{name}/{uuid}"
 
     if isinstance(source, list) and len(source) >= 1:
         if len(source) > 1:

digitalhub/entities/_commons/enums.py

@@ -84,6 +84,7 @@ class BackendOperations(Enum):
     LOGS = "logs"
     SEARCH = "search"
     SHARE = "share"
+    METRICS = "metrics"
 
 
 class EntityKinds(Enum):

digitalhub/entities/_commons/models.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from typing import Union
+
+from pydantic import BaseModel
+
+
+class Metric(BaseModel):
+    value: Union[float, int, list[Union[float, int]]]

digitalhub/entities/_commons/utils.py

@@ -1,6 +1,11 @@
 from __future__ import annotations
 
+from typing import Any
+
+from pydantic import ValidationError
+
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._commons.models import Metric
 
 
 def parse_entity_key(key: str) -> tuple[str]:
@@ -81,3 +86,23 @@ def get_project_from_key(key: str) -> str:
     """
     project, _, _, _, _ = parse_entity_key(key)
     return project
+
+
+def validate_metric_value(value: Any) -> float | int | list[float | int]:
+    """
+    Validate metric value.
+
+    Parameters
+    ----------
+    value : Any
+        The value to validate.
+
+    Returns
+    -------
+    float | int | list[float | int]
+        The validated value.
+    """
+    try:
+        return Metric(value=value).value
+    except ValidationError as e:
+        raise ValueError("Invalid metric value. Must be a list of floats or ints or a float or an int.") from e