digitalhub 0.13.0b4__tar.gz → 0.14.0b0__tar.gz

{digitalhub-0.13.0b4 → 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.0b4 → 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.0b4 → digitalhub-0.14.0b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.13.0b4
+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.0b4 → 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.0b4 → 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.0b4 → 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.0b4 → 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.0b4 → 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.13.0b4 → digitalhub-0.14.0b0}/digitalhub/entities/_commons/utils.py

@@ -4,8 +4,34 @@
 
 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]:
     """
@@ -32,34 +58,34 @@ def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
     ValueError
         If the key format is invalid or cannot be parsed.
     """
-    try:
-        # Remove "store://" from the key
-        key = key.replace("store://", "")
+    if not is_valid_key(key):
+        raise ValueError("Invalid entity key format.")
 
-        # Split the key into parts
-        parts = key.split("/")
+    # Remove "store://" from the key
+    key = key.replace("store://", "")
 
-        # The project is the first part
-        project = parts[0]
+    # Split the key into parts
+    parts = key.split("/")
 
-        # The entity type is the second part
-        entity_type = parts[1]
+    # The project is the first part
+    project = parts[0]
 
-        # The kind is the third part
-        kind = parts[2]
+    # The entity type is the second part
+    entity_type = parts[1]
 
-        # Tasks and runs have no name and uuid
-        if entity_type in (EntityTypes.TASK.value, EntityTypes.RUN.value):
-            name = None
-            uuid = parts[3]
+    # The kind is the third part
+    kind = parts[2]
 
-        # The name and uuid are separated by a colon in the last part
-        else:
-            name, uuid = parts[3].split(":")
+    # Tasks and runs have no name and uuid
+    if entity_type in (EntityTypes.TASK.value, EntityTypes.RUN.value):
+        name = None
+        uuid = parts[3]
 
-        return project, entity_type, kind, name, uuid
-    except Exception as e:
-        raise ValueError("Invalid key format.") from e
+    # 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:
@@ -112,3 +138,20 @@ def get_project_from_key(key: str) -> str:
     """
     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]

{digitalhub-0.13.0b4 → digitalhub-0.14.0b0}/digitalhub/entities/_processors/base.py

@@ -5,6 +5,7 @@
 from __future__ import annotations
 
 import typing
+from warnings import warn
 
 from digitalhub.context.api import delete_context
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
@@ -190,7 +191,7 @@ class BaseEntityOperationsProcessor:
         file : str
             Path to the YAML file containing project configuration.
         **kwargs : dict
-            Additional parameters including 'local' flag.
+            Additional parameters including 'local' and 'reset_id' flags.
 
         Returns
         -------
@@ -207,14 +208,21 @@ class BaseEntityOperationsProcessor:
         obj["status"] = {}
         obj["local"] = client.is_local()
         ent: Project = factory.build_entity_from_dict(obj)
+        reset_id = kwargs.pop("reset_id", False)
 
         try:
             self._create_base_entity(ent._client, ent.ENTITY_TYPE, ent.to_dict())
         except EntityAlreadyExistsError:
-            raise EntityError(f"Entity {ent.name} already exists. If you want to update it, use load instead.")
+            msg = f"Entity {ent.name} already exists."
+            if reset_id:
+                ent._import_entities(obj, reset_id=reset_id)
+                warn(f"{msg} Other entities ids have been imported.")
+                ent.refresh()
+                return ent
+            raise EntityError(f"{msg} If you want to update it, use load instead.")
 
         # Import related entities
-        ent._import_entities(obj)
+        ent._import_entities(obj, reset_id=reset_id)
         ent.refresh()
         return ent
 

{digitalhub-0.13.0b4 → digitalhub-0.14.0b0}/digitalhub/entities/_processors/context.py

@@ -8,6 +8,8 @@ import typing
 from typing import Any
 
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations, Relationship, State
+from digitalhub.entities._commons.utils import is_valid_key
+from digitalhub.entities._constructors.uuid import build_uuid
 from digitalhub.entities._processors.utils import (
     get_context_from_identifier,
     get_context_from_project,
@@ -319,7 +321,7 @@ class ContextEntityOperationsProcessor:
         UnversionedEntity
             The unversioned entity object populated with backend data.
         """
-        if not identifier.startswith("store://"):
+        if not is_valid_key(identifier):
             entity_id = identifier
         else:
             splt = identifier.split(":")
@@ -335,19 +337,25 @@ class ContextEntityOperationsProcessor:
 
     def import_context_entity(
         self,
-        file: str,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = False,
+        context: str | None = None,
     ) -> ContextEntity:
         """
-        Import a context entity from a YAML file and create it in the backend.
-
-        Reads entity configuration from a YAML file and creates a new
-        context entity in the backend. Raises an error if the entity
-        already exists.
+        Import a context entity from a YAML file or from a storage key.
 
         Parameters
         ----------
         file : str
             Path to the YAML file containing entity configuration.
+        key : str
+            Storage key (store://...) to read the entity from.
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
+        context : str, optional
+            Project name to use for context resolution. If None, uses
+            the project specified in the YAML file.
 
         Returns
         -------
@@ -359,32 +367,54 @@ class ContextEntityOperationsProcessor:
         EntityError
             If the entity already exists in the backend.
         """
-        dict_obj: dict = read_yaml(file)
+        if (file is None) == (key is None):
+            raise ValueError("Provide key or file, not both or none.")
+
+        if file is not None:
+            dict_obj: dict = read_yaml(file)
+        else:
+            ctx = get_context_from_identifier(key)
+            dict_obj: dict = self._read_context_entity(ctx, key)
+
         dict_obj["status"] = {}
-        context = get_context_from_project(dict_obj["project"])
+
+        if context is None:
+            context = dict_obj["project"]
+
+        ctx = get_context_from_project(context)
         obj = factory.build_entity_from_dict(dict_obj)
+        if reset_id:
+            new_id = build_uuid()
+            obj.id = new_id
+            obj.metadata.version = new_id
         try:
-            self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
+            bck_obj = self._create_context_entity(ctx, obj.ENTITY_TYPE, obj.to_dict())
+            new_obj: ContextEntity = factory.build_entity_from_dict(bck_obj)
         except EntityAlreadyExistsError:
             raise EntityError(f"Entity {obj.name} already exists. If you want to update it, use load instead.")
-        return obj
+        return new_obj
 
     def import_executable_entity(
         self,
-        file: str,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = False,
+        context: str | None = None,
     ) -> ExecutableEntity:
         """
-        Import an executable entity from a YAML file and create it in the backend.
-
-        Reads executable entity configuration from a YAML file and creates
-        a new executable entity (function or workflow) in the backend.
-        Also imports associated task definitions if present in the file.
+        Import an executable entity from a YAML file or from a storage key.
 
         Parameters
         ----------
         file : str
             Path to the YAML file containing executable entity configuration.
             Can contain a single entity or a list with the executable and tasks.
+        key : str
+            Storage key (store://...) to read the entity from.
+        reset_id : bool
+            Flag to determine if the ID of executable entities should be reset.
+        context : str, optional
+            Project name to use for context resolution.
 
         Returns
         -------
@@ -396,7 +426,15 @@ class ContextEntityOperationsProcessor:
         EntityError
             If the entity already exists in the backend.
         """
-        dict_obj: dict | list[dict] = read_yaml(file)
+        if (file is None) == (key is None):
+            raise ValueError("Provide key or file, not both or none.")
+
+        if file is not None:
+            dict_obj: dict | list[dict] = read_yaml(file)
+        else:
+            ctx = get_context_from_identifier(key)
+            dict_obj: dict = self._read_context_entity(ctx, key)
+
         if isinstance(dict_obj, list):
             exec_dict = dict_obj[0]
             exec_dict["status"] = {}
@@ -406,18 +444,29 @@ class ContextEntityOperationsProcessor:
                 tsk_dicts.append(i)
         else:
             exec_dict = dict_obj
+            exec_dict["status"] = {}
             tsk_dicts = []
 
-        context = get_context_from_project(exec_dict["project"])
+        if context is None:
+            context = exec_dict["project"]
+
+        ctx = get_context_from_project(context)
         obj: ExecutableEntity = factory.build_entity_from_dict(exec_dict)
+
+        if reset_id:
+            new_id = build_uuid()
+            obj.id = new_id
+            obj.metadata.version = new_id
+
         try:
-            self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
+            bck_obj = self._create_context_entity(ctx, obj.ENTITY_TYPE, obj.to_dict())
+            new_obj: ExecutableEntity = factory.build_entity_from_dict(bck_obj)
         except EntityAlreadyExistsError:
             raise EntityError(f"Entity {obj.name} already exists. If you want to update it, use load instead.")
 
-        obj.import_tasks(tsk_dicts)
+        new_obj.import_tasks(tsk_dicts)
 
-        return obj
+        return new_obj
 
     def load_context_entity(
         self,

{digitalhub-0.13.0b4 → digitalhub-0.14.0b0}/digitalhub/entities/_processors/utils.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.context.api import get_context
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations, EntityTypes
-from digitalhub.entities._commons.utils import get_project_from_key, parse_entity_key
+from digitalhub.entities._commons.utils import get_project_from_key, is_valid_key, parse_entity_key
 from digitalhub.factory.factory import factory
 from digitalhub.stores.client.api import get_client
 from digitalhub.utils.exceptions import ContextError, EntityError, EntityNotExistsError
@@ -57,7 +57,7 @@ def parse_identifier(
     ValueError
         If identifier is not a full key and project or entity_type is None.
     """
-    if not identifier.startswith("store://"):
+    if not is_valid_key(identifier):
         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
@@ -93,7 +93,7 @@ def get_context_from_identifier(
     EntityError
         If identifier is not a full key and project parameter is None.
     """
-    if not identifier.startswith("store://"):
+    if not is_valid_key(identifier):
         if project is None:
             raise EntityError("Specify project if you do not specify entity key.")
     else:

{digitalhub-0.13.0b4 → digitalhub-0.14.0b0}/digitalhub/entities/artifact/crud.py

@@ -238,14 +238,25 @@ def list_artifacts(project: str, **kwargs) -> list[Artifact]:
     )
 
 
-def import_artifact(file: str) -> Artifact:
+def import_artifact(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Artifact:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -256,7 +267,12 @@ def import_artifact(file: str) -> Artifact:
     --------
     >>> obj = import_artifact("my-artifact.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_artifact(file: str) -> Artifact: