digitalhub 0.14.0b3__tar.gz → 0.14.0b5__tar.gz

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.14.0b3
+Version: 0.14.0b5
 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.14.0b3 → digitalhub-0.14.0b5}/digitalhub/context/context.py

@@ -8,7 +8,10 @@ import os
 import typing
 from pathlib import Path
 
+from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.runtimes.enums import RuntimeEnvVar
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
+from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
@@ -58,7 +61,18 @@ class Context:
         """
         run_id = os.getenv(RuntimeEnvVar.RUN_ID.value)
         if run_id is not None:
-            self.set_run(run_id)
+            try:
+                api = self.client.build_api(
+                    category=ApiCategories.CONTEXT.value,
+                    operation=BackendOperations.READ.value,
+                    project=self.name,
+                    entity_type=EntityTypes.RUN.value,
+                    entity_id=run_id,
+                )
+                run_key = self.client.read_object(api=api)["key"]
+                self.set_run(run_key)
+            except BackendError:
+                pass
 
     def set_run(self, run_ctx: str) -> None:
         """

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

@@ -179,21 +179,62 @@ class ExecutableEntity(VersionedEntity):
             self._tasks[kind] = resp[0]
             return self._tasks[kind]
 
-    def list_task(self, **kwargs) -> list[Task]:
+    def list_task(
+        self,
+        q: str | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        user: str | None = None,
+        state: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+    ) -> list[Task]:
         """
-        List tasks.
+        List tasks of the executable entity from backend.
 
         Parameters
         ----------
-        **kwargs : dict
-            Keyword arguments.
+        q : str
+            Query string to filter objects.
+        name : str
+            Object name.
+        kind : str
+            Kind of the object.
+        user : str
+            User that created the object.
+        state : str
+            Object state.
+        created : str
+            Creation date filter.
+        updated : str
+            Update date filter.
 
         Returns
         -------
-        list
-            List of tasks.
+        list[Task]
+            List of object instances.
+        """
+        return self._list_tasks(
+            self.project,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+        )
+
+    def _list_tasks(self, **kwargs) -> list[Task]:
+        """
+        List all tasks of the executable entity from backend.
+
+        Returns
+        -------
+        list[Task]
+            List of object instances.
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_tasks(self.project, **kwargs)
 
     def update_task(self, kind: str, **kwargs) -> Task:
@@ -261,7 +302,7 @@ class ExecutableEntity(VersionedEntity):
             Response from backend.
         """
         params = {self.ENTITY_TYPE: self._get_executable_string(), "kind": kind}
-        return context_processor.list_context_entities(self.project, EntityTypes.TASK.value, params=params)
+        return context_processor.list_context_entities(self.project, EntityTypes.TASK.value, **params)
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """
@@ -326,35 +367,21 @@ class ExecutableEntity(VersionedEntity):
         Create and execute a new run.
         """
 
-    def get_run(
-        self,
-        identifier: str,
-        **kwargs,
-    ) -> Run:
+    def get_run(self, identifier: str) -> Run:
         """
-        Get object from backend.
+        Get specific run object of the executable from backend.
 
         Parameters
         ----------
         identifier : str
             Entity key (store://...) or entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
         Run
             Object instance.
-
-        Examples
-        --------
-        Using entity key:
-        >>> obj = executable.get_run("store://my-secret-key")
-
-        Using entity ID:
-        >>> obj = executable.get_run("123")
         """
-        entities = self.list_runs(**kwargs)
+        entities = self._list_runs()
         for entity in entities:
             if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
                 if entity.id == identifier:
@@ -363,25 +390,69 @@ class ExecutableEntity(VersionedEntity):
                     return entity
         raise EntityError(f"Run '{identifier}' does not exist or does not belong to this executable.")
 
-    def list_runs(self, **kwargs) -> list[Run]:
+    def list_runs(
+        self,
+        q: str | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        user: str | None = None,
+        state: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+        task: str | None = None,
+        action: str | None = None,
+    ) -> list[Run]:
         """
-        List all runs from backend.
+        List runs of the executable entity from backend.
 
         Parameters
         ----------
-        **kwargs : dict
-            Parameters to pass to the API call.
+        q : str
+            Query string to filter objects.
+        name : str
+            Object name.
+        kind : str
+            Kind of the object.
+        user : str
+            User that created the object.
+        state : str
+            Object state.
+        created : str
+            Creation date filter.
+        updated : str
+            Update date filter.
+        task : str
+            Task string filter.
+        action : str
+            Action name filter.
 
         Returns
         -------
         list[Run]
             List of object instances.
+        """
+        return self._list_runs(
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            task=task,
+            action=action,
+        )
+
+    def _list_runs(self, **kwargs) -> list[Run]:
+        """
+        List all runs of the executable entity from backend.
 
-        Examples
-        --------
-        >>> objs = executable.list_runs()
+        Returns
+        -------
+        list[Run]
+            List of object instances.
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_runs(self.project, **kwargs)
 
     ##############################
@@ -409,8 +480,8 @@ class ExecutableEntity(VersionedEntity):
 
         Returns
         -------
-        Run
-            Run instance.
+        Trigger
+            Object instance.
         """
         # Get task
         task_kind = entity_factory.get_task_kind_from_action(self.kind, action)
@@ -433,11 +504,7 @@ class ExecutableEntity(VersionedEntity):
         trigger.save()
         return trigger
 
-    def get_trigger(
-        self,
-        identifier: str,
-        **kwargs,
-    ) -> Trigger:
+    def get_trigger(self, identifier: str) -> Trigger:
         """
         Get object from backend.
 
@@ -445,23 +512,13 @@ class ExecutableEntity(VersionedEntity):
         ----------
         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)
+        entities = self._list_triggers()
         for entity in entities:
             if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
                 if entity.id == identifier:
@@ -470,9 +527,58 @@ class ExecutableEntity(VersionedEntity):
                     return entity
         raise EntityError(f"Trigger '{identifier}' does not exist or does not belong to this executable.")
 
-    def list_triggers(self, **kwargs) -> list[Trigger]:
+    def list_triggers(
+        self,
+        q: str | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        user: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+        version: str | None = None,
+        task: str | None = None,
+    ) -> list[Trigger]:
         """
-        List all triggers from backend.
+        List triggers of the executable entity from backend.
+
+        Parameters
+        ----------
+        q : str
+            Query string to filter objects.
+        name : str
+            Object name.
+        kind : str
+            Kind of the object.
+        user : str
+            User that created the object.
+        created : str
+            Creation date filter.
+        updated : str
+            Update date filter.
+        version : str
+            Object version, default is latest.
+        task : str
+            Task string filter.
+
+        Returns
+        -------
+        list[Trigger]
+            List of object instances.
+        """
+        return self._list_triggers(
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            created=created,
+            updated=updated,
+            version=version,
+            task=task,
+        )
+
+    def _list_triggers(self, **kwargs) -> list[Trigger]:
+        """
+        List triggers of the executable from backend.
 
         Parameters
         ----------
@@ -483,10 +589,6 @@ class ExecutableEntity(VersionedEntity):
         -------
         list[Trigger]
             List of object instances.
-
-        Examples
-        --------
-        >>> objs = executable.list_triggers()
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_triggers(self.project, **kwargs)

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/digitalhub/entities/_base/material/entity.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 import typing
 from pathlib import Path
 
+from digitalhub.entities._base.material.utils import refresh_decorator
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._processors.processors import context_processor
 from digitalhub.stores.data.api import get_store
@@ -72,6 +73,7 @@ class MaterialEntity(VersionedEntity):
     # I/O Methods
     ##############################
 
+    @refresh_decorator
     def as_file(self) -> list[str]:
         """
         Get object as file(s). It downloads the object from storage in
@@ -86,6 +88,7 @@ class MaterialEntity(VersionedEntity):
         dst = store._build_temp()
         return store.download(self.spec.path, dst=dst)
 
+    @refresh_decorator
     def download(
         self,
         destination: str | None = None,
@@ -130,6 +133,7 @@ class MaterialEntity(VersionedEntity):
 
         return store.download(self.spec.path, dst, overwrite=overwrite)
 
+    @refresh_decorator
     def upload(self, source: SourcesOrListOfSources) -> None:
         """
         Upload object from given local path to spec path destination.

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/digitalhub/entities/_base/material/utils.py

@@ -4,9 +4,11 @@
 
 from __future__ import annotations
 
+import typing
 from pathlib import Path
 
 from digitalhub.stores.data.api import get_default_store
+from digitalhub.utils.exceptions import BackendError
 from digitalhub.utils.file_utils import eval_zip_type
 from digitalhub.utils.uri_utils import has_local_scheme
 
