digitalhub 0.13.0b3__tar.gz → 0.13.1__tar.gz

{digitalhub-0.13.0b3 → digitalhub-0.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.13.0b3
+Version: 0.13.1
 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.13.0b3 → digitalhub-0.13.1}/digitalhub/entities/_base/material/entity.py

@@ -200,7 +200,7 @@ class MaterialEntity(VersionedEntity):
         list
             Paths of the files in the status.
         """
-        return [f.get("path") for f in self.status.files]
+        return [f.get("path") if f.get("path") is not None else f.get("name") for f in self.status.files]
 
     ##############################
     #  Private Helpers

digitalhub-0.13.1/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.13.0b3 → digitalhub-0.13.1}/digitalhub/entities/_commons/utils.py

@@ -9,17 +9,28 @@ from digitalhub.entities._commons.enums import EntityTypes
 
 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.
+    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.
+        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]
-        Project, entity type, kind, name and uuid.
+        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.
     """
     try:
         # Remove "store://" from the key
@@ -53,17 +64,25 @@ def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
 
 def get_entity_type_from_key(key: str) -> str:
     """
-    Get entity type from key.
+    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 key of the entity.
+        The entity key in standardized format.
 
     Returns
     -------
     str
-        The entity type.
+        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
@@ -71,17 +90,25 @@ def get_entity_type_from_key(key: str) -> str:
 
 def get_project_from_key(key: str) -> str:
     """
-    Get project from key.
+    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 key of the entity.
+        The entity key in standardized format.
 
     Returns
     -------
     str
-        The project.
+        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