digitalhub 0.10.0b4__tar.gz → 0.10.0b5__tar.gz

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.10.0b4
+Version: 0.10.0b5
 Summary: Python SDK for Digitalhub
 Project-URL: Homepage, https://github.com/scc-digitalhub/digitalhub-sdk
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/client/dhcore/configurator.py

@@ -118,7 +118,7 @@ class ClientDHCoreConfigurator:
             The url.
         """
         api = api.removeprefix("/")
-        return f"{configurator.get_credentials(DhcoreEnvVar.ENDPOINT.value)}/{api}"
+        return f"{configurator.get_credential(DhcoreEnvVar.ENDPOINT.value)}/{api}"
 
     ##############################
     # Private methods
@@ -193,7 +193,7 @@ class ClientDHCoreConfigurator:
         -------
         bool
         """
-        auth_type = configurator.get_credentials(AUTH_KEY)
+        auth_type = configurator.get_credential(AUTH_KEY)
         return auth_type == AuthType.BASIC.value
 
     def oauth2_auth(self) -> bool:
@@ -204,7 +204,7 @@ class ClientDHCoreConfigurator:
         -------
         bool
         """
-        auth_type = configurator.get_credentials(AUTH_KEY)
+        auth_type = configurator.get_credential(AUTH_KEY)
         return auth_type == AuthType.OAUTH2.value
 
     def set_request_auth(self, kwargs: dict) -> dict:
@@ -221,7 +221,7 @@ class ClientDHCoreConfigurator:
         dict
             Authentication header.
         """
-        creds = configurator.get_all_cred()
+        creds = configurator.get_all_credentials()
         if AUTH_KEY not in creds:
             return kwargs
         if self.basic_auth():

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/configurator/configurator.py

@@ -66,7 +66,7 @@ class EnvConfigurator:
         str | None
             Environment variable value.
         """
-        var = self.get_credentials(var_name)
+        var = self.get_credential(var_name)
         if var is None:
             var = self.load_from_env(var_name)
         if var is None:
@@ -123,7 +123,7 @@ class EnvConfigurator:
         """
         if key_to_include is None:
             key_to_include = []
-        creds = self.get_cred_list(key_to_include)
+        creds = self.get_credential_list(key_to_include)
         write_config(creds, self._environment)
 
     ##############################
@@ -147,9 +147,9 @@ class EnvConfigurator:
         """
         self._creds_store.set(self._environment, key, value)
 
-    def get_credentials(self, key: str) -> dict:
+    def get_credential(self, key: str) -> dict:
         """
-        Get the credentials.
+        Get single credential value from key.
 
         Parameters
         ----------
@@ -159,13 +159,13 @@ class EnvConfigurator:
         Returns
         -------
         dict
-            The credentials.
+            The credential.
         """
         return self._creds_store.get(self._environment, key)
 
-    def get_all_cred(self) -> dict:
+    def get_all_credentials(self) -> dict:
         """
-        Get all the credentials.
+        Get all the credentials from the current credentials set.
 
         Returns
         -------
@@ -174,7 +174,7 @@ class EnvConfigurator:
         """
         return self._creds_store.get_all(self._environment)
 
-    def get_cred_list(self, keys: list[str]) -> list[str]:
+    def get_credential_list(self, keys: list[str]) -> list[str]:
         """
         Get the list of credentials.
 
@@ -188,7 +188,8 @@ class EnvConfigurator:
         list[str]
             The list of credentials.
         """
-        return {k: v for k, v in self.get_all_cred().items() if k in keys}
+        return {k: v for k, v in self.get_all_credentials().items() if k in keys}
 
 
+# Define global configurator
 configurator = EnvConfigurator()

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/entities/_commons/models.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from digitalhub.utils.types import MetricType
+from digitalhub.entities._commons.types import MetricType
 
 
 class Metric(BaseModel):

{digitalhub-0.10.0b4/digitalhub/utils → digitalhub-0.10.0b5/digitalhub/entities/_commons}/types.py

@@ -3,4 +3,3 @@ from __future__ import annotations
 from typing import Union
 
 MetricType = Union[float, int, list[Union[float, int]]]
-SourcesOrListOfSources = Union[str, list[str]]

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/entities/_commons/utils.py

@@ -6,7 +6,7 @@ from pydantic import ValidationError
 
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._commons.models import Metric
-from digitalhub.utils.types import MetricType
+from digitalhub.entities._commons.types import MetricType
 
 
 def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/entities/_operations/processor.py

@@ -649,12 +649,12 @@ class OperationsProcessor:
         dict
             Object instance.
         """
-        if not identifier.startswith("store://"):
-            if project is None or entity_type is None:
-                raise ValueError("Project and entity type must be specified.")
-            entity_name = identifier
-        else:
-            project, entity_type, _, entity_name, entity_id = parse_entity_key(identifier)
+        project, entity_type, _, entity_name, entity_id = self._parse_identifier(
+            identifier,
+            project=project,
+            entity_type=entity_type,
+            entity_id=entity_id,
+        )
 
         kwargs = self._set_params(**kwargs)
 
