digitalhub 0.10.0b3__tar.gz → 0.10.0b5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.10.0b3
+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.0b3 → 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.0b3 → 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.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/_base/entity/builder.py

@@ -24,10 +24,10 @@ class EntityBuilder:
 
     # Class variables
     ENTITY_TYPE: str = None
-    ENTITY_CLASS: Entity = None
-    ENTITY_SPEC_CLASS: Spec = None
-    ENTITY_SPEC_VALIDATOR: SpecValidator = None
-    ENTITY_STATUS_CLASS: Status = None
+    ENTITY_CLASS: type[Entity] = None
+    ENTITY_SPEC_CLASS: type[Spec] = None
+    ENTITY_SPEC_VALIDATOR: type[SpecValidator] = None
+    ENTITY_STATUS_CLASS: type[Status] = None
     ENTITY_KIND: str = None
 
     def __init__(self) -> None:
@@ -60,7 +60,7 @@ class EntityBuilder:
         """
         return build_name(name)
 
-    def build_uuid(self, uuid: str) -> str:
+    def build_uuid(self, uuid: str | None = None) -> str:
         """
         Build entity uuid.
 

{digitalhub-0.10.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/_base/material/entity.py

@@ -6,6 +6,7 @@ from pathlib import Path
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._operations.processor import processor
 from digitalhub.stores.api import get_store
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -34,9 +35,6 @@ 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.
@@ -139,7 +137,7 @@ class MaterialEntity(VersionedEntity):
 
         return store.download(self.spec.path, dst=dst, src=paths, overwrite=overwrite)
 
-    def upload(self, source: str | list[str]) -> None:
+    def upload(self, source: SourcesOrListOfSources) -> None:
         """
         Upload object from given local path to spec path destination.
         Source must be a local path. If the path is a folder, destination
@@ -178,17 +176,6 @@ 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.
@@ -207,13 +194,13 @@ class MaterialEntity(VersionedEntity):
             if f.get("path") not in path_list:
                 self.status.files.append(f)
 
-    def get_file_paths(self) -> list[str]:
+    def get_file_paths(self) -> list:
         """
         Get the paths of the files in the status.
 
         Returns
         -------
-        list[str]
+        list
             Paths of the files in the status.
         """
         return [f.get("path") for f in self.status.files]

{digitalhub-0.10.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/_base/material/status.py

@@ -15,4 +15,4 @@ class MaterialStatus(Status):
         files: list[dict] | None = None,
     ) -> None:
         super().__init__(state, message)
-        self.files = files
+        self.files = files if files is not None else []

digitalhub-0.10.0b5/digitalhub/entities/_commons/models.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from digitalhub.entities._commons.types import MetricType
+
+
+class Metric(BaseModel):
+    """
+    Metric.
+    """
+
+    value: MetricType

digitalhub-0.10.0b5/digitalhub/entities/_commons/types.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from typing import Union
+
+MetricType = Union[float, int, list[Union[float, int]]]

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

@@ -6,9 +6,10 @@ from pydantic import ValidationError
 
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._commons.models import Metric
+from digitalhub.entities._commons.types import MetricType
 
 
-def parse_entity_key(key: str) -> tuple[str]:
+def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
     """
     Parse the entity key. Returns project, entity type, kind, name and uuid.
 
@@ -19,7 +20,7 @@ def parse_entity_key(key: str) -> tuple[str]:
 
     Returns
     -------
-    tuple[str]
+    tuple[str, str, str, str | None, str]
         Project, entity type, kind, name and uuid.
     """
     try:
@@ -88,7 +89,7 @@ def get_project_from_key(key: str) -> str:
     return project
 
 
-def validate_metric_value(value: Any) -> float | int | list[float | int]:
+def validate_metric_value(value: Any) -> MetricType:
     """
     Validate metric value.
 
@@ -99,7 +100,7 @@ def validate_metric_value(value: Any) -> float | int | list[float | int]:
 
     Returns
     -------
-    float | int | list[float | int]
+    MetricType
         The validated value.
     """
     try:

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

@@ -10,6 +10,7 @@ from digitalhub.entities._commons.utils import get_project_from_key, parse_entit
 from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
 from digitalhub.utils.exceptions import ContextError, EntityAlreadyExistsError, EntityError, EntityNotExistsError
 from digitalhub.utils.io_utils import read_yaml
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     from digitalhub.client._base.client import Client
@@ -605,7 +606,7 @@ class OperationsProcessor:
         MaterialEntity
             Object instance.
         """
-        source = kwargs.pop("source")
+        source: SourcesOrListOfSources = kwargs.pop("source")
         context = self._get_context(kwargs["project"])
         obj = build_entity_from_params(**kwargs)
         if context.is_running:
@@ -648,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)
 
