digitalhub 0.14.0b2__tar.gz → 0.14.0b4__tar.gz

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.14.0b2
+Version: 0.14.0b4
 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.0b2 → digitalhub-0.14.0b4}/digitalhub/context/builder.py

@@ -82,10 +82,6 @@ class ContextBuilder:
         ----------
         project : str
             The name of the project whose context should be removed.
-
-        Returns
-        -------
-        None
             This method does not return anything.
 
         Notes

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/digitalhub/context/context.py

@@ -4,9 +4,12 @@
 
 from __future__ import annotations
 
+import os
 import typing
 from pathlib import Path
 
+from digitalhub.runtimes.enums import RuntimeEnvVar
+
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
     from digitalhub.stores.client._base.client import Client
@@ -47,6 +50,15 @@ class Context:
 
         self.is_running: bool = False
         self._run_ctx: str | None = None
+        self._search_run_ctx()
+
+    def _search_run_ctx(self) -> None:
+        """
+        Search for an existing run id in env.
+        """
+        run_id = os.getenv(RuntimeEnvVar.RUN_ID.value)
+        if run_id is not None:
+            self.set_run(run_id)
 
     def set_run(self, run_ctx: str) -> None:
         """
@@ -56,10 +68,6 @@ class Context:
         ----------
         run_ctx : str
             The run key to set.
-
-        Returns
-        -------
-        None
         """
         self.is_running = True
         self._run_ctx = run_ctx
@@ -67,10 +75,6 @@ class Context:
     def unset_run(self) -> None:
         """
         Clear the current run key and reset running state.
-
-        Returns
-        -------
-        None
         """
         self.is_running = False
         self._run_ctx = None

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/_base/entity.py

@@ -54,10 +54,6 @@ class Base:
         ----------
         **kwargs : dict
             Keyword arguments to be set as attributes.
-
-        Returns
-        -------
-        None
         """
         for k, v in kwargs.items():
             if k not in self.__dict__:

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/context/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.context.api import get_context
 from digitalhub.entities._base.entity.entity import Entity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
 

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/entity/entity.py

@@ -67,10 +67,6 @@ class Entity(Base):
         ----------
         obj : dict
             Mapping representation of object.
-
-        Returns
-        -------
-        None
         """
         self.metadata = obj.metadata
         self.spec = obj.spec
@@ -95,10 +91,6 @@ class Entity(Base):
             The target entity.
         source : str
             The source entity.
-
-        Returns
-        -------
-        None
         """
         if self.metadata.relationships is None:
             self.metadata.relationships = []

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/executable/entity.py

@@ -9,7 +9,7 @@ from abc import abstractmethod
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.entities.run.crud import list_runs
 from digitalhub.entities.task.crud import delete_task, list_tasks
 from digitalhub.entities.trigger.crud import list_triggers
@@ -94,10 +94,6 @@ class ExecutableEntity(VersionedEntity):
         ----------
         tasks : list[dict]
             List of tasks to import.
-
-        Returns
-        -------
-        None
         """
         # Loop over tasks list, in the case where the function
         # is imported from local file.
@@ -183,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]:
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        List all tasks of the executable entity from backend.
+
+        Returns
+        -------
+        list[Task]
+            List of object instances.
+        """
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_tasks(self.project, **kwargs)
 
     def update_task(self, kind: str, **kwargs) -> Task:
@@ -265,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:
         """
@@ -295,10 +332,6 @@ class ExecutableEntity(VersionedEntity):
         kind : str
             Kind the object.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         EntityError
@@ -316,10 +349,6 @@ class ExecutableEntity(VersionedEntity):
         kind : str
             Kind the object.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         EntityError
@@ -338,39 +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:
@@ -379,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,
+        )
 
-        Examples
-        --------
-        >>> objs = executable.list_runs()
+    def _list_runs(self, **kwargs) -> list[Run]:
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        List all runs of the executable entity from backend.
+
+        Returns
+        -------
+        list[Run]
+            List of object instances.
+        """
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_runs(self.project, **kwargs)
 
     ##############################
@@ -425,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)
@@ -449,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.
 
@@ -461,27 +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:
@@ -490,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
         ----------
@@ -503,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.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/material/entity.py

@@ -7,8 +7,9 @@ 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.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.stores.data.api import get_store
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -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.
@@ -142,24 +146,16 @@ class MaterialEntity(VersionedEntity):
         source : str | list[str]
             Local filepath, directory or list of filepaths.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Upload a single file:
 
         >>> entity.spec.path = "s3://bucket/data.csv"
-        >>> entity.upload(
-        ...     "./data.csv"
-        ... )
+        >>> entity.upload("./data.csv")
 
         Upload a folder:
         >>> entity.spec.path = "s3://bucket/data/"
-        >>> entity.upload(
-        ...     "./data"
-        ... )
+        >>> entity.upload("./data")
         """
         # Get store and upload object
         store = get_store(self.spec.path)
@@ -181,10 +177,6 @@ class MaterialEntity(VersionedEntity):
         ----------
         files : list[dict]
             Files to add.
-
-        Returns
-        -------
-        None
         """
         available = 100 - len(self.status.files)
         if len(files) > available:
@@ -218,10 +210,6 @@ class MaterialEntity(VersionedEntity):
         ----------
         files_info : list[dict] | None
             Files info.
-
-        Returns
-        -------
-        None
         """
         if files_info is None:
             return
@@ -233,10 +221,6 @@ class MaterialEntity(VersionedEntity):
     def _get_files_info(self) -> None:
         """
         Get files info from backend.
-
-        Returns
-        -------
-        None
         """
         if not self._context().local and not self.status.files:
             files = context_processor.read_files_info(

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/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.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/unversioned/entity.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/digitalhub/entities/_base/versioned/entity.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata

{digitalhub-0.14.0b2 → digitalhub-0.14.0b4}/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.