digitalhub 0.10.3__tar.gz → 0.11.0__tar.gz

{digitalhub-0.10.3 → digitalhub-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.10.3
+Version: 0.11.0
 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.3 → digitalhub-0.11.0}/digitalhub/__init__.py

@@ -72,6 +72,16 @@ from digitalhub.entities.task.crud import (
     new_task,
     update_task,
 )
+from digitalhub.entities.trigger.crud import (
+    delete_trigger,
+    get_trigger,
+    get_trigger_versions,
+    import_trigger,
+    list_triggers,
+    load_trigger,
+    new_trigger,
+    update_trigger,
+)
 from digitalhub.entities.workflow.crud import (
     delete_workflow,
     get_workflow,

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/context/api.py

@@ -9,20 +9,26 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
 
 
-def build_context(project: Project, overwrite: bool = False) -> None:
+def build_context(project: Project, overwrite: bool = False) -> Context:
     """
-    Wrapper for ContextBuilder.build().
+    Build a new context for a project.
+
+    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.
 
     Returns
     -------
-    None
+    Context
+        The newly created or existing context instance.
     """
-    context_builder.build(project, overwrite)
+    return context_builder.build(project, overwrite)
 
 
 def get_context(project: str) -> Context:

digitalhub-0.11.0/digitalhub/context/builder.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.context import Context
+from digitalhub.utils.exceptions import ContextError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.project._base.entity import Project
+
+
+class ContextBuilder:
+    """
+    A builder class for managing project contexts.
+
+    This class implements the builder pattern to create and manage Context instances.
+    It maintains a registry of project contexts, allowing multiple projects to be
+    used simultaneously by storing them with their respective names.
+
+    Attributes
+    ----------
+    _instances : dict[str, Context]
+        Internal registry mapping project names to their Context instances.
+    """
+
+    def __init__(self) -> None:
+        self._instances: dict[str, Context] = {}
+
+    def build(self, project: Project, overwrite: bool = False) -> Context:
+        """
+        Add a project as context and return the created Context instance.
+
+        Parameters
+        ----------
+        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.
+
+        Returns
+        -------
+        Context
+            The newly created or existing Context instance.
+        """
+        if (project.name not in self._instances) or overwrite:
+            self._instances[project.name] = Context(project)
+        return self._instances[project.name]
+
+    def get(self, project: str) -> Context:
+        """
+        Retrieve a context instance by project name.
+
+        Parameters
+        ----------
+        project : str
+            The name of the project whose context to retrieve.
+
+        Returns
+        -------
+        Context
+            The context instance associated with the project.
+
+        Raises
+        ------
+        ContextError
+            If no context exists for the specified project name.
+        """
+        try:
+            return self._instances[project]
+        except KeyError:
+            raise ContextError(f"Context '{project}' not found. Get or create a project named '{project}'.")
+
+    def remove(self, project: str) -> None:
+        """
+        Remove a project's context from the registry.
+
+        Parameters
+        ----------
+        project : str
+            The name of the project whose context should be removed.
+
+        Returns
+        -------
+        None
+            This method doesn't return anything.
+
+        Notes
+        -----
+        If the project doesn't exist in the registry, this method
+        silently does nothing.
+        """
+        self._instances.pop(project, None)
+
+
+context_builder = ContextBuilder()

digitalhub-0.11.0/digitalhub/context/context.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+import typing
+from pathlib import Path
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.project._base.entity import Project
+    from digitalhub.stores.client._base.client import Client
+
+
+class Context:
+    """
+    Context class built from a Project instance.
+
+    Contains project-specific information and state, including project name,
+    client instance, local context paths, and run-time information.
+
+    Attributes
+    ----------
+    name : str
+        The name of the project.
+    client : BaseClient
+        The client instance (local or remote) associated with the project.
+    config : dict
+        Project configuration profile.
+    local : bool
+        Whether the client is local or remote.
+    root : Path
+        The local context project path.
+    is_running : bool
+        Flag indicating if the context has an active run.
+    _run_ctx : str | None
+        Current run key, if any.
+    """
+
+    def __init__(self, project: Project) -> None:
+        self.name: str = project.name
+        self.client: Client = project._client
+        self.config: dict = project.spec.config
+        self.local: bool = project._client.is_local()
+        self.root: Path = Path(project.spec.context)
+        self.root.mkdir(parents=True, exist_ok=True)
+
+        self.is_running: bool = False
+        self._run_ctx: str | None = None
+
+    def set_run(self, run_ctx: str) -> None:
+        """
+        Set the current run key.
+
+        Parameters
+        ----------
+        run_ctx : str
+            The run key to set.
+        """
+        self.is_running = True
+        self._run_ctx = run_ctx
+
+    def unset_run(self) -> None:
+        """
+        Clear the current run key and reset running state.
+        """
+        self.is_running = False
+        self._run_ctx = None
+
+    def get_run_ctx(self) -> str | None:
+        """
+        Get the current run key.
+
+        Returns
+        -------
+        str | None
+            The current run key if set, None otherwise.
+        """
+        return self._run_ctx

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/entities/_base/entity/builder.py

@@ -178,3 +178,14 @@ class EntityBuilder:
             Entity kind.
         """
         return self.ENTITY_KIND
+
+    def get_spec_validator(self) -> type[SpecValidator]:
+        """
+        Get entity spec validator.
+
+        Returns
+        -------
+        type[SpecValidator]
+            Entity spec validator.
+        """
+        return self.ENTITY_SPEC_VALIDATOR

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/entities/_base/executable/entity.py

@@ -7,15 +7,16 @@ 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.factory.api import build_entity_from_dict, build_entity_from_params
+from digitalhub.factory.factory import factory
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
-    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.spec import Spec, SpecValidator
     from digitalhub.entities._base.entity.status import Status
     from digitalhub.entities.run._base.entity import Run
     from digitalhub.entities.task._base.entity import Task
+    from digitalhub.entities.trigger._base.entity import Trigger
 
 
 class ExecutableEntity(VersionedEntity):
@@ -102,7 +103,7 @@ class ExecutableEntity(VersionedEntity):
             # Create a new object from dictionary.
             # the form in which tasks are stored in function
             # status
-            task_obj = build_entity_from_dict(task)
+            task_obj: Task = factory.build_entity_from_dict(task)
 
             # Try to save it in backend to been able to use
             # it for launching runs. In fact, tasks must be
@@ -145,7 +146,7 @@ class ExecutableEntity(VersionedEntity):
         kwargs["kind"] = task_kind
 
         # Create object instance
-        task = build_entity_from_params(**kwargs)
+        task: Task = factory.build_entity_from_params(**kwargs)
         task.save()
 
         self._tasks[task_kind] = task
@@ -207,7 +208,7 @@ class ExecutableEntity(VersionedEntity):
         kwargs["uuid"] = self._tasks[kind].id
 
         # Update task
-        task = build_entity_from_params(**kwargs)
+        task: Task = factory.build_entity_from_params(**kwargs)
         task.save(update=True)
         self._tasks[kind] = task
         return task
@@ -403,3 +404,49 @@ class ExecutableEntity(VersionedEntity):
             project=self.project,
             **kwargs,
         )
+
+    ##############################
+    #  Trigger
+    ##############################
+
+    def trigger(self, action: str, trigger_kind: str, trigger_name: str, **kwargs) -> Trigger:
+        """
+        Trigger function.
+
+        Parameters
+        ----------
+        action : str
+            Action to execute.
+        trigger_kind : str
+            Trigger kind.
+        **kwargs : dict
+            Keyword arguments passed to Run builder.
+
+        Returns
+        -------
+        Run
+            Run instance.
+        """
+        # Get task
+        task_kind = factory.get_task_kind_from_action(self.kind, action)
+        task = self._get_or_create_task(task_kind)
+        task_string = task._get_task_string()
+
+        # 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
+        kwargs["name"] = trigger_name
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
+        kwargs["task"] = task_string
+        kwargs["template"] = run_validator(**kwargs).to_dict()
+
+        # Create object instance
+        trigger: Trigger = factory.build_entity_from_params(**kwargs)
+        trigger.save()
+        return trigger

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/entities/_base/material/utils.py

@@ -2,9 +2,9 @@ from __future__ import annotations
 
 from pathlib import Path
 
-from digitalhub.stores.data.s3.utils import get_s3_bucket_from_env
+from digitalhub.stores.data.utils import get_default_store
 from digitalhub.utils.file_utils import eval_zip_type
-from digitalhub.utils.uri_utils import S3Schemes, has_local_scheme
+from digitalhub.utils.uri_utils import has_local_scheme
 
 
 def eval_local_source(source: str | list[str]) -> None:
@@ -34,7 +34,7 @@ def eval_local_source(source: str | list[str]) -> None:
         raise ValueError("Invalid source path. Source must be a local path.")
 
 
-def eval_zip_sources(source: str | list[str]) -> str:
+def eval_zip_sources(source: str | list[str]) -> bool:
     """
     Evaluate zip sources.
 
@@ -45,21 +45,21 @@ def eval_zip_sources(source: str | list[str]) -> str:
 
     Returns
     -------
-    str
-        S3Schemes.
+    bool
+        True if source is zip.
     """
     if isinstance(source, list):
         if len(source) > 1:
-            return S3Schemes.S3.value
+            return False
         path = source[0]
     else:
         if Path(source).is_dir():
-            return S3Schemes.S3.value
+            return False
         path = source
 
     if not eval_zip_type(path):
-        return S3Schemes.S3.value
-    return S3Schemes.ZIP_S3.value
+        return False
+    return True
 
 
 def build_log_path_from_source(
@@ -90,8 +90,8 @@ def build_log_path_from_source(
     str
         Log path.
     """
-    scheme = eval_zip_sources(source)
-    path = f"{scheme}://{get_s3_bucket_from_env()}/{project}/{entity_type}/{name}/{uuid}"
+    prefix = "zip+" if eval_zip_sources(source) else ""
+    path = f"{prefix}{get_default_store(project)}/{project}/{entity_type}/{name}/{uuid}"
 
     if isinstance(source, list) and len(source) >= 1:
         if len(source) > 1:

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/entities/_commons/enums.py

@@ -17,6 +17,7 @@ class EntityTypes(Enum):
     WORKFLOW = "workflow"
     TASK = "task"
     RUN = "run"
+    TRIGGER = "trigger"
 
 
 class Relationship(Enum):
@@ -55,6 +56,7 @@ class State(Enum):
     STOPPED = "STOPPED"
     SUCCESS = "SUCCESS"
     UNKNOWN = "UNKNOWN"
+    UPLOADING = "UPLOADING"
 
 
 class ApiCategories(Enum):
@@ -103,3 +105,5 @@ class EntityKinds(Enum):
     MODEL_HUGGINGFACE = "huggingface"
     MODEL_SKLEARN = "sklearn"
     SECRET_SECRET = "secret"
+    TRIGGER_SCHEDULER = "scheduler"
+    TRIGGER_LIFECYCLE = "lifecycle"

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/entities/_processors/base.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.context.api import delete_context
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
-from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
+from digitalhub.factory.factory import factory
 from digitalhub.stores.client.api import get_client
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError, EntityNotExistsError
 from digitalhub.utils.io_utils import read_yaml
@@ -84,11 +84,11 @@ class BaseEntityOperationsProcessor:
             client = _entity._client
             obj = _entity
         else:
-            client = get_client(kwargs.get("local"), kwargs.pop("config", None))
-            obj = build_entity_from_params(**kwargs)
+            client = get_client(kwargs.get("local"))
+            obj = factory.build_entity_from_params(**kwargs)
         ent = self._create_base_entity(client, obj.ENTITY_TYPE, obj.to_dict())
         ent["local"] = client.is_local()
-        return build_entity_from_dict(ent)
+        return factory.build_entity_from_dict(ent)
 
     def _read_base_entity(
         self,
@@ -147,10 +147,10 @@ class BaseEntityOperationsProcessor:
         Project
             Object instance.
         """
-        client = get_client(kwargs.pop("local", False), kwargs.pop("config", None))
+        client = get_client(kwargs.pop("local", False))
         obj = self._read_base_entity(client, entity_type, entity_name, **kwargs)
         obj["local"] = client.is_local()
-        return build_entity_from_dict(obj)
+        return factory.build_entity_from_dict(obj)
 
     def import_project_entity(
         self,
@@ -172,11 +172,11 @@ class BaseEntityOperationsProcessor:
         Project
             Object instance.
         """
-        client = get_client(kwargs.pop("local", False), kwargs.pop("config", None))
+        client = get_client(kwargs.pop("local", False))
         obj: dict = read_yaml(file)
         obj["status"] = {}
         obj["local"] = client.is_local()
-        ent: Project = build_entity_from_dict(obj)
+        ent: Project = factory.build_entity_from_dict(obj)
 
         try:
             self._create_base_entity(ent._client, ent.ENTITY_TYPE, ent.to_dict())
@@ -208,10 +208,10 @@ class BaseEntityOperationsProcessor:
         Project
             Object instance.
         """
-        client = get_client(kwargs.pop("local", False), kwargs.pop("config", None))
+        client = get_client(kwargs.pop("local", False))
         obj: dict = read_yaml(file)
         obj["local"] = client.is_local()
-        ent: Project = build_entity_from_dict(obj)
+        ent: Project = factory.build_entity_from_dict(obj)
 
         try:
             self._update_base_entity(ent._client, ent.ENTITY_TYPE, ent.name, ent.to_dict())
@@ -278,7 +278,7 @@ class BaseEntityOperationsProcessor:
         entities = []
         for obj in objs:
             obj["local"] = client.is_local()
-            ent = build_entity_from_dict(obj)
+            ent = factory.build_entity_from_dict(obj)
             entities.append(ent)
         return entities
 
@@ -345,10 +345,10 @@ class BaseEntityOperationsProcessor:
         Project
             Object instance.
         """
-        client = get_client(kwargs.pop("local", False), kwargs.pop("config", None))
+        client = get_client(kwargs.pop("local", False))
         obj = self._update_base_entity(client, entity_type, entity_name, entity_dict, **kwargs)
         obj["local"] = client.is_local()
-        return build_entity_from_dict(obj)
+        return factory.build_entity_from_dict(obj)
 
     def _delete_base_entity(
         self,
@@ -414,7 +414,7 @@ class BaseEntityOperationsProcessor:
         """
         if kwargs.pop("clean_context", True):
             delete_context(entity_name)
-        client = get_client(kwargs.pop("local", False), kwargs.pop("config", None))
+        client = get_client(kwargs.pop("local", False))
         return self._delete_base_entity(
             client,
             entity_type,
@@ -493,7 +493,7 @@ class BaseEntityOperationsProcessor:
         -------
         None
         """
-        client = get_client(kwargs.pop("local", False), kwargs.pop("config", None))
+        client = get_client(kwargs.pop("local", False))
         api = client.build_api(
             ApiCategories.BASE.value,
             BackendOperations.SHARE.value,

{digitalhub-0.10.3 → digitalhub-0.11.0}/digitalhub/entities/_processors/context.py

@@ -3,13 +3,13 @@ from __future__ import annotations
 import typing
 from typing import Any
 
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations, Relationship
+from digitalhub.entities._commons.enums import ApiCategories, BackendOperations, Relationship, State
 from digitalhub.entities._processors.utils import (
     get_context_from_identifier,
     get_context_from_project,
     parse_identifier,
 )
-from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
+from digitalhub.factory.factory import factory
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError, EntityNotExistsError
 from digitalhub.utils.io_utils import read_yaml
 from digitalhub.utils.types import SourcesOrListOfSources
@@ -91,9 +91,9 @@ class ContextEntityOperationsProcessor:
             obj = _entity
         else:
             context = get_context_from_project(kwargs["project"])
-            obj: ContextEntity = build_entity_from_params(**kwargs)
+            obj: ContextEntity = factory.build_entity_from_params(**kwargs)
         new_obj = self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
-        return build_entity_from_dict(new_obj)
+        return factory.build_entity_from_dict(new_obj)
 
     def log_material_entity(
         self,
@@ -114,13 +114,36 @@ class ContextEntityOperationsProcessor:
         """
         source: SourcesOrListOfSources = kwargs.pop("source")
         context = get_context_from_project(kwargs["project"])
-        obj = build_entity_from_params(**kwargs)
+        obj = factory.build_entity_from_params(**kwargs)
         if context.is_running:
             obj.add_relationship(Relationship.PRODUCEDBY.value, context.get_run_ctx())
 
         new_obj: MaterialEntity = self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
-        new_obj = build_entity_from_dict(new_obj)
-        new_obj.upload(source)
+        new_obj = factory.build_entity_from_dict(new_obj)
+
+        new_obj.status.state = State.UPLOADING.value
+        new_obj = self._update_material_entity(new_obj)
+
+        # Handle file upload
+        try:
+            new_obj.upload(source)
+            uploaded = True
+            msg = None
+        except Exception as e:
+            uploaded = False
+            msg = str(e)
+
+        new_obj.status.message = msg
+
+        # Update status after upload
+        if uploaded:
+            new_obj.status.state = State.READY.value
+            new_obj = self._update_material_entity(new_obj)
+        else:
+            new_obj.status.state = State.ERROR.value
+            new_obj = self._update_material_entity(new_obj)
+            raise EntityError(msg)
+
         return new_obj
 
     def _read_context_entity(
@@ -226,7 +249,7 @@ class ContextEntityOperationsProcessor:
             entity_id=entity_id,
             **kwargs,
         )
-        entity = build_entity_from_dict(obj)
+        entity = factory.build_entity_from_dict(obj)
         return self._post_process_get(entity)
 
     def read_unversioned_entity(
@@ -292,7 +315,7 @@ class ContextEntityOperationsProcessor:
         dict_obj: dict = read_yaml(file)
         dict_obj["status"] = {}
         context = get_context_from_project(dict_obj["project"])
-        obj = build_entity_from_dict(dict_obj)
+        obj = factory.build_entity_from_dict(dict_obj)
         try:
             self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
         except EntityAlreadyExistsError:
@@ -329,7 +352,7 @@ class ContextEntityOperationsProcessor:
             tsk_dicts = []
 
         context = get_context_from_project(exec_dict["project"])
-        obj: ExecutableEntity = build_entity_from_dict(exec_dict)
+        obj: ExecutableEntity = factory.build_entity_from_dict(exec_dict)
         try:
             self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
         except EntityAlreadyExistsError:
@@ -358,7 +381,7 @@ class ContextEntityOperationsProcessor:
         """
         dict_obj: dict = read_yaml(file)
         context = get_context_from_project(dict_obj["project"])
-        obj: ContextEntity = build_entity_from_dict(dict_obj)
+        obj: ContextEntity = factory.build_entity_from_dict(dict_obj)
         try:
             self._update_context_entity(context, obj.ENTITY_TYPE, obj.id, obj.to_dict())
         except EntityNotExistsError:
@@ -391,7 +414,7 @@ class ContextEntityOperationsProcessor:
             tsk_dicts = []
 
         context = get_context_from_project(exec_dict["project"])
-        obj: ExecutableEntity = build_entity_from_dict(exec_dict)
+        obj: ExecutableEntity = factory.build_entity_from_dict(exec_dict)
 
         try:
             self._update_context_entity(context, obj.ENTITY_TYPE, obj.id, obj.to_dict())
@@ -486,7 +509,7 @@ class ContextEntityOperationsProcessor:
         )
         objects = []
         for o in objs:
-            entity: ContextEntity = build_entity_from_dict(o)
+            entity: ContextEntity = factory.build_entity_from_dict(o)
             entity = self._post_process_get(entity)
             objects.append(entity)
         return objects
@@ -549,11 +572,35 @@ class ContextEntityOperationsProcessor:
         objs = self._list_context_entities(context, entity_type, **kwargs)
         objects = []
         for o in objs:
-            entity: ContextEntity = build_entity_from_dict(o)
+            entity: ContextEntity = factory.build_entity_from_dict(o)
             entity = self._post_process_get(entity)
             objects.append(entity)
         return objects
 
+    def _update_material_entity(
+        self,
+        new_obj: MaterialEntity,
+    ) -> dict:
+        """
+        Update material object shortcut.
+
+        Parameters
+        ----------
+        new_obj : MaterialEntity
+            Object instance.
+
+        Returns
+        -------
+        dict
+            Response from backend.
+        """
+        return self.update_context_entity(
+            new_obj.project,
+            new_obj.ENTITY_TYPE,
+            new_obj.id,
+            new_obj.to_dict(),
+        )
+
     def _update_context_entity(
         self,
         context: Context,
@@ -629,7 +676,7 @@ class ContextEntityOperationsProcessor:
             entity_dict,
             **kwargs,
         )
-        return build_entity_from_dict(obj)
+        return factory.build_entity_from_dict(obj)
 
     def _delete_context_entity(
         self,