@@ -917,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
@@ -1382,7 +1382,7 @@ class OperationsProcessor:
             project=context.name,
             entity_type=entity_type,
         )
-        return context.client.update_object(api, data, **kwargs)
+        context.client.update_object(api, data, **kwargs)
 
     def read_run_logs(
         self,
@@ -1453,7 +1453,7 @@ class OperationsProcessor:
             entity_type=entity_type,
             entity_id=entity_id,
         )
-        return context.client.create_object(api, **kwargs)
+        context.client.create_object(api, **kwargs)
 
     def resume_run(
         self,
@@ -1488,7 +1488,7 @@ class OperationsProcessor:
             entity_type=entity_type,
             entity_id=entity_id,
         )
-        return context.client.create_object(api, **kwargs)
+        context.client.create_object(api, **kwargs)
 
     def read_files_info(
         self,
@@ -1767,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.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/artifact/artifact/spec.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 from digitalhub.entities.artifact._base.spec import ArtifactSpec, ArtifactValidator
 
 
@@ -23,5 +25,5 @@ class ArtifactValidatorArtifact(ArtifactValidator):
     ArtifactValidatorArtifact validator.
     """
 
-    src_path: str = None
+    src_path: Optional[str] = None
     """Source path of the artifact."""

{digitalhub-0.10.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/artifact/crud.py

@@ -6,6 +6,7 @@ from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._operations.processor import processor
 from digitalhub.entities.artifact._base.entity import Artifact
 from digitalhub.entities.artifact.utils import eval_source, process_kwargs
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.artifact._base.entity import Artifact
@@ -78,7 +79,7 @@ def log_artifact(
     project: str,
     name: str,
     kind: str,
-    source: list[str] | str,
+    source: SourcesOrListOfSources,
     path: str | None = None,
     **kwargs,
 ) -> Artifact:
@@ -93,7 +94,7 @@ def log_artifact(
         Object name.
     kind : str
         Kind the object.
-    source : str
+    source : SourcesOrListOfSources
         Artifact location on local path.
     path : str
         Destination path of the artifact. If not provided, it's generated.

{digitalhub-0.10.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/builders.py

@@ -7,7 +7,7 @@ from digitalhub.entities.model.mlflow.builder import ModelModelBuilder
 from digitalhub.entities.project._base.builder import ProjectProjectBuilder
 from digitalhub.entities.secret._base.builder import SecretSecretBuilder
 
-entity_builders = (
+entity_builders: tuple = (
     (ProjectProjectBuilder.ENTITY_KIND, ProjectProjectBuilder),
     (SecretSecretBuilder.ENTITY_KIND, SecretSecretBuilder),
     (ArtifactArtifactBuilder.ENTITY_KIND, ArtifactArtifactBuilder),
@@ -17,17 +17,14 @@ entity_builders = (
 )
 
 ##############################
-#  Potential uninstalled entities
+#  Add custom entities here
 ##############################
 
 
 try:
     from digitalhub.entities.dataitem.iceberg.builder import DataitemIcebergBuilder
 
-    entity_builders = (
-        *entity_builders,
-        (DataitemIcebergBuilder.ENTITY_KIND, DataitemIcebergBuilder),
-    )
+    entity_builders += ((DataitemIcebergBuilder.ENTITY_KIND, DataitemIcebergBuilder),)
 except ImportError:
     ...
 
@@ -35,29 +32,20 @@ except ImportError:
 try:
     from digitalhub.entities.model.model.builder import ModelMlflowBuilder
 
-    entity_builders = (
-        *entity_builders,
-        (ModelMlflowBuilder.ENTITY_KIND, ModelMlflowBuilder),
-    )
+    entity_builders += ((ModelMlflowBuilder.ENTITY_KIND, ModelMlflowBuilder),)
 except ImportError:
     ...
 
 try:
     from digitalhub.entities.model.sklearn.builder import ModelSklearnBuilder
 
-    entity_builders = (
-        *entity_builders,
-        (ModelSklearnBuilder.ENTITY_KIND, ModelSklearnBuilder),
-    )
+    entity_builders += ((ModelSklearnBuilder.ENTITY_KIND, ModelSklearnBuilder),)
 except ImportError:
     ...
 
 try:
     from digitalhub.entities.model.huggingface.builder import ModelHuggingfaceBuilder
 
-    entity_builders = (
-        *entity_builders,
-        (ModelHuggingfaceBuilder.ENTITY_KIND, ModelHuggingfaceBuilder),
-    )
+    entity_builders += ((ModelHuggingfaceBuilder.ENTITY_KIND, ModelHuggingfaceBuilder),)
 except ImportError:
     ...

{digitalhub-0.10.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/dataitem/crud.py

@@ -6,6 +6,7 @@ from typing import Any
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._operations.processor import processor
 from digitalhub.entities.dataitem.utils import clean_tmp_path, eval_data, eval_source, post_process, process_kwargs
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.dataitem._base.entity import Dataitem
@@ -78,7 +79,7 @@ def log_dataitem(
     project: str,
     name: str,
     kind: str,
-    source: list[str] | str | None = None,
+    source: SourcesOrListOfSources | None = None,
     data: Any | None = None,
     path: str | None = None,
     file_format: str | None = None,
@@ -96,7 +97,7 @@ def log_dataitem(
         Object name.
     kind : str
         Kind the object.
-    source : str
+    source : SourcesOrListOfSources
         Dataitem location on local path.
     data : Any
         Dataframe to log. Alternative to source.

{digitalhub-0.10.0b3 → digitalhub-0.10.0b5}/digitalhub/entities/dataitem/table/models.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
@@ -40,16 +41,16 @@ class TableSchemaFieldEntry(BaseModel):
     type_: FieldType = Field(alias="type")
     """Field type."""
 
-    title: str = None
+    title: Optional[str] = None
     """Field title."""
 
     format_: str = Field(default=None, alias="format")
     """Field format."""
 
-    example: str = None
+    example: Optional[str] = None
     """Field example."""
 
-    description: str = None
+    description: Optional[str] = None
     """Field description."""
 
 

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

@@ -76,9 +76,9 @@ def filter_memoryview(data: list[dict]) -> list[dict]:
     return data
 
 
-def check_preview_size(preview: dict) -> list:
+def check_preview_size(preview: dict) -> dict:
     """
-    Check preview size. If it's too big, return empty list.
+    Check preview size. If it's too big, return empty dict.
 
     Parameters
     ----------
@@ -87,11 +87,11 @@ def check_preview_size(preview: dict) -> list:
 
     Returns
     -------
-    list
+    dict
         Preview.
     """
     if len(dump_json(preview)) >= 64000:
-        return []
+        return {}
     return preview
 
 
@@ -101,9 +101,9 @@ def finalize_preview(preview: list[dict] | None = None, rows_count: int | None =
 
     Parameters
     ----------
-    preview : list[dict] | None
+    preview : list[dict]
         Preview.
-    rows_count : int | None
+    rows_count : int
         Row count.
 
     Returns
@@ -111,7 +111,7 @@ def finalize_preview(preview: list[dict] | None = None, rows_count: int | None =
     dict
         Data preview.
     """
-    data = {}
+    data: dict[str, list[dict] | int] = {}
     if preview is not None:
         data["cols"] = preview
     if rows_count is not None:

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

@@ -10,17 +10,19 @@ 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
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.dataitem._base.entity import Dataitem
 
 
-DEFAULT_EXTENSION = "parquet"
+DEFAULT_EXTENSION = FileExtensions.PARQUET.value
 
 
 def eval_source(
-    source: str | list[str] | None = None,
+    source: SourcesOrListOfSources | None = None,
     data: Any | None = None,
     kind: str | None = None,
     name: str | None = None,
@@ -31,7 +33,7 @@ def eval_source(
 
     Parameters
     ----------
-    source : str | list[str]
+    source : SourcesOrListOfSources
         Source(s).
 
     Returns
@@ -58,7 +60,7 @@ def eval_source(
 def eval_data(
     project: str,
     kind: str,
-    source: str,
+    source: SourcesOrListOfSources,
     data: Any | None = None,
     file_format: str | None = None,
     engine: str | None = None,
@@ -97,7 +99,7 @@ def process_kwargs(
     project: str,
     name: str,
     kind: str,
-    source: str | list[str],
+    source: SourcesOrListOfSources,
     data: Any | None = None,
     path: str | None = None,
     **kwargs,
@@ -113,7 +115,7 @@ def process_kwargs(
         Object name.
     kind : str
         Kind the object.
-    source : str
+    source : SourcesOrListOfSources
         Source(s).
     data : Any
         Dataframe to log. Alternative to source.
@@ -140,19 +142,23 @@ def process_kwargs(
     return kwargs
 
 
-def clean_tmp_path(pth: str) -> None:
+def clean_tmp_path(pth: SourcesOrListOfSources) -> None:
     """
     Clean temporary path.
 
     Parameters
     ----------
-    pth : str
+    pth : SourcesOrListOfSources
         Path to clean.
 
     Returns
     -------
     None
     """
+    if isinstance(pth, list):
+        for p in pth:
+            shutil.rmtree(p, ignore_errors=True)
+        return
     shutil.rmtree(pth, ignore_errors=True)