digitalhub 0.12.0__tar.gz → 0.13.0b1__tar.gz

{digitalhub-0.12.0 → digitalhub-0.13.0b1}/.github/scripts/cliff.toml

@@ -62,7 +62,6 @@ commit_preprocessors = [
 commit_parsers = [
   { message = "^feat", group = "<!-- 0 --> Features" },
   { message = "^fix", group = "<!-- 1 --> Bug Fixes" },
-  { message = "^refactor", group = "<!-- 2 --> Refactor" },
   { message = "^perf", group = "<!-- 3 --> Performance" },
   { message = "^build", group = "<!-- 4 --> Build" },
   { message = "^doc", group = "<!-- 5 --> Documentation" },

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalhub
-Version: 0.12.0
+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.12.0 → digitalhub-0.13.0b1}/digitalhub/__init__.py

@@ -104,7 +104,7 @@ 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.configurator.api import get_current_env, set_current_env
+from digitalhub.stores.credentials.api import get_current_env, set_current_env
 
 register_entities()
 register_runtimes_entities()

{digitalhub-0.12.0 → digitalhub-0.13.0b1}/digitalhub/entities/_base/executable/entity.py

@@ -5,12 +5,14 @@
 from __future__ import annotations
 
 import typing
+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
 
@@ -123,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.
@@ -139,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:
@@ -184,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.
@@ -202,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
@@ -319,6 +332,12 @@ class ExecutableEntity(VersionedEntity):
     #  Runs
     ##############################
 
+    @abstractmethod
+    def run(self, *args, **kwargs) -> Run:
+        """
+        Create and execute a new run.
+        """
+
     def get_run(
         self,
         identifier: str,
@@ -347,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]:
         """
@@ -373,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.
 
@@ -439,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
@@ -454,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.12.0 → digitalhub-0.13.0b1}/digitalhub/entities/_base/material/entity.py

@@ -83,9 +83,8 @@ class MaterialEntity(VersionedEntity):
             List of file paths.
         """
         store = get_store(self.project, self.spec.path)
-        paths = self.get_file_paths()
         dst = store._build_temp()
-        return store.download(self.spec.path, dst=dst, src=paths)
+        return store.download(self.spec.path, dst=dst)
 
     def download(
         self,
@@ -94,10 +93,7 @@ class MaterialEntity(VersionedEntity):
     ) -> str:
         """
         This function downloads one or more file from storage on local
-        machine.
-        It looks inside the object's status for the file(s) path under
-        files attribute. If it does not find it, it will try to download
-        what it can from spec.path.
+        machine from spec.path.
         The files are downloaded into a destination folder. If the destination
         is not specified, it will set by default under the context path
         as '<ctx-root>/<entity_type>', e.g. './dataitem'.
@@ -115,31 +111,24 @@ class MaterialEntity(VersionedEntity):
         Returns
         -------
         str
-            Downloaded path.
+            Download path.
 
         Examples
         --------
         Download a single file:
 
-        >>> entity.status.files[0]
-        {
-            "path ": "data.csv",
-            "name ": "data.csv",
-            "content_type ": "text/csv;charset=utf-8 "
-        }
         >>> path = entity.download()
         >>> print(path)
         dataitem/data.csv
         """
         store = get_store(self.project, self.spec.path)
-        paths = self.get_file_paths()
 
         if destination is None:
             dst = self._context().root / self.ENTITY_TYPE
         else:
             dst = Path(destination)
 
-        return store.download(self.spec.path, dst=dst, src=paths, overwrite=overwrite)
+        return store.download(self.spec.path, dst, overwrite=overwrite)
 
     def upload(self, source: SourcesOrListOfSources) -> None:
         """
@@ -193,6 +182,10 @@ class MaterialEntity(VersionedEntity):
         -------
         None
         """
+        available = 100 - len(self.status.files)
+        if len(files) > available:
+            files = files[:available]
+
         path_list = self.get_file_paths()
         for f in files:
             if f.get("path") not in path_list:

{digitalhub-0.12.0 → digitalhub-0.13.0b1}/digitalhub/entities/_base/material/utils.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 from pathlib import Path
 
-from digitalhub.stores.data.utils import get_default_store
+from digitalhub.stores.data.api import get_default_store
 from digitalhub.utils.file_utils import eval_zip_type
 from digitalhub.utils.uri_utils import has_local_scheme
 

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

@@ -135,7 +135,7 @@ class ContextEntityOperationsProcessor:
             msg = None
         except Exception as e:
             uploaded = False
-            msg = str(e)
+            msg = str(e.args)
 
         new_obj.status.message = msg
 
@@ -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.12.0 → 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.12.0 → 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.12.0 → 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.12.0 → 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.12.0 → 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.12.0 → 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.12.0 → digitalhub-0.13.0b1}/digitalhub/stores/client/dhcore/client.py

