digitalhub 0.13.0b3__tar.gz → 0.14.0b0__tar.gz

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/.github/scripts/cliff.toml

@@ -62,9 +62,10 @@ commit_preprocessors = [
 commit_parsers = [
   { message = "^feat", group = "<!-- 0 --> Features" },
   { message = "^fix", group = "<!-- 1 --> Bug Fixes" },
-  { message = "^perf", group = "<!-- 3 --> Performance" },
-  { message = "^build", group = "<!-- 4 --> Build" },
-  { message = "^doc", group = "<!-- 5 --> Documentation" },
+  { message = "^perf", group = "<!-- 2 --> Performance" },
+  { message = "^build", group = "<!-- 3 --> Build" },
+  { message = "^doc", group = "<!-- 4 --> Documentation" },
+  { message = "^BREAKING", group = "<!-- 5 --> Breaking Changes" },
   { message = ".*", group = "<!-- 10 --> Other" , skip = true },
 ]
 # filter out the commits that are not matched by commit parsers

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/.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-hera" "digitalhub-sdk-wrapper-dbt" )
+          repos=("digitalhub-sdk-wrapper-kfp" "digitalhub-serverless" "digitalhub-sdk-wrapper-hera" "digitalhub-sdk-wrapper-dbt" )
 
           # Loop over the repositories and trigger the workflow
           for repo in "${repos[@]}"; do

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.13.0b3
+Version: 0.14.0b0
 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>
@@ -252,7 +252,7 @@ Explore the full documentation at the [link](https://scc-digitalhub.github.io/sd
 To install the Digitalhub, you can use pip:
 
 ```bash
-pip install digitalhub
+pip install digitalhub[full]
 ```
 
 To be able to create and execute functions or workflows, you need to install the runtime you want to use. The Digitalhub SDK supports multiple runtimes, each with its own installation instructions:
@@ -261,6 +261,7 @@ To be able to create and execute functions or workflows, you need to install the
 - [Digitalhub SDK Runtime Dbt](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-dbt)
 - [Digitalhub SDK Runtime Container](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-container)
 - [Digitalhub SDK Runtime Kfp](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-kfp)
+- [Digitalhub SDK Runtime Hera](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-hera)
 - [Digitalhub SDK Runtime Modelserve](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-modelserve)
 
 ## Development

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/README.md

@@ -12,7 +12,7 @@ Explore the full documentation at the [link](https://scc-digitalhub.github.io/sd
 To install the Digitalhub, you can use pip:
 
 ```bash
-pip install digitalhub
+pip install digitalhub[full]
 ```
 
 To be able to create and execute functions or workflows, you need to install the runtime you want to use. The Digitalhub SDK supports multiple runtimes, each with its own installation instructions:
@@ -21,6 +21,7 @@ To be able to create and execute functions or workflows, you need to install the
 - [Digitalhub SDK Runtime Dbt](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-dbt)
 - [Digitalhub SDK Runtime Container](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-container)
 - [Digitalhub SDK Runtime Kfp](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-kfp)
+- [Digitalhub SDK Runtime Hera](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-hera)
 - [Digitalhub SDK Runtime Modelserve](https://github.com/scc-digitalhub/digitalhub-sdk-runtime-modelserve)
 
 ## Development

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/digitalhub/__init__.py

@@ -95,16 +95,11 @@ from digitalhub.entities.workflow.crud import (
     new_workflow,
     update_workflow,
 )
+from digitalhub.stores.client.dhcore.utils import refresh_token, set_dhcore_env
+from digitalhub.stores.credentials.api import get_current_profile, set_current_profile
+from digitalhub.utils.store_utils import get_s3_client, get_sql_engine
 
 try:
     from digitalhub.entities.model.mlflow.utils import from_mlflow_run, get_mlflow_model_metrics
 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.credentials.api import get_current_profile, set_current_profile
-
-register_entities()
-register_runtimes_entities()

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/digitalhub/entities/_base/_base/entity.py

@@ -63,17 +63,6 @@ class Base:
             if k not in self.__dict__:
                 setattr(self, k, v)
 
-    def _get_private_attrs(self) -> dict:
-        """
-        Return all private attributes of the object.
-
-        Returns
-        -------
-        dict
-            A dictionary containing the private attributes of the entity instance.
-        """
-        return {k: v for k, v in self.__dict__.items() if k.startswith("_")}
-
     def __repr__(self) -> str:
         """
         Return string representation of the entity object.

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/digitalhub/entities/_base/entity/builder.py

@@ -7,11 +7,11 @@ from __future__ import annotations
 import typing
 from abc import abstractmethod
 
-from digitalhub.entities._base.entity._constructors.metadata import build_metadata
-from digitalhub.entities._base.entity._constructors.name import build_name
-from digitalhub.entities._base.entity._constructors.spec import build_spec
-from digitalhub.entities._base.entity._constructors.status import build_status
-from digitalhub.entities._base.entity._constructors.uuid import build_uuid
+from digitalhub.entities._constructors.metadata import build_metadata
+from digitalhub.entities._constructors.name import build_name
+from digitalhub.entities._constructors.spec import build_spec
+from digitalhub.entities._constructors.status import build_status
+from digitalhub.entities._constructors.uuid import build_uuid
 from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:

{digitalhub-0.13.0b3 → digitalhub-0.14.0b0}/digitalhub/entities/_base/executable/entity.py

@@ -430,7 +430,7 @@ class ExecutableEntity(VersionedEntity):
         task_string = task._get_task_string()
 
         # Get run validator for building trigger template
-        run_kind = factory.get_run_kind(self.kind)
+        run_kind = factory.get_run_kind_from_action(self.kind, action)
         run_validator: SpecValidator = factory.get_spec_validator(run_kind)
         # Override kwargs
         kwargs["project"] = self.project

digitalhub-0.14.0b0/digitalhub/entities/_base/runtime_entity/builder.py

@@ -0,0 +1,145 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from digitalhub.entities._commons.utils import KindAction
+from digitalhub.utils.exceptions import EntityError
+
+
+class RuntimeEntityBuilder:
+    """
+    RuntimeEntity builder.
+    """
+
+    EXECUTABLE_KIND: str = None
+    TASKS_KINDS: list[KindAction] = None
+    RUN_KINDS: list[KindAction] = None
+
+    def __init__(self) -> None:
+        self._validate()
+
+    def _validate(self) -> None:
+        """
+        Validate the entity.
+        """
+        for attr_name in ["EXECUTABLE_KIND", "TASKS_KINDS", "RUN_KINDS"]:
+            value = getattr(self, attr_name)
+            if value is None:
+                raise EntityError(f"{attr_name} must be set")
+
+        for attr_name in ["TASKS_KINDS", "RUN_KINDS"]:
+            self._instance_validation(getattr(self, attr_name))
+
+    def _instance_validation(self, attribute: list[KindAction]) -> None:
+        """
+        Validate if the attribute is a list of KindAction.
+
+        Parameters
+        ----------
+        attribute : list[KindAction]
+            Attribute to validate.
+        """
+        if not isinstance(attribute, list):
+            raise EntityError(f"{attribute} must be a list")
+        for i in attribute:
+            if not isinstance(i, KindAction):
+                raise EntityError(f"{attribute} must be a list of KindAction")
+            if i.kind is None:
+                raise EntityError(f"{attribute} must be a list of KindAction with kind set")
+
+    def get_action_from_task_kind(self, task_kind: str) -> str:
+        """
+        Get action from task kind.
+
+        Parameters
+        ----------
+        task_kind : str
+            Task kind.
+
+        Returns
+        -------
+        str
+            Action.
+        """
+        for task in self.TASKS_KINDS:
+            if task.kind == task_kind:
+                return task.action
+        msg = f"Task kind {task_kind} not allowed."
+        raise EntityError(msg)
+
+    def get_task_kind_from_action(self, action: str) -> list[str]:
+        """
+        Get task kinds from action.
+
+        Parameters
+        ----------
+        action : str
+            Action.
+
+        Returns
+        -------
+        list[str]
+            Task kinds.
+        """
+        for task in self.TASKS_KINDS:
+            if task.action == action:
+                return task.kind
+        msg = f"Action {action} not allowed."
+        raise EntityError(msg)
+
+    def get_run_kind_from_action(self, action: str) -> str:
+        """
+        Get run kind from action.
+
+        Parameters
+        ----------
+        action : str
+            Action.
+
+        Returns
+        -------
+        str
+            Run kind.
+        """
+        for run in self.RUN_KINDS:
+            if run.action == action:
+                return run.kind
+        msg = f"Action {action} not allowed."
+        raise EntityError(msg)
+
+    def get_executable_kind(self) -> str:
+        """
+        Get executable kind.
+
+        Returns
+        -------
+        str
+            Executable kind.
+        """
+        return self.EXECUTABLE_KIND
+
+    def get_all_kinds(self) -> list[str]:
+        """
+        Get all kinds.
+
+        Returns
+        -------
+        list[str]
+            All kinds.
+        """
+        task_kinds = [i.kind for i in self.TASKS_KINDS]
+        run_kinds = [i.kind for i in self.RUN_KINDS]
+        return [self.EXECUTABLE_KIND, *run_kinds, *task_kinds]
+
+    def get_all_actions(self) -> list[str]:
+        """
+        Get all actions.
+
+        Returns
+        -------
+        list[str]
+            All actions.
+        """
+        return [i.action for i in self.TASKS_KINDS]

digitalhub-0.14.0b0/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

digitalhub-0.14.0b0/digitalhub/entities/_commons/utils.py

@@ -0,0 +1,157 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import re
+from collections import namedtuple
+
+from digitalhub.entities._commons.enums import EntityTypes
+
+KindAction = namedtuple("KindAction", ["kind", "action"])
+
+
+KEY_PATTERN_WITH_ID = "store://([^/]+)/([^/]+)/([^/]+)/([^:]+):(.+)"
+KEY_PATTERN_NO_ID = "store://([^/]+)/([^/]+)/([^/]+)/([^:]+)"
+
+
+def is_valid_key(key: str) -> bool:
+    """
+    Check if an entity key is valid.
+
+    Parameters
+    ----------
+    key : str
+        The entity key to validate.
+
+    Returns
+    -------
+    bool
+        True if the key is valid, False otherwise.
+    """
+    return bool(re.fullmatch(KEY_PATTERN_WITH_ID, key) or re.fullmatch(KEY_PATTERN_NO_ID, key))
+
+
+def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
+    """
+    Parse an entity key into its constituent components.
+
+    Extracts project name, entity type, kind, name, and UUID from a
+    standardized entity key format. Handles special cases for tasks
+    and runs which don't have name components.
+
+    Parameters
+    ----------
+    key : str
+        The entity key in format "store://project/type/kind/name:uuid"
+        or "store://project/type/kind/uuid" for tasks and runs.
+
+    Returns
+    -------
+    tuple[str, str, str, str | None, str]
+        A tuple containing (project, entity_type, kind, name, uuid).
+        The name component is None for tasks and runs.
+
+    Raises
+    ------
+    ValueError
+        If the key format is invalid or cannot be parsed.
+    """
+    if not is_valid_key(key):
+        raise ValueError("Invalid entity key format.")
+
+    # Remove "store://" from the key
+    key = key.replace("store://", "")
+
+    # Split the key into parts
+    parts = key.split("/")
+
+    # The project is the first part
+    project = parts[0]
+
+    # The entity type is the second part
+    entity_type = parts[1]
+
+    # The kind is the third part
+    kind = parts[2]
+
+    # Tasks and runs have no name and uuid
+    if entity_type in (EntityTypes.TASK.value, EntityTypes.RUN.value):
+        name = None
+        uuid = parts[3]
+
+    # The name and uuid are separated by a colon in the last part
+    else:
+        name, uuid = parts[3].split(":")
+
+    return project, entity_type, kind, name, uuid
+
+
+def get_entity_type_from_key(key: str) -> str:
+    """
+    Extract the entity type from an entity key.
+
+    Parses the entity key and returns only the entity type component,
+    which indicates the kind of entity (artifact, function, run, etc.).
+
+    Parameters
+    ----------
+    key : str
+        The entity key in standardized format.
+
+    Returns
+    -------
+    str
+        The entity type extracted from the key.
+
+    Raises
+    ------
+    ValueError
+        If the key format is invalid or cannot be parsed.
+    """
+    _, entity_type, _, _, _ = parse_entity_key(key)
+    return entity_type
+
+
+def get_project_from_key(key: str) -> str:
+    """
+    Extract the project name from an entity key.
+
+    Parses the entity key and returns only the project component,
+    which identifies the project context the entity belongs to.
+
+    Parameters
+    ----------
+    key : str
+        The entity key in standardized format.
+
+    Returns
+    -------
+    str
+        The project name extracted from the key.
+
+    Raises
+    ------
+    ValueError
+        If the key format is invalid or cannot be parsed.
+    """
+    project, _, _, _, _ = parse_entity_key(key)
+    return project
+
+
+def map_actions(kind_action_list: list[tuple[str, str]]) -> list[KindAction]:
+    """
+    Build task actions as KindAction namedtuples.
+
+    Parameters
+    ----------
+    kind_action_list : list[tuple[str, str]]
+        List of kind-action couples.
+
+    Returns
+    -------
+    list[KindAction]
+        Returns the task actions as KindAction namedtuples.
+    """
+    return [KindAction(kind, action) for (kind, action) in kind_action_list]