digitalhub 0.12.0__tar.gz → 0.13.0__tar.gz

{digitalhub-0.12.0 → digitalhub-0.13.0}/.github/scripts/cliff.toml

@@ -62,7 +62,6 @@ commit_preprocessors = [
 commit_parsers = [
   { message = "^feat", group = "<!-- 0 --> Features" },
   { message = "^fix", group = "<!-- 1 --> Bug Fixes" },
-  { message = "^refactor", group = "<!-- 2 --> Refactor" },
   { message = "^perf", group = "<!-- 3 --> Performance" },
   { message = "^build", group = "<!-- 4 --> Build" },
   { message = "^doc", group = "<!-- 5 --> Documentation" },

{digitalhub-0.12.0 → digitalhub-0.13.0}/.github/workflows/release.yml

@@ -132,7 +132,7 @@ jobs:
           branch=${{ github.ref }}
 
           # Define the repositories to trigger
-          repos=("digitalhub-sdk-wrapper-kfp" "jupyter-notebook-custom-image" "digitalhub-sdk-wrapper-dbt" )
+          repos=("digitalhub-sdk-wrapper-kfp" "jupyter-notebook-custom-image" "digitalhub-sdk-wrapper-hera" "digitalhub-sdk-wrapper-dbt" )
 
           # Loop over the repositories and trigger the workflow
           for repo in "${repos[@]}"; do

{digitalhub-0.12.0 → digitalhub-0.13.0}/PKG-INFO

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

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/__init__.py

@@ -104,7 +104,7 @@ except ImportError:
 # Register entities into registry
 from digitalhub.factory.utils import register_entities, register_runtimes_entities
 from digitalhub.stores.client.dhcore.utils import refresh_token, set_dhcore_env
-from digitalhub.stores.configurator.api import get_current_env, set_current_env
+from digitalhub.stores.credentials.api import get_current_profile, set_current_profile
 
 register_entities()
 register_runtimes_entities()

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/context/api.py

@@ -17,15 +17,15 @@ def build_context(project: Project, overwrite: bool = False) -> Context:
     """
     Build a new context for a project.
 
-    Creates or updates a context instance for the given project in the global
-    context registry.
+    Creates or updates a context instance for the given project
+    in the global context registry.
 
     Parameters
     ----------
     project : Project
         The project object used to build the context.
     overwrite : bool, optional
-        If True, overwrites existing context if it exists, by default False.
+        If True, overwrites existing context if it exists. Default is False.
 
     Returns
     -------
@@ -37,7 +37,7 @@ def build_context(project: Project, overwrite: bool = False) -> Context:
 
 def get_context(project: str) -> Context:
     """
-    Wrapper for ContextBuilder.get().
+    Get the context for a given project name.
 
     Parameters
     ----------
@@ -54,7 +54,7 @@ def get_context(project: str) -> Context:
 
 def delete_context(project: str) -> None:
     """
-    Wrapper for ContextBuilder.remove().
+    Delete the context for a given project name.
 
     Parameters
     ----------

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/context/builder.py

@@ -39,8 +39,7 @@ class ContextBuilder:
         project : Project
             The project instance to create a context for.
         overwrite : bool, optional
-            If True, overwrites existing context if project name already exists,
-            by default False.
+            If True, overwrites existing context if project name already exists. Default is False.
 
         Returns
         -------
@@ -87,12 +86,11 @@ class ContextBuilder:
         Returns
         -------
         None
-            This method doesn't return anything.
+            This method does not return anything.
 
         Notes
         -----
-        If the project doesn't exist in the registry, this method
-        silently does nothing.
+        If the project does not exist in the registry, this method silently does nothing.
         """
         self._instances.pop(project, None)
 

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/context/context.py

@@ -56,6 +56,10 @@ class Context:
         ----------
         run_ctx : str
             The run key to set.
+
+        Returns
+        -------
+        None
         """
         self.is_running = True
         self._run_ctx = run_ctx
@@ -63,6 +67,10 @@ class Context:
     def unset_run(self) -> None:
         """
         Clear the current run key and reset running state.
+
+        Returns
+        -------
+        None
         """
         self.is_running = False
         self._run_ctx = None
@@ -73,7 +81,7 @@ class Context:
 
         Returns
         -------
-        str | None
+        str or None
             The current run key if set, None otherwise.
         """
         return self._run_ctx

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/entities/_base/executable/entity.py

@@ -5,12 +5,14 @@
 from __future__ import annotations
 
 import typing
+from abc import abstractmethod
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._processors.context import context_processor
-from digitalhub.entities.run.crud import delete_run, get_run, list_runs
-from digitalhub.entities.task.crud import delete_task
+from digitalhub.entities.run.crud import list_runs
+from digitalhub.entities.task.crud import delete_task, list_tasks
+from digitalhub.entities.trigger.crud import list_triggers
 from digitalhub.factory.factory import factory
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
@@ -123,13 +125,13 @@ class ExecutableEntity(VersionedEntity):
             if task_obj.spec.function == self._get_executable_string():
                 self._tasks[task_obj.kind] = task_obj
 
-    def new_task(self, task_kind: str, **kwargs) -> Task:
+    def new_task(self, kind: str, **kwargs) -> Task:
         """
         Create new task. If the task already exists, update it.
 
         Parameters
         ----------
-        task_kind : str
+        kind : str
             Kind the object.
         **kwargs : dict
             Keyword arguments.
@@ -139,21 +141,18 @@ class ExecutableEntity(VersionedEntity):
         Task
             New task.
         """
-        self._raise_if_exists(task_kind)
-
-        if kwargs is None:
-            kwargs = {}
+        self._raise_if_exists(kind)
 
         # Override kwargs
         kwargs["project"] = self.project
         kwargs[self.ENTITY_TYPE] = self._get_executable_string()
-        kwargs["kind"] = task_kind
+        kwargs["kind"] = kind
 
         # Create object instance
         task: Task = factory.build_entity_from_params(**kwargs)
         task.save()
 
-        self._tasks[task_kind] = task
+        self._tasks[kind] = task
         return task
 
     def get_task(self, kind: str) -> Task:
@@ -184,6 +183,23 @@ class ExecutableEntity(VersionedEntity):
             self._tasks[kind] = resp[0]
             return self._tasks[kind]
 
+    def list_task(self, **kwargs) -> list[Task]:
+        """
+        List tasks.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        list
+            List of tasks.
+        """
+        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        return list_tasks(self.project, **kwargs)
+
     def update_task(self, kind: str, **kwargs) -> Task:
         """
         Update task.
@@ -202,9 +218,6 @@ class ExecutableEntity(VersionedEntity):
         """
         self._raise_if_not_exists(kind)
 
-        if kwargs is None:
-            kwargs = {}
-
         # Update kwargs
         kwargs["project"] = self.project
         kwargs["kind"] = kind
@@ -319,6 +332,12 @@ class ExecutableEntity(VersionedEntity):
     #  Runs
     ##############################
 
+    @abstractmethod
+    def run(self, *args, **kwargs) -> Run:
+        """
+        Create and execute a new run.
+        """
+
     def get_run(
         self,
         identifier: str,
@@ -347,13 +366,14 @@ class ExecutableEntity(VersionedEntity):
         Using entity ID:
         >>> obj = executable.get_run("123")
         """
-        obj = get_run(
-            identifier=identifier,
-            project=self.project,
-            **kwargs,
-        )
-        self.refresh()
-        return obj
+        entities = self.list_runs(**kwargs)
+        for entity in entities:
+            if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
+                if entity.id == identifier:
+                    return entity
+                if entity.key == identifier:
+                    return entity
+        raise EntityError(f"Run '{identifier}' does not exist or does not belong to this executable.")
 
     def list_runs(self, **kwargs) -> list[Run]:
         """
@@ -373,47 +393,20 @@ class ExecutableEntity(VersionedEntity):
         --------
         >>> objs = executable.list_runs()
         """
-        if kwargs is None:
-            kwargs = {}
         kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
         return list_runs(self.project, **kwargs)
 
-    def delete_run(
-        self,
-        identifier: str,
-        **kwargs,
-    ) -> None:
-        """
-        Delete run from backend.
-
-        Parameters
-        ----------
-        identifier : str
-            Entity key (store://...) or entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
-
-        Returns
-        -------
-        dict
-            Response from backend.
-
-        Examples
-        --------
-        >>> executable.delete_run("store://my-run-key")
-
-        """
-        delete_run(
-            identifier=identifier,
-            project=self.project,
-            **kwargs,
-        )
-
     ##############################
     #  Trigger
     ##############################
 
-    def trigger(self, action: str, trigger_kind: str, trigger_name: str, **kwargs) -> Trigger:
+    def trigger(
+        self,
+        action: str,
+        trigger_kind: str,
+        trigger_name: str,
+        **kwargs,
+    ) -> Trigger:
         """
         Trigger function.
 
@@ -439,9 +432,6 @@ class ExecutableEntity(VersionedEntity):
         # Get run validator for building trigger template
         run_kind = factory.get_run_kind(self.kind)
         run_validator: SpecValidator = factory.get_spec_validator(run_kind)
-        if kwargs is None:
-            kwargs = {}
-
         # Override kwargs
         kwargs["project"] = self.project
         kwargs["kind"] = trigger_kind
@@ -454,3 +444,61 @@ class ExecutableEntity(VersionedEntity):
         trigger: Trigger = factory.build_entity_from_params(**kwargs)
         trigger.save()
         return trigger
+
+    def get_trigger(
+        self,
+        identifier: str,
+        **kwargs,
+    ) -> Trigger:
+        """
+        Get object from backend.
+
+        Parameters
+        ----------
+        identifier : str
+            Entity key (store://...) or entity ID.
+        **kwargs : dict
+            Parameters to pass to the API call.
+
+        Returns
+        -------
+        Trigger
+            Object instance.
+
+        Examples
+        --------
+        Using entity key:
+        >>> obj = executable.get_trigger("store://my-trigger-key")
+
+        Using entity ID:
+        >>> obj = executable.get_trigger("123")
+        """
+        entities = self.list_triggers(**kwargs)
+        for entity in entities:
+            if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
+                if entity.id == identifier:
+                    return entity
+                if entity.key == identifier:
+                    return entity
+        raise EntityError(f"Trigger '{identifier}' does not exist or does not belong to this executable.")
+
+    def list_triggers(self, **kwargs) -> list[Trigger]:
+        """
+        List all triggers from backend.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Parameters to pass to the API call.
+
+        Returns
+        -------
+        list[Trigger]
+            List of object instances.
+
+        Examples
+        --------
+        >>> objs = executable.list_triggers()
+        """
+        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        return list_triggers(self.project, **kwargs)

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/entities/_base/material/entity.py

@@ -82,10 +82,9 @@ class MaterialEntity(VersionedEntity):
         list[str]
             List of file paths.
         """
-        store = get_store(self.project, self.spec.path)
-        paths = self.get_file_paths()
+        store = get_store(self.spec.path)
         dst = store._build_temp()
-        return store.download(self.spec.path, dst=dst, src=paths)
+        return store.download(self.spec.path, dst=dst)
 
     def download(
         self,
@@ -94,10 +93,7 @@ class MaterialEntity(VersionedEntity):
     ) -> str:
         """
         This function downloads one or more file from storage on local
-        machine.
-        It looks inside the object's status for the file(s) path under
-        files attribute. If it does not find it, it will try to download
-        what it can from spec.path.
+        machine from spec.path.
         The files are downloaded into a destination folder. If the destination
         is not specified, it will set by default under the context path
         as '<ctx-root>/<entity_type>', e.g. './dataitem'.
@@ -115,31 +111,24 @@ class MaterialEntity(VersionedEntity):
         Returns
         -------
         str
-            Downloaded path.
+            Download path.
 
         Examples
         --------
         Download a single file:
 
-        >>> entity.status.files[0]
-        {
-            "path ": "data.csv",
-            "name ": "data.csv",
-            "content_type ": "text/csv;charset=utf-8 "
-        }
         >>> path = entity.download()
         >>> print(path)
         dataitem/data.csv
         """
-        store = get_store(self.project, self.spec.path)
-        paths = self.get_file_paths()
+        store = get_store(self.spec.path)
 
         if destination is None:
             dst = self._context().root / self.ENTITY_TYPE
         else:
             dst = Path(destination)
 
-        return store.download(self.spec.path, dst=dst, src=paths, overwrite=overwrite)
+        return store.download(self.spec.path, dst, overwrite=overwrite)
 
     def upload(self, source: SourcesOrListOfSources) -> None:
         """
@@ -169,7 +158,7 @@ class MaterialEntity(VersionedEntity):
         >>> entity.upload('./data')
         """
         # Get store and upload object
-        store = get_store(self.project, self.spec.path)
+        store = get_store(self.spec.path)
         paths = store.upload(source, self.spec.path)
 
         # Update files info
@@ -193,6 +182,10 @@ class MaterialEntity(VersionedEntity):
         -------
         None
         """
+        available = 100 - len(self.status.files)
+        if len(files) > available:
+            files = files[:available]
+
         path_list = self.get_file_paths()
         for f in files:
             if f.get("path") not in path_list:

{digitalhub-0.12.0 → digitalhub-0.13.0}/digitalhub/entities/_base/material/utils.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 from pathlib import Path
 
-from digitalhub.stores.data.utils import get_default_store
+from digitalhub.stores.data.api import get_default_store
 from digitalhub.utils.file_utils import eval_zip_type
 from digitalhub.utils.uri_utils import has_local_scheme
 

digitalhub-0.13.0/digitalhub/entities/_commons/metrics.py

@@ -0,0 +1,202 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Any, Union
+
+from pydantic import BaseModel, ValidationError
+
+MetricType = Union[float, int, list[Union[float, int]]]
+
+
+class Metric(BaseModel):
+    """
+    Pydantic model for validating metric values.
+
+    This model ensures that metric values are of the correct type,
+    accepting single numeric values or lists of numeric values.
+
+    Attributes
+    ----------
+    value : MetricType
+        The metric value, which can be a float, int, or list of floats/ints.
+    """
+
+    value: MetricType
+
+
+def validate_metric_value(value: Any) -> MetricType:
+    """
+    Validate and convert a value to a proper metric type.
+
+    Uses Pydantic validation to ensure the input value conforms to
+    the MetricType specification (float, int, or list of floats/ints).
+
+    Parameters
+    ----------
+    value : Any
+        The value to validate and convert.
+
+    Returns
+    -------
+    MetricType
+        The validated metric value.
+
+    Raises
+    ------
+    ValueError
+        If the value cannot be converted to a valid metric type.
+    """
+    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
+
+
+def set_metrics(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: Any,
+    overwrite: bool,
+    single_value: bool,
+) -> dict[str, MetricType]:
+    """
+    Set or update a metric value in the metrics dictionary.
+
+    This function routes to appropriate handling based on the value type
+    and the single_value flag. It can handle single values, lists, and
+    appending to existing metrics.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        The metrics dictionary to update.
+    key : str
+        The metric key to set or update.
+    value : Any
+        The value to set for the metric.
+    overwrite : bool
+        Whether to overwrite existing metrics.
+    single_value : bool
+        Whether to treat the value as a single metric rather than
+        appending to a list.
+
+    Returns
+    -------
+    dict[str, MetricType]
+        The updated metrics dictionary.
+    """
+    if isinstance(value, list):
+        return handle_metric_list(metrics, key, value, overwrite)
+    elif single_value:
+        return handle_metric_single(metrics, key, value, overwrite)
+    return handle_metric_list_append(metrics, key, value, overwrite)
+
+
+def handle_metric_single(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: float | int,
+    overwrite: bool,
+) -> dict:
+    """
+    Handle setting a single metric value.
+
+    Sets or overwrites a metric with a single numeric value. If the key
+    already exists and overwrite is False, the existing value is preserved.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        The metrics dictionary to update.
+    key : str
+        The metric key to set.
+    value : float | int
+        The single numeric value to set.
+    overwrite : bool
+        Whether to overwrite an existing metric with the same key.
+
+    Returns
+    -------
+    dict
+        The updated metrics dictionary.
+    """
+    if key not in metrics or overwrite:
+        metrics[key] = value
+    return metrics
+
+
+def handle_metric_list_append(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: float | int,
+    overwrite: bool,
+) -> dict:
+    """
+    Handle appending a single value to a metric list.
+
+    If the metric doesn't exist or overwrite is True, creates a new list
+    with the single value. If the metric exists as a list, appends to it.
+    If the metric exists as a single value, converts it to a list and appends.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        The metrics dictionary to update.
+    key : str
+        The metric key to append to.
+    value : float | int
+        The numeric value to append.
+    overwrite : bool
+        Whether to overwrite an existing metric instead of appending.
+
+    Returns
+    -------
+    dict
+        The updated metrics dictionary.
+    """
+    if key not in metrics or overwrite:
+        metrics[key] = [value]
+    elif isinstance(metrics[key], list):
+        metrics[key].append(value)
+    else:
+        metrics[key] = [metrics[key], value]
+    return metrics
+
+
+def handle_metric_list(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: list[int | float],
+    overwrite: bool,
+) -> dict:
+    """
+    Handle setting or extending a metric with a list of values.
+
+    If the metric doesn't exist or overwrite is True, sets the metric to
+    the provided list. If the metric exists and overwrite is False, extends
+    the existing list with the new values.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        The metrics dictionary to update.
+    key : str
+        The metric key to set or extend.
+    value : list[int | float]
+        The list of numeric values to set or extend with.
+    overwrite : bool
+        Whether to overwrite an existing metric instead of extending it.
+
+    Returns
+    -------
+    dict
+        The updated metrics dictionary.
+    """
+    if key not in metrics or overwrite:
+        metrics[key] = value
+    else:
+        metrics[key].extend(value)
+    return metrics