digitalhub 0.8.0b7__tar.gz → 0.8.0b11__tar.gz

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub
-Version: 0.8.0b7
+Version: 0.8.0b11
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/__init__.py

@@ -76,7 +76,7 @@ from digitalhub.client.dhcore.utils import refresh_token, set_dhcore_env
 
 # Register entities into registry
 from digitalhub.factory.utils import register_entities, register_runtimes_entities
-from digitalhub.stores.builder import set_store
+from digitalhub.stores.api import set_store
 
 register_entities()
 register_runtimes_entities()

digitalhub-0.8.0b7/digitalhub/client/builder.py → digitalhub-0.8.0b11/digitalhub/client/api.py

@@ -2,66 +2,29 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.client.dhcore.client import ClientDHCore
-from digitalhub.client.local.client import ClientLocal
+from digitalhub.client.builder import client_builder
 
 if typing.TYPE_CHECKING:
     from digitalhub.client._base.client import Client
 
 
-class ClientBuilder:
-    """
-    Client builder class.
-
-    This class is used to create two possible client instances:
-    Local and DHCore.
-    It saves the client instances in the class attributes using
-    singleton pattern.
-    """
-
-    def __init__(self) -> None:
-        self._local = None
-        self._dhcore = None
-
-    def build(self, local: bool = False, config: dict | None = None) -> Client:
-        """
-        Method to create a client instance.
-
-        Parameters
-        ----------
-        local : bool
-            Whether to create a local client or not.
-
-        Returns
-        -------
-        Client
-            Returns the client instance.
-        """
-        if local:
-            if self._local is None:
-                self._local = ClientLocal()
-            return self._local
-
-        if self._dhcore is None:
-            self._dhcore = ClientDHCore(config)
-        return self._dhcore
-
-
-def get_client(local: bool = False) -> Client:
+def check_client_exists(local: bool = False) -> bool:
     """
-    Wrapper around ClientBuilder.build.
+    Check if client exists.
 
     Parameters
     ----------
     local : bool
-        Whether to create a local client or not.
+        Check client existence by local.
 
     Returns
     -------
-    Client
-        The client instance.
+    bool
+        True if client exists, False otherwise.
     """
-    return client_builder.build(local)
+    if local:
+        return client_builder._local is not None
+    return client_builder._dhcore is not None
 
 
 def build_client(local: bool = False, config: dict | None = None) -> None:
@@ -83,23 +46,18 @@ def build_client(local: bool = False, config: dict | None = None) -> None:
     client_builder.build(local, config)
 
 
-def check_client_exists(local: bool = False) -> bool:
+def get_client(local: bool = False) -> Client:
     """
-    Check if client exists.
+    Wrapper around ClientBuilder.build.
 
     Parameters
     ----------
     local : bool
-        Check client existence by local.
+        Whether to create a local client or not.
 
     Returns
     -------
-    bool
-        True if client exists, False otherwise.
+    Client
+        The client instance.
     """
-    if local:
-        return client_builder._local is not None
-    return client_builder._dhcore is not None
-
-
-client_builder = ClientBuilder()
+    return client_builder.build(local)

digitalhub-0.8.0b11/digitalhub/client/builder.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.dhcore.client import ClientDHCore
+from digitalhub.client.local.client import ClientLocal
+
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.client import Client
+
+
+class ClientBuilder:
+    """
+    Client builder class.
+
+    This class is used to create two possible client instances:
+    Local and DHCore.
+    It saves the client instances in the class attributes using
+    singleton pattern.
+    """
+
+    def __init__(self) -> None:
+        self._local = None
+        self._dhcore = None
+
+    def build(self, local: bool = False, config: dict | None = None) -> Client:
+        """
+        Method to create a client instance.
+
+        Parameters
+        ----------
+        local : bool
+            Whether to create a local client or not.
+
+        Returns
+        -------
+        Client
+            Returns the client instance.
+        """
+        if local:
+            if self._local is None:
+                self._local = ClientLocal()
+            return self._local
+
+        if self._dhcore is None:
+            self._dhcore = ClientDHCore(config)
+        return self._dhcore
+
+
+client_builder = ClientBuilder()

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/client/dhcore/client.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import datetime
+import json
 import os
 import typing
 from urllib.parse import urlparse
@@ -83,7 +85,10 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
-        kwargs["json"] = obj
+        if "headers" not in kwargs:
+            kwargs["headers"] = {}
+        kwargs["headers"]['Content-Type'] = "application/json"
+        kwargs["data"] = json.dumps(obj, default=ClientDHCore._json_serialize)
         return self._prepare_call("POST", api, **kwargs)
 
     def read_object(self, api: str, **kwargs) -> dict:
@@ -122,7 +127,10 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
-        kwargs["json"] = obj
+        if "headers" not in kwargs:
+            kwargs["headers"] = {}
+        kwargs["headers"]['Content-Type'] = "application/json"
+        kwargs["data"] = json.dumps(obj, default=ClientDHCore._json_serialize)
         return self._prepare_call("PUT", api, **kwargs)
 
     def delete_object(self, api: str, **kwargs) -> dict:
@@ -165,7 +173,7 @@ class ClientDHCore(Client):
         if kwargs is None:
             kwargs = {}
 
-        if kwargs.get("params") is None:
+        if "params" not in kwargs:
             kwargs["params"] = {}
 
         start_page = 0
@@ -203,12 +211,31 @@ class ClientDHCore(Client):
         try:
             return self.list_objects(api, **kwargs)[0]
         except IndexError:
-            raise IndexError("No objects found")
+            raise BackendError("No object found.")
 
     ##############################
     # Call methods
     ##############################
 
+    @staticmethod
+    def _json_serialize(obj: dict) -> dict:
+        """
+        JSON datetime to ISO format serializer.
+
+        Parameters
+        ----------
+        obj : dict
+            The object to serialize.
+
+        Returns
+        -------
+        dict
+            The serialized object.
+        """
+        if isinstance(obj, (datetime.datetime, datetime.date)):
+            return obj.isoformat()
+        raise TypeError ("Type %s not serializable" % type(obj))
+
     def _prepare_call(self, call_type: str, api: str, **kwargs) -> dict:
         """
         Prepare a call to the DHCore API.
@@ -230,12 +257,12 @@ class ClientDHCore(Client):
         if kwargs is None:
             kwargs = {}
         url = self._endpoint_core + api
-        kwargs = self._set_auth_header(kwargs)
+        kwargs = self._set_auth(kwargs)
         return self._make_call(call_type, url, **kwargs)
 
-    def _set_auth_header(self, kwargs: dict) -> dict:
+    def _set_auth(self, kwargs: dict) -> dict:
         """
-        Set the authentication header.
+        Set the authentication type.
 
         Parameters
         ----------
@@ -245,13 +272,14 @@ class ClientDHCore(Client):
         Returns
         -------
         dict