@@ -108,3 +110,29 @@ def build_log_path_from_source(
         path += f"/{Path(source).name}"
 
     return path
+
+
+def refresh_decorator(fn: typing.Callable) -> typing.Callable:
+    """
+    Refresh decorator.
+
+    Parameters
+    ----------
+    fn : Callable
+        Function to decorate.
+
+    Returns
+    -------
+    Callable
+        Decorated function.
+    """
+
+    def wrapper(self, *args, **kwargs):
+        # Prevent rising error if entity is not yet created in backend
+        try:
+            self.refresh()
+        except BackendError:
+            pass
+        return fn(self, *args, **kwargs)
+
+    return wrapper

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/digitalhub/entities/_commons/enums.py

@@ -63,37 +63,6 @@ class State(Enum):
     UPLOADING = "UPLOADING"
 
 
-class ApiCategories(Enum):
-    """
-    Entity categories.
-    """
-
-    BASE = "base"
-    CONTEXT = "context"
-
-
-class BackendOperations(Enum):
-    """
-    Backend operations.
-    """
-
-    CREATE = "create"
-    READ = "read"
-    READ_ALL_VERSIONS = "read_all_versions"
-    UPDATE = "update"
-    DELETE = "delete"
-    LIST = "list"
-    LIST_FIRST = "list_first"
-    STOP = "stop"
-    RESUME = "resume"
-    DATA = "data"
-    FILES = "files"
-    LOGS = "logs"
-    SEARCH = "search"
-    SHARE = "share"
-    METRICS = "metrics"
-
-
 class EntityKinds(Enum):
     """
     Entity kinds.

digitalhub-0.14.0b5/digitalhub/entities/_constructors/_resources.py

@@ -0,0 +1,151 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+ANIMALS = [
+    "ant",
+    "bear",
+    "bee",
+    "bison",
+    "cat",
+    "cheetah",
+    "cougar",
+    "crane",
+    "deer",
+    "dolphin",
+    "duck",
+    "eagle",
+    "falcon",
+    "finch",
+    "fox",
+    "frog",
+    "gecko",
+    "hawk",
+    "heron",
+    "horse",
+    "jaguar",
+    "koala",
+    "leopard",
+    "lion",
+    "llama",
+    "lynx",
+    "mole",
+    "moose",
+    "otter",
+    "owl",
+    "panda",
+    "penguin",
+    "rabbit",
+    "robin",
+    "seal",
+    "shark",
+    "sparrow",
+    "tiger",
+    "tortoise",
+    "wolf",
+]
+
+ADJECTIVES = [
+    "able",
+    "agile",
+    "alert",
+    "alpha",
+    "amber",
+    "apex",
+    "arctic",
+    "atomic",
+    "balanced",
+    "basic",
+    "bold",
+    "bright",
+    "brisk",
+    "calm",
+    "clever",
+    "clear",
+    "cloudy",
+    "crisp",
+    "curious",
+    "cyber",
+    "daring",
+    "deep",
+    "delta",
+    "digital",
+    "dynamic",
+    "early",
+    "easy",
+    "electric",
+    "epic",
+    "fast",
+    "firm",
+    "fluent",
+    "focused",
+    "fresh",
+    "friendly",
+    "full",
+    "future",
+    "gentle",
+    "global",
+    "golden",
+    "grand",
+    "great",
+    "green",
+    "happy",
+    "high",
+    "honest",
+    "hyper",
+    "ideal",
+    "infinite",
+    "inner",
+    "instant",
+    "keen",
+    "kind",
+    "known",
+    "large",
+    "light",
+    "linear",
+    "logical",
+    "lucky",
+    "lunar",
+    "magic",
+    "major",
+    "mega",
+    "mild",
+    "modern",
+    "neat",
+    "noble",
+    "open",
+    "outer",
+    "peak",
+    "perfect",
+    "plain",
+    "prime",
+    "pure",
+    "quick",
+    "quiet",
+    "rapid",
+    "rare",
+    "ready",
+    "real",
+    "red",
+    "right",
+    "safe",
+    "sharp",
+    "silent",
+    "simple",
+    "smart",
+    "solid",
+    "solar",
+    "speedy",
+    "stable",
+    "steady",
+    "stellar",
+    "strong",
+    "swift",
+    "true",
+    "ultra",
+    "vast",
+    "vital",
+    "wise",
+]

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/digitalhub/entities/_constructors/name.py

@@ -4,8 +4,12 @@
 
 from __future__ import annotations
 
+import random
+
 from pydantic import BaseModel, Field
 
+from digitalhub.entities._constructors._resources import ADJECTIVES, ANIMALS
+
 NAME_REGEX = r"^[a-zA-Z0-9._+-]+$"
 
 
@@ -33,3 +37,17 @@ def build_name(name: str) -> str:
     """
     NameValidator(name=name)
     return name
+
+
+def random_name() -> str:
+    """
+    Generate a random name.
+
+    Returns
+    -------
+    str
+        The random name.
+    """
+    adjective = random.choice(ADJECTIVES)
+    animal = random.choice(ANIMALS)
+    return f"{adjective}-{animal}"

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/digitalhub/entities/_processors/base/crud.py

@@ -7,8 +7,8 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.api import delete_context
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
 from digitalhub.factory.entity import entity_factory
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
 from digitalhub.stores.client.api import get_client
 
 if typing.TYPE_CHECKING:

{digitalhub-0.14.0b3 → digitalhub-0.14.0b5}/digitalhub/entities/_processors/base/special_ops.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
 from digitalhub.stores.client.api import get_client
 
 if typing.TYPE_CHECKING: