digitalhub 0.13.0b0__tar.gz → 0.13.0b1__tar.gz

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.13.0b0
+Version: 0.13.0b1
 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.0b0 → digitalhub-0.13.0b1}/digitalhub/entities/_base/executable/entity.py

@@ -10,8 +10,9 @@ 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.run.crud import delete_run, get_run, list_runs
-from digitalhub.entities.task.crud import delete_task
+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
 from digitalhub.factory.factory import factory
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
@@ -124,13 +125,13 @@ class ExecutableEntity(VersionedEntity):
             if task_obj.spec.function == self._get_executable_string():
                 self._tasks[task_obj.kind] = task_obj
 
-    def new_task(self, task_kind: str, **kwargs) -> Task:
+    def new_task(self, kind: str, **kwargs) -> Task:
         """
         Create new task. If the task already exists, update it.
 
         Parameters
         ----------
-        task_kind : str
+        kind : str
             Kind the object.
         **kwargs : dict
             Keyword arguments.
@@ -140,21 +141,18 @@ class ExecutableEntity(VersionedEntity):
         Task
             New task.
         """
-        self._raise_if_exists(task_kind)
-
-        if kwargs is None:
-            kwargs = {}
+        self._raise_if_exists(kind)
 
         # Override kwargs
         kwargs["project"] = self.project
         kwargs[self.ENTITY_TYPE] = self._get_executable_string()
-        kwargs["kind"] = task_kind
+        kwargs["kind"] = kind
 
         # Create object instance
         task: Task = factory.build_entity_from_params(**kwargs)
         task.save()
 
-        self._tasks[task_kind] = task
+        self._tasks[kind] = task
         return task
 
     def get_task(self, kind: str) -> Task:
@@ -185,6 +183,23 @@ class ExecutableEntity(VersionedEntity):
             self._tasks[kind] = resp[0]
             return self._tasks[kind]
 
+    def list_task(self, **kwargs) -> list[Task]:
+        """
+        List tasks.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        list
+            List of tasks.
+        """
+        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        return list_tasks(self.project, **kwargs)
+
     def update_task(self, kind: str, **kwargs) -> Task:
         """
         Update task.
@@ -203,9 +218,6 @@ class ExecutableEntity(VersionedEntity):
         """
         self._raise_if_not_exists(kind)
 
-        if kwargs is None:
-            kwargs = {}
-
         # Update kwargs
         kwargs["project"] = self.project
         kwargs["kind"] = kind
@@ -354,13 +366,14 @@ class ExecutableEntity(VersionedEntity):
         Using entity ID:
         >>> obj = executable.get_run("123")
         """
-        obj = get_run(
-            identifier=identifier,
-            project=self.project,
-            **kwargs,
-        )
-        self.refresh()
-        return obj
+        entities = self.list_runs(**kwargs)
+        for entity in entities:
+            if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
+                if entity.id == identifier:
+                    return entity
+                if entity.key == identifier:
+                    return entity
+        raise EntityError(f"Run '{identifier}' does not exist or does not belong to this executable.")
 
     def list_runs(self, **kwargs) -> list[Run]:
         """
@@ -380,47 +393,20 @@ class ExecutableEntity(VersionedEntity):
         --------
         >>> objs = executable.list_runs()
         """
-        if kwargs is None:
-            kwargs = {}
         kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
         return list_runs(self.project, **kwargs)
 
-    def delete_run(
-        self,
-        identifier: str,
-        **kwargs,
-    ) -> None:
-        """
-        Delete run from backend.
-
-        Parameters
-        ----------
-        identifier : str
-            Entity key (store://...) or entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
-
-        Returns
-        -------
-        dict
-            Response from backend.
-
-        Examples
-        --------
-        >>> executable.delete_run("store://my-run-key")
-
-        """
-        delete_run(
-            identifier=identifier,
-            project=self.project,
-            **kwargs,
-        )
-
     ##############################
     #  Trigger
     ##############################
 
-    def trigger(self, action: str, trigger_kind: str, trigger_name: str, **kwargs) -> Trigger:
+    def trigger(
+        self,
+        action: str,
+        trigger_kind: str,
+        trigger_name: str,
+        **kwargs,
+    ) -> Trigger:
         """
         Trigger function.
 
@@ -446,9 +432,6 @@ class ExecutableEntity(VersionedEntity):
         # 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
@@ -461,3 +444,61 @@ class ExecutableEntity(VersionedEntity):
         trigger: Trigger = factory.build_entity_from_params(**kwargs)
         trigger.save()
         return trigger
+
+    def get_trigger(
+        self,
+        identifier: str,
+        **kwargs,
+    ) -> Trigger:
+        """
+        Get object from backend.
+
+        Parameters
+        ----------
+        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)
+        for entity in entities:
+            if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
+                if entity.id == identifier:
+                    return entity
+                if entity.key == identifier:
+                    return entity
+        raise EntityError(f"Trigger '{identifier}' does not exist or does not belong to this executable.")
+
+    def list_triggers(self, **kwargs) -> list[Trigger]:
+        """
+        List all triggers from backend.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Parameters to pass to the API call.
+
+        Returns
+        -------
+        list[Trigger]
+            List of object instances.
+
+        Examples
+        --------
+        >>> objs = executable.list_triggers()
+        """
+        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        return list_triggers(self.project, **kwargs)

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

@@ -984,7 +984,7 @@ class ContextEntityOperationsProcessor:
         )
         return context.client.read_object(api, **kwargs)
 
-    def stop_run(
+    def stop_entity(
         self,
         project: str,
         entity_type: str,
@@ -1019,7 +1019,7 @@ class ContextEntityOperationsProcessor:
         )
         context.client.create_object(api, **kwargs)
 
-    def resume_run(
+    def resume_entity(
         self,
         project: str,
         entity_type: str,

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

@@ -311,6 +311,7 @@ def delete_artifact(
     project: str | None = None,
     entity_id: str | None = None,
     delete_all_versions: bool = False,
+    cascade: bool = True,
     **kwargs,
 ) -> dict:
     """
@@ -326,6 +327,8 @@ def delete_artifact(
         Entity ID.
     delete_all_versions : bool
         Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    cascade : bool
+        Cascade delete.
     **kwargs : dict
         Parameters to pass to the API call.
 
@@ -350,5 +353,6 @@ def delete_artifact(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
+        cascade=cascade,
         **kwargs,
     )

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/entities/dataitem/crud.py

@@ -329,6 +329,7 @@ def delete_dataitem(
     project: str | None = None,
     entity_id: str | None = None,
     delete_all_versions: bool = False,
+    cascade: bool = True,
     **kwargs,
 ) -> dict:
     """
@@ -344,6 +345,8 @@ def delete_dataitem(
         Entity ID.
     delete_all_versions : bool
         Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    cascade : bool
+        Cascade delete.
     **kwargs : dict
         Parameters to pass to the API call.
 
@@ -368,5 +371,6 @@ def delete_dataitem(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
+        cascade=cascade,
         **kwargs,
     )

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/entities/model/crud.py

@@ -310,6 +310,7 @@ def delete_model(
     project: str | None = None,
     entity_id: str | None = None,
     delete_all_versions: bool = False,
+    cascade: bool = True,
     **kwargs,
 ) -> dict:
     """
@@ -325,6 +326,8 @@ def delete_model(
         Entity ID.
     delete_all_versions : bool
         Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    cascade : bool
+        Cascade delete.
     **kwargs : dict
         Parameters to pass to the API call.
 
@@ -349,5 +352,6 @@ def delete_model(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
+        cascade=cascade,
         **kwargs,
     )

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/entities/project/_base/entity.py

@@ -2092,8 +2092,6 @@ class Project(Entity):
         --------
         >>> objs = project.list_runs()
         """
-        if kwargs is None:
-            kwargs = {}
         return list_runs(self.name, **kwargs)
 
     def delete_run(

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/entities/run/_base/entity.py

@@ -147,7 +147,7 @@ class Run(UnversionedEntity):
         None
         """
         if not self.spec.local_execution:
-            return context_processor.stop_run(self.project, self.ENTITY_TYPE, self.id)
+            return context_processor.stop_entity(self.project, self.ENTITY_TYPE, self.id)
 
     def resume(self) -> None:
         """
@@ -158,7 +158,7 @@ class Run(UnversionedEntity):
         None
         """
         if not self.spec.local_execution:
-            return context_processor.resume_run(self.project, self.ENTITY_TYPE, self.id)
+            return context_processor.resume_entity(self.project, self.ENTITY_TYPE, self.id)
 
     def log_metric(
         self,

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/entities/trigger/_base/entity.py

@@ -8,6 +8,7 @@ import typing
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._processors.context import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -36,3 +37,13 @@ class Trigger(VersionedEntity):
         super().__init__(project, name, uuid, kind, metadata, spec, status, user)
         self.spec: TriggerSpec
         self.status: TriggerStatus
+
+    def stop(self) -> None:
+        """
+        Stop trigger.
+
+        Returns
+        -------
+        None
+        """
+        return context_processor.stop_entity(self.project, self.ENTITY_TYPE, self.id)

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/stores/client/dhcore/client.py

@@ -331,7 +331,7 @@ class ClientDHCore(Client):
         # Handle token refresh (redo call)
         if (response.status_code in [401]) and (refresh) and self._configurator.refreshable_auth_types():
             self._configurator.get_new_access_token(change_origin=True)
-            kwargs = self._configurator.set_request_auth(kwargs)
+            kwargs = self._configurator.get_auth_parameters(kwargs)
             return self._make_call(call_type, url, refresh=False, **kwargs)
 
         self._error_parser.parse(response)

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/stores/client/dhcore/configurator.py

@@ -473,6 +473,8 @@ class ClientDHCoreConfigurator(Configurator):
             and creds[CredsEnvVar.DHCORE_REFRESH_TOKEN.value] is not None
         ):
             return AuthType.OAUTH2.value
+        if creds[CredsEnvVar.DHCORE_ACCESS_TOKEN.value] is not None:
+            return AuthType.ACCESS_TOKEN.value
         if creds[CredsEnvVar.DHCORE_USER.value] is not None and creds[CredsEnvVar.DHCORE_PASSWORD.value] is not None:
             return AuthType.BASIC.value
         return None

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/digitalhub/stores/client/dhcore/enums.py

@@ -31,3 +31,4 @@ class AuthType(Enum):
     BASIC = "basic"
     OAUTH2 = "oauth2"
     EXCHANGE = "exchange"
+    ACCESS_TOKEN = "access_token_only"

{digitalhub-0.13.0b0 → digitalhub-0.13.0b1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "digitalhub"
-version = "0.13.0b0"
+version = "0.13.0b1"
 description = "Python SDK for Digitalhub"
 readme = "README.md"
 authors = [
@@ -68,7 +68,7 @@ line-length = 120
 convention = "numpy"
 
 [tool.bumpver]
-current_version = "0.13.0b0"
+current_version = "0.13.0b1"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
 commit_message  = "Bump version {old_version} -> {new_version}"
 commit          = false