-            Keyword arguments with the authentication header.
+            Keyword arguments with the authentication parameters.
         """
         if self._auth_type == "basic":
             kwargs["auth"] = self._user, self._password
         elif self._auth_type == "oauth2":
-            kwargs["headers"] = {"Authorization": f"Bearer {self._access_token}"}
-
+            if "headers" not in kwargs:
+                kwargs["headers"] = {}
+            kwargs["headers"]["Authorization"] = f"Bearer {self._access_token}"
         return kwargs
 
     def _make_call(self, call_type: str, url: str, refresh_token: bool = True, **kwargs) -> dict:
@@ -281,7 +309,7 @@ class ClientDHCore(Client):
         # Handle token refresh
         if response.status_code in [401] and refresh_token:
             self._get_new_access_token()
-            kwargs = self._set_auth_header(kwargs)
+            kwargs = self._set_auth(kwargs)
             return self._make_call(call_type, url, refresh_token=False, **kwargs)
 
         self._raise_for_error(response)

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/client/dhcore/utils.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import os
 import typing
 
-from digitalhub.client.builder import check_client_exists, get_client
+from digitalhub.client.api import check_client_exists, get_client
 
 if typing.TYPE_CHECKING:
     from digitalhub.client.dhcore.client import ClientDHCore

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/client/local/client.py

@@ -470,7 +470,7 @@ class ClientLocal(Client):
                     copied = deepcopy(entity)
 
                     # Remove spec if not embedded
-                    if not copied.get("metadata", {}).get("embedded", True):
+                    if not copied.get("metadata", {}).get("embedded", False):
                         copied.pop("spec", None)
 
                     # Add to project spec

digitalhub-0.8.0b11/digitalhub/context/api.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import context_builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.context.context import Context
+    from digitalhub.entities.project._base.entity import Project
+
+
+def check_context(project: str) -> None:
+    """
+    Check if the given project is in the context.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    bool
+        True if the project is in the context, False otherwise.
+    """
+    if project not in context_builder._instances:
+        msg = f"Context missing. Set context by creating or importing a project named '{project}'."
+        raise RuntimeError(msg)
+
+
+def set_context(project: Project) -> None:
+    """
+    Wrapper for ContextBuilder.build().
+
+    Parameters
+    ----------
+    project : Project
+        The project object used to set the current context.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.build(project)
+
+
+def get_context(project: str) -> Context:
+    """
+    Wrapper for ContextBuilder.get().
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    Context
+        The context for the given project name.
+    """
+    return context_builder.get(project)
+
+
+def set_context_object(context: Context) -> None:
+    """
+    Wrapper for ContextBuilder.set().
+
+    Parameters
+    ----------
+    context : Context
+        The context to set.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.set(context)
+
+
+def delete_context(project: str) -> None:
+    """
+    Wrapper for ContextBuilder.remove().
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    None
+    """
+    context_builder.remove(project)

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/context/builder.py

@@ -91,88 +91,4 @@ class ContextBuilder:
         self._instances[context.name] = context
 
 
-def set_context(project: Project) -> None:
-    """
-    Wrapper for ContextBuilder.build().
-
-    Parameters
-    ----------
-    project : Project
-        The project object used to set the current context.
-
-    Returns
-    -------
-    None
-    """
-    context_builder.build(project)
-
-
-def set_context_object(context: Context) -> None:
-    """
-    Wrapper for ContextBuilder.set().
-
-    Parameters
-    ----------
-    context : Context
-        The context to set.
-
-    Returns
-    -------
-    None
-    """
-    context_builder.set(context)
-
-
-def get_context(project: str) -> Context:
-    """
-    Wrapper for ContextBuilder.get().
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-
-    Returns
-    -------
-    Context
-        The context for the given project name.
-    """
-    return context_builder.get(project)
-
-
-def delete_context(project: str) -> None:
-    """
-    Wrapper for ContextBuilder.remove().
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-
-    Returns
-    -------
-    None
-    """
-    context_builder.remove(project)
-
-
-def check_context(project: str) -> None:
-    """
-    Check if the given project is in the context.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-
-    Returns
-    -------
-    bool
-        True if the project is in the context, False otherwise.
-    """
-    if project not in context_builder._instances:
-        msg = f"Context missing. Set context by creating or importing a project named '{project}'."
-        raise RuntimeError(msg)
-
-
 context_builder = ContextBuilder()

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/datastores/_base/datastore.py

@@ -4,7 +4,7 @@ import typing
 from abc import ABCMeta, abstractmethod
 from typing import Any
 
-from digitalhub.readers.builder import get_reader_by_engine
+from digitalhub.readers.api import get_reader_by_engine
 
 if typing.TYPE_CHECKING:
     from digitalhub.stores._base.store import Store
@@ -32,7 +32,7 @@ class Datastore(metaclass=ABCMeta):
         self,
         path: str | list[str],
         extension: str,
-        engine: str | None = "pandas",
+        engine: str | None = None,
         **kwargs,
     ) -> Any:
         """

digitalhub-0.8.0b11/digitalhub/datastores/api.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.datastores.builder import builder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.datastores._base.datastore import Datastore
+
+
+def get_datastore(uri: str) -> Datastore:
+    """
+    Get a datastore instance by URI.
+
+    Parameters
+    ----------
+    uri : str
+        URI to parse.
+
+    Returns
+    -------
+    Datastore
+        The datastore instance.
+    """
+    return builder.get(uri)
+
+
+def get_default_datastore() -> Datastore:
+    """
+    Get the default datastore instance.
+
+    Returns
+    -------
+    Datastore
+        The default datastore instance.
+    """
+    return builder.default()

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/datastores/builder.py

@@ -6,7 +6,7 @@ from digitalhub.datastores.local.datastore import LocalDatastore
 from digitalhub.datastores.remote.datastore import RemoteDatastore
 from digitalhub.datastores.s3.datastore import S3Datastore
 from digitalhub.datastores.sql.datastore import SqlDatastore
-from digitalhub.stores.builder import get_default_store, get_store
+from digitalhub.stores.api import get_default_store, get_store
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
@@ -14,7 +14,12 @@ if typing.TYPE_CHECKING:
     from digitalhub.stores._base.store import Store
 
 
-REGISTRY_DATASTORES = {"local": LocalDatastore, "remote": RemoteDatastore, "s3": S3Datastore, "sql": SqlDatastore}
+REGISTRY_DATASTORES = {
+    "local": LocalDatastore,
+    "remote": RemoteDatastore,
+    "s3": S3Datastore,
+    "sql": SqlDatastore,
+}
 
 
 class DatastoreBuilder:
@@ -103,32 +108,3 @@ class DatastoreBuilder:
 
 
 builder = DatastoreBuilder()
-
-
-def get_datastore(uri: str) -> Datastore:
-    """
-    Get a datastore instance by URI.
-
-    Parameters
-    ----------
-    uri : str
-        URI to parse.
-
-    Returns
-    -------
-    Datastore
-        The datastore instance.
-    """
-    return builder.get(uri)
-
-
-def get_default_datastore() -> Datastore:
-    """
-    Get the default datastore instance.
-
-    Returns
-    -------
-    Datastore
-        The default datastore instance.
-    """
-    return builder.default()

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/datastores/local/datastore.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
+import typing
 from pathlib import Path
 from typing import Any
 
 from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.builder import get_reader_by_object
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.local.store import LocalStore
 
 
 class LocalDatastore(Datastore):
@@ -12,6 +16,10 @@ class LocalDatastore(Datastore):
     Local Datastore class.
     """
 
+    def __init__(self, store: LocalStore, **kwargs) -> None:
+        super().__init__(store, **kwargs)
+        self.store: LocalStore
+
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Method to write a dataframe to a file. Kwargs are passed to df.to_parquet().

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/datastores/remote/datastore.py

@@ -1,15 +1,23 @@
 from __future__ import annotations
 
+import typing
 from typing import Any
 
 from digitalhub.datastores._base.datastore import Datastore
 
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.remote.store import RemoteStore
+
 
 class RemoteDatastore(Datastore):
     """
     Remote Datastore class.
     """
 
+    def __init__(self, store: RemoteStore, **kwargs) -> None:
+        super().__init__(store, **kwargs)
+        self.store: RemoteStore
+
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Method to write a dataframe to a file. Note that this method is not implemented

{digitalhub-0.8.0b7 → digitalhub-0.8.0b11}/digitalhub/datastores/s3/datastore.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
+import typing
 from io import BytesIO
 from typing import Any
 
 from digitalhub.datastores._base.datastore import Datastore
-from digitalhub.readers.builder import get_reader_by_object
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.s3.store import S3Store
 
 
 class S3Datastore(Datastore):
@@ -12,6 +16,10 @@ class S3Datastore(Datastore):
     S3 Datastore class.
     """
 
+    def __init__(self, store: S3Store, **kwargs) -> None:
+        super().__init__(store, **kwargs)
+        self.store: S3Store
+
     def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
         """
         Write a dataframe to S3 based storage. Kwargs are passed to df.to_parquet().