@@ -918,12 +918,11 @@ class OperationsProcessor:
         list[dict]
             Object instances.
         """
-        if not identifier.startswith("store://"):
-            if project is None or entity_type is None:
-                raise ValueError("Project and entity type must be specified.")
-            entity_name = identifier
-        else:
-            project, entity_type, _, entity_name, _ = parse_entity_key(identifier)
+        project, entity_type, _, entity_name, _ = self._parse_identifier(
+            identifier,
+            project=project,
+            entity_type=entity_type,
+        )
 
         kwargs = self._set_params(**kwargs)
         kwargs["params"]["name"] = entity_name
@@ -1768,6 +1767,39 @@ class OperationsProcessor:
     # Helpers
     ##############################
 
+    @staticmethod
+    def _parse_identifier(
+        identifier: str,
+        project: str | None = None,
+        entity_type: str | None = None,
+        entity_kind: str | None = None,
+        entity_id: str | None = None,
+    ) -> tuple[str, str, str, str | None, str]:
+        """
+        Parse entity identifier.
+
+        Parameters
+        ----------
+        identifier : str
+            Entity key (store://...) or entity name.
+        project : str
+            Project name.
+        entity_type : str
+            Entity type.
+        entity_id : str
+            Entity ID.
+
+        Returns
+        -------
+        tuple[str, str, str, str | None, str]
+            Project name, entity type, entity kind, entity name, entity ID.
+        """
+        if not identifier.startswith("store://"):
+            if project is None or entity_type is None:
+                raise ValueError("Project and entity type must be specified.")
+            return project, entity_type, entity_kind, identifier, entity_id
+        return parse_entity_key(identifier)
+
     @staticmethod
     def _set_params(**kwargs) -> dict:
         """

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/entities/dataitem/utils.py

@@ -10,6 +10,7 @@ from digitalhub.entities._base.material.utils import build_log_path_from_source,
 from digitalhub.entities._commons.enums import EntityKinds, EntityTypes
 from digitalhub.readers.data.api import get_reader_by_object
 from digitalhub.stores.api import get_store
+from digitalhub.utils.enums import FileExtensions
 from digitalhub.utils.generic_utils import slugify_string
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -17,7 +18,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.dataitem._base.entity import Dataitem
 
 
-DEFAULT_EXTENSION = "parquet"
+DEFAULT_EXTENSION = FileExtensions.PARQUET.value
 
 
 def eval_source(

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/factory/utils.py

@@ -25,10 +25,10 @@ def import_module(package: str) -> ModuleType:
     """
     try:
         return importlib.import_module(package)
-    except ModuleNotFoundError:
-        raise ModuleNotFoundError(f"Package {package} not found.")
+    except ModuleNotFoundError as e:
+        raise ModuleNotFoundError(f"Package {package} not found.") from e
     except Exception as e:
-        raise e
+        raise RuntimeError(f"An error occurred while importing {package}.") from e
 
 
 def list_runtimes() -> list[str]:
@@ -37,18 +37,18 @@ def list_runtimes() -> list[str]:
 
     Returns
     -------
-    list
+    list[str]
         List of installed runtimes names.
     """
     pattern = r"digitalhub_runtime_.*"
-    runtimes = []
+    runtimes: list[str] = []
     try:
         for _, name, _ in pkgutil.iter_modules():
             if re.match(pattern, name):
                 runtimes.append(name)
         return runtimes
-    except Exception:
-        raise RuntimeError("Error listing installed runtimes.")
+    except Exception as e:
+        raise RuntimeError("Error listing installed runtimes.") from e
 
 
 def register_runtimes_entities() -> None:
@@ -86,5 +86,5 @@ def register_entities() -> None:
         for entity_builder_tuple in entities_builders_list:
             kind, builder = entity_builder_tuple
             factory.add_entity_builder(kind, builder)
-    except Exception:
-        raise
+    except Exception as e:
+        raise RuntimeError("Error registering entities.") from e

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/readers/data/pandas/reader.py

@@ -10,7 +10,7 @@ from pandas.errors import ParserError
 
 from digitalhub.entities.dataitem.table.utils import check_preview_size, finalize_preview, prepare_data, prepare_preview
 from digitalhub.readers.data._base.reader import DataframeReader
-from digitalhub.readers.data.pandas.enums import Extensions
+from digitalhub.utils.enums import FileExtensions
 from digitalhub.utils.exceptions import ReaderError
 from digitalhub.utils.generic_utils import CustomJsonEncoder
 
@@ -42,17 +42,17 @@ class DataframeReaderPandas(DataframeReader):
         pd.DataFrame
             Pandas DataFrame.
         """
-        if extension == Extensions.CSV.value:
+        if extension == FileExtensions.CSV.value:
             return pd.read_csv(path_or_buffer, **kwargs)
-        if extension == Extensions.PARQUET.value:
+        if extension == FileExtensions.PARQUET.value:
             return pd.read_parquet(path_or_buffer, **kwargs)
-        if extension == Extensions.JSON.value:
+        if extension == FileExtensions.JSON.value:
             return pd.read_json(path_or_buffer, **kwargs)
-        if extension in (Extensions.EXCEL.value, Extensions.EXCEL_OLD.value):
+        if extension in (FileExtensions.EXCEL.value, FileExtensions.EXCEL_OLD.value):
             return pd.read_excel(path_or_buffer, **kwargs)
-        if extension in (Extensions.TXT.value, Extensions.FILE.value):
+        if extension in (FileExtensions.TXT.value, FileExtensions.FILE.value):
             try:
-                return self.read_df(path_or_buffer, Extensions.CSV.value, **kwargs)
+                return self.read_df(path_or_buffer, FileExtensions.CSV.value, **kwargs)
             except ParserError:
                 raise ReaderError(f"Unable to read from {path_or_buffer}.")
         else:
@@ -105,9 +105,9 @@ class DataframeReaderPandas(DataframeReader):
         -------
         None
         """
-        if extension == Extensions.CSV.value:
+        if extension == FileExtensions.CSV.value:
             return self.write_csv(df, dst, **kwargs)
-        if extension == Extensions.PARQUET.value:
+        if extension == FileExtensions.PARQUET.value:
             return self.write_parquet(df, dst, **kwargs)
         raise ReaderError(f"Unsupported extension '{extension}' for writing.")
 

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/stores/s3/configurator.py

@@ -61,7 +61,7 @@ class S3StoreConfigurator:
         dict
             The credentials.
         """
-        creds = configurator.get_all_cred()
+        creds = configurator.get_all_credentials()
         try:
             return {
                 "endpoint_url": creds[S3StoreEnv.ENDPOINT_URL.value],

digitalhub-0.10.0b5/digitalhub/stores/s3/enums.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class S3StoreEnv(Enum):
+    """
+    S3Store environment
+    """
+
+    ENDPOINT_URL = "DHCORE_S3_ENDPOINT_URL"
+    ACCESS_KEY_ID = "DHCORE_AWS_ACCESS_KEY_ID"
+    SECRET_ACCESS_KEY = "DHCORE_AWS_SECRET_ACCESS_KEY"
+    SESSION_TOKEN = "DHCORE_AWS_SESSION_TOKEN"
+    BUCKET_NAME = "DHCORE_S3_BUCKET"
+    REGION = "DHCORE_S3_REGION"
+    SIGNATURE_VERSION = "DHCORE_S3_SIGNATURE_VERSION"

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/digitalhub/stores/sql/configurator.py

@@ -55,7 +55,7 @@ class SqlStoreConfigurator:
         str
             The connection string.
         """
-        creds = configurator.get_all_cred()
+        creds = configurator.get_all_credentials()
         try:
             user = creds[SqlStoreEnv.USERNAME.value]
             password = creds[SqlStoreEnv.PASSWORD.value]

digitalhub-0.10.0b5/digitalhub/stores/sql/enums.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class SqlStoreEnv(Enum):
+    """
+    SqlStore environment
+    """
+
+    HOST = "DHCORE_DB_HOST"
+    PORT = "DHCORE_DB_PORT"
+    USERNAME = "DHCORE_DB_USERNAME"
+    PASSWORD = "DHCORE_DB_PASSWORD"
+    DATABASE = "DHCORE_DB_DATABASE"
+    PG_SCHEMA = "DHCORE_DB_SCHEMA"

{digitalhub-0.10.0b4/digitalhub/readers/data/pandas → digitalhub-0.10.0b5/digitalhub/utils}/enums.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from enum import Enum
 
 
-class Extensions(Enum):
+class FileExtensions(Enum):
     """
     Supported file extensions.
     """

digitalhub-0.10.0b5/digitalhub/utils/types.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from typing import Union
+
+SourcesOrListOfSources = Union[str, list[str]]

{digitalhub-0.10.0b4 → digitalhub-0.10.0b5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "digitalhub"
-version = "0.10.0b4"
+version = "0.10.0b5"
 description = "Python SDK for Digitalhub"
 readme = "README.md"
 authors = [
@@ -72,7 +72,7 @@ line-length = 120
 convention = "numpy"
 
 [tool.bumpver]
-current_version = "0.10.0b4"
+current_version = "0.10.0b5"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
 commit_message  = "Bump version {old_version} -> {new_version}"
 commit          = false

digitalhub-0.10.0b4/digitalhub/stores/s3/enums.py

@@ -1,17 +0,0 @@
-from __future__ import annotations
-
-from enum import Enum
-
-
-class S3StoreEnv(Enum):
-    """
-    S3Store environment
-    """
-
-    ENDPOINT_URL = "S3_ENDPOINT_URL"
-    ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
-    SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
-    SESSION_TOKEN = "AWS_SESSION_TOKEN"
-    BUCKET_NAME = "S3_BUCKET"
-    REGION = "S3_REGION"
-    SIGNATURE_VERSION = "S3_SIGNATURE_VERSION"

digitalhub-0.10.0b4/digitalhub/stores/sql/enums.py

@@ -1,16 +0,0 @@
-from __future__ import annotations
-
-from enum import Enum
-
-
-class SqlStoreEnv(Enum):
-    """
-    SqlStore environment
-    """
-
-    HOST = "DB_HOST"
-    PORT = "DB_PORT"
-    USERNAME = "DB_USERNAME"
-    PASSWORD = "DB_PASSWORD"
-    DATABASE = "DB_DATABASE"
-    PG_SCHEMA = "DB_SCHEMA"