@@ -6,6 +6,7 @@ from __future__ import annotations
 
 import typing
 from typing import Any
+from warnings import warn
 
 from requests import request
 from requests.exceptions import JSONDecodeError
@@ -16,13 +17,19 @@ from digitalhub.stores.client.dhcore.configurator import ClientDHCoreConfigurato
 from digitalhub.stores.client.dhcore.error_parser import ErrorParser
 from digitalhub.stores.client.dhcore.key_builder import ClientDHCoreKeyBuilder
 from digitalhub.stores.client.dhcore.params_builder import ClientDHCoreParametersBuilder
-from digitalhub.utils.exceptions import BackendError
+from digitalhub.utils.exceptions import BackendError, ClientError
 from digitalhub.utils.generic_utils import dump_json
 
 if typing.TYPE_CHECKING:
     from requests import Response
 
 
+# API levels that are supported
+MAX_API_LEVEL = 20
+MIN_API_LEVEL = 13
+LIB_VERSION = 13
+
+
 class ClientDHCore(Client):
     """
     DHCore client.
@@ -56,7 +63,6 @@ class ClientDHCore(Client):
 
         # Client Configurator
         self._configurator = ClientDHCoreConfigurator()
-        self._configurator.configure(config)
 
     ##############################
     # CRUD methods
@@ -165,9 +171,6 @@ class ClientDHCore(Client):
         list[dict]
             Response objects.
         """
-        if kwargs is None:
-            kwargs = {}
-
         if "params" not in kwargs:
             kwargs["params"] = {}
 
@@ -224,9 +227,6 @@ class ClientDHCore(Client):
         list[dict]
             Response objects.
         """
-        if kwargs is None:
-            kwargs = {}
-
         if "params" not in kwargs:
             kwargs["params"] = {}
 
@@ -281,13 +281,28 @@ class ClientDHCore(Client):
             Response object.
         """
         self._configurator.check_config()
-        if kwargs is None:
-            kwargs = {}
-        url = self._configurator.build_url(api)
-        kwargs = self._configurator.set_request_auth(kwargs)
-        return self._make_call(call_type, url, **kwargs)
+        url = self._build_url(api)
+        full_kwargs = self._configurator.get_auth_parameters(kwargs)
+        return self._make_call(call_type, url, **full_kwargs)
+
+    def _build_url(self, api: str) -> str:
+        """
+        Build the url.
+
+        Parameters
+        ----------
+        api : str
+            The api to call.
+
+        Returns
+        -------
+        str
+            The url.
+        """
+        endpoint = self._configurator.get_endpoint()
+        return f"{endpoint}/{api.removeprefix('/')}"
 
-    def _make_call(self, call_type: str, url: str, refresh_token: bool = True, **kwargs) -> dict:
+    def _make_call(self, call_type: str, url: str, refresh: bool = True, **kwargs) -> dict:
         """
         Make a call to the DHCore API.
 
@@ -297,6 +312,8 @@ class ClientDHCore(Client):
             The type of call to make.
         url : str
             The URL to call.
+        refresh : bool
+            Whether to refresh the access token.
         **kwargs : dict
             Keyword arguments to pass to the request.
 
@@ -309,17 +326,37 @@ class ClientDHCore(Client):
         response = request(call_type, url, timeout=60, **kwargs)
 
         # Evaluate DHCore API version
-        self._configurator.check_core_version(response)
+        self._check_core_version(response)
 
-        # Handle token refresh
-        if response.status_code in [401] and refresh_token and self._configurator.oauth2_auth():
-            self._configurator.get_new_access_token()
-            kwargs = self._configurator.set_request_auth(kwargs)
-            return self._make_call(call_type, url, refresh_token=False, **kwargs)
+        # 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.get_auth_parameters(kwargs)
+            return self._make_call(call_type, url, refresh=False, **kwargs)
 
         self._error_parser.parse(response)
         return self._dictify_response(response)
 
+    def _check_core_version(self, response: Response) -> None:
+        """
+        Raise an exception if DHCore API version is not supported.
+
+        Parameters
+        ----------
+        response : Response
+            The response object.
+
+        Returns
+        -------
+        None
+        """
+        if "X-Api-Level" in response.headers:
+            core_api_level = int(response.headers["X-Api-Level"])
+            if not (MIN_API_LEVEL <= core_api_level <= MAX_API_LEVEL):
+                raise ClientError("Backend API level not supported.")
+            if LIB_VERSION < core_api_level:
+                warn("Backend API level is higher than library version. You should consider updating the library.")
+
     def _dictify_response(self, response: Response) -> dict:
         """
         Return dict from response.