digitalhub 0.12.0__tar.gz → 0.13.0b0__tar.gz

{digitalhub-0.12.0 → digitalhub-0.13.0b0}/.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.0b0}/PKG-INFO

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

@@ -5,6 +5,7 @@
 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
@@ -319,6 +320,12 @@ class ExecutableEntity(VersionedEntity):
     #  Runs
     ##############################
 
+    @abstractmethod
+    def run(self, *args, **kwargs) -> Run:
+        """
+        Create and execute a new run.
+        """
+
     def get_run(
         self,
         identifier: str,

{digitalhub-0.12.0 → digitalhub-0.13.0b0}/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.0b0}/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.0b0}/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
 

{digitalhub-0.12.0 → digitalhub-0.13.0b0}/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()
+        # 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)
-            return self._make_call(call_type, url, refresh_token=False, **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.