digitalhub 0.7.0b2__py3-none-any.whl → 0.8.0__py3-none-any.whl

digitalhub/context/api.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import context_builder
+from digitalhub.utils.exceptions import ContextError
+
+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:
+        raise ContextError
+
+
+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/context/builder.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.context import Context
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.project._base.entity import Project
+
+
+class ContextBuilder:
+    """
+    ContextBuilder class.
+    It implements the builder pattern to create a context instance.
+    It allows to use multiple projects as context at the same time
+    by adding them to the _instances registry with their name.
+    """
+
+    def __init__(self) -> None:
+        self._instances: dict[str, Context] = {}
+
+    def build(self, project_object: Project) -> None:
+        """
+        Add a project as context.
+
+        Parameters
+        ----------
+        project_object : Project
+            The project to add.
+
+        Returns
+        -------
+        None
+        """
+        self._instances[project_object.name] = Context(project_object)
+
+    def get(self, project: str) -> Context:
+        """
+        Get a context from project name if it exists.
+
+        Parameters
+        ----------
+        project : str
+            The project name.
+
+        Returns
+        -------
+        Context
+            The project context.
+
+        Raises
+        ------
+        ValueError
+            If the project is not in the context.
+        """
+        ctx = self._instances.get(project)
+        if ctx is None:
+            raise ValueError(
+                f"Context '{project}' not found. Please get or create a project named '{project}' to access its objects."
+            )
+        return ctx
+
+    def remove(self, project: str) -> None:
+        """
+        Remove a project from the context.
+
+        Parameters
+        ----------
+        project : str
+            The project name.
+
+        Returns
+        -------
+        None
+        """
+        self._instances.pop(project, None)
+
+    def set(self, context: Context) -> None:
+        """
+        Set the context.
+
+        Parameters
+        ----------
+        context : Context
+            The context to set.
+
+        Returns
+        -------
+        None
+        """
+        self._instances[context.name] = context
+
+
+context_builder = ContextBuilder()

digitalhub/context/context.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+import typing
+from pathlib import Path
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.project._base.entity import Project
+
+
+class Context:
+    """
+    Context class built forom a `Project` instance. It contains
+    some information about the project, such as the project name,
+    a client instance (local or non-local), the local context
+    project path and information about client locality.
+    It exposes CRUD operations for the entities and act as a layer
+    between the project object and its client.
+    """
+
+    def __init__(self, project: Project) -> None:
+        self.name = project.name
+        self.client = project._client
+        self.local = project._client.is_local()
+        self.root = Path(project.spec.context)
+
+    def create_object(self, api: str, obj: dict, **kwargs) -> dict:
+        """
+        Create an object.
+
+        Parameters
+        ----------
+        api : str
+            Create API.
+        obj : dict
+            Object to create.
+        **kwargs : dict
+            Keyword arguments passed to the request.
+
+        Returns
+        -------
+        dict
+            Response object.
+        """
+        return self.client.create_object(api, obj, **kwargs)
+
+    def read_object(self, api: str, **kwargs) -> dict:
+        """
+        Read an object.
+
+        Parameters
+        ----------
+        api : str
+            Read API.
+        **kwargs : dict
+            Keyword arguments passed to the request.
+
+        Returns
+        -------
+        dict
+            Response object.
+        """
+        return self.client.read_object(api, **kwargs)
+
+    def update_object(self, api: str, obj: dict, **kwargs) -> dict:
+        """
+        Update an object.
+
+        Parameters
+        ----------
+        api : str
+            Update API.
+        obj : dict
+            Object to update.
+        **kwargs : dict
+            Keyword arguments passed to the request.
+
+        Returns
+        -------
+        dict
+            Response object.
+        """
+        return self.client.update_object(api, obj, **kwargs)
+
+    def delete_object(self, api: str, **kwargs) -> dict:
+        """
+        Delete an object.
+
+        Parameters
+        ----------
+        api : str
+            Delete API.
+        **kwargs : dict
+            Keyword arguments passed to the request.
+
+        Returns
+        -------
+        dict
+            Response object.
+        """
+        return self.client.delete_object(api, **kwargs)
+
+    def list_objects(self, api: str, **kwargs) -> dict:
+        """
+        List objects.
+
+        Parameters
+        ----------
+        api : str
+            The api to list the objects with.
+        **kwargs : dict
+            Keyword arguments passed to the request.
+
+        Returns
+        -------
+        dict
+            The list of objects.
+        """
+        return self.client.list_objects(api, **kwargs)
+
+    def list_first_object(self, api: str, **kwargs) -> dict:
+        """
+        List first objects.
+
+        Parameters
+        ----------
+        api : str
+            The api to list the objects with.
+        **kwargs : dict
+            Keyword arguments passed to the request.
+
+        Returns
+        -------
+        dict
+            The list of objects.
+        """
+        return self.client.list_first_object(api, **kwargs)

digitalhub/datastores/_base/datastore.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+import typing
+from abc import ABCMeta, abstractmethod
+from typing import Any
+
+from digitalhub.readers.api import get_reader_by_engine
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores._base.store import Store
+
+
+class Datastore(metaclass=ABCMeta):
+    """
+    Datastore abstract class.
+    """
+
+    def __init__(self, store: Store, **kwargs) -> None:
+        self.store = store
+
+    ##############################
+    # IO methods
+    ##############################
+
+    @abstractmethod
+    def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
+        """
+        Write DataFrame as parquet or csv.
+        """
+
+    def read_df(
+        self,
+        path: str | list[str],
+        extension: str,
+        engine: str | None = None,
+        **kwargs,
+    ) -> Any:
+        """
+        Read DataFrame from path.
+
+        Parameters
+        ----------
+        path : str | list[str]
+            Path(s) to read DataFrame from.
+        extension : str
+            Extension of the file.
+        engine : str
+            Dataframe engine (pandas, polars, etc.).
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        Any
+            DataFrame.
+        """
+        reader = get_reader_by_engine(engine)
+        self._validate_extension(extension)
+        return reader.read_df(path, extension, **kwargs)
+
+    ##############################
+    # Helper methods
+    ##############################
+
+    @staticmethod
+    def _validate_extension(extension: str) -> None:
+        """
+        Validate extension.
+
+        Parameters
+        ----------
+        extension : str
+            Extension of the file.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        ValueError
+            If extension is not supported.
+        """
+        if extension not in ["csv", "parquet", "file"]:
+            raise ValueError(f"Extension {extension} not supported.")

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/datastores/builder.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+import typing
+
+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.api import get_default_store, get_store
+from digitalhub.utils.uri_utils import map_uri_scheme
+
+if typing.TYPE_CHECKING:
+    from digitalhub.datastores._base.datastore import Datastore
+    from digitalhub.stores._base.store import Store
+
+
+REGISTRY_DATASTORES = {
+    "local": LocalDatastore,
+    "remote": RemoteDatastore,
+    "s3": S3Datastore,
+    "sql": SqlDatastore,
+}
+
+
+class DatastoreBuilder:
+    """
+    Datastore builder class.
+    """
+
+    def __init__(self) -> None:
+        self._instances: dict[str, Datastore] = {}
+        self._default: Datastore | None = None
+        self._def_scheme = "s3"
+
+    def build(self, uri: str) -> None:
+        """
+        Build a datastore instance and register it.
+        It overrides any existing instance.
+
+        Parameters
+        ----------
+        uri : str
+            URI to parse.
+
+        Returns
+        -------
+        None
+        """
+        store = get_store(uri)
+        self._instances[store.type] = self.build_datastore(store)
+
+    def get(self, uri: str) -> Datastore:
+        """
+        Get a store instance by URI.
+
+        Parameters
+        ----------
+        uri : str
+            URI to parse.
+
+        Returns
+        -------
+        Datastore
+            The datastore instance.
+        """
+        scheme = map_uri_scheme(uri)
+        if scheme not in self._instances:
+            self.build(uri)
+        return self._instances[scheme]
+
+    def default(self) -> Datastore:
+        """
+        Get the default store instance.
+
+        Returns
+        -------
+        Datastore
+            The default datastore instance.
+        """
+        if self._default is None:
+            store = get_default_store()
+            self._default = self.build_datastore(store)
+        return self._default
+
+    def build_datastore(self, store: Store) -> Datastore:
+        """
+        Build a datastore instance.
+
+        Parameters
+        ----------
+        store : Store
+            Store instance.
+
+        Returns
+        -------
+        Datastore
+            The datastore instance.
+
+        Raises
+        ------
+        NotImplementedError
+            If the store type is not implemented.
+        """
+        try:
+            return REGISTRY_DATASTORES[store.type](store)
+        except KeyError as e:
+            raise NotImplementedError from e
+
+
+builder = DatastoreBuilder()

digitalhub/datastores/local/datastore.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import typing
+from pathlib import Path
+from typing import Any
+
+from digitalhub.datastores._base.datastore import Datastore
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.local.store import LocalStore
+
+
+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().
+        If destination is not provided, the dataframe is written to the default
+        store path with generated name.
+
+        Parameters
+        ----------
+        df : Any
+            The dataframe to write.
+        dst : str
+            The destination of the dataframe.
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        str
+            Path of written dataframe.
+        """
+        self.store._check_local_dst(dst)
+        self._validate_extension(Path(dst).suffix.removeprefix("."))
+
+        # Write dataframe
+        reader = get_reader_by_object(df)
+        reader.write_df(df, dst, extension=extension, **kwargs)
+
+        return dst

digitalhub/datastores/remote/datastore.py

@@ -0,0 +1,31 @@
+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
+        since the remote store is not meant to write dataframes.
+
+        Raises
+        ------
+        NotImplementedError
+            This method is not implemented.
+        """
+        raise NotImplementedError("Remote store does not support write_df.")

digitalhub/datastores/s3/datastore.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+import typing
+from io import BytesIO
+from typing import Any
+
+from digitalhub.datastores._base.datastore import Datastore
+from digitalhub.readers.api import get_reader_by_object
+
+if typing.TYPE_CHECKING:
+    from digitalhub.stores.s3.store import S3Store
+
+
+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().
+
+        Parameters
+        ----------
+        df : Any
+            The dataframe.
+        dst : str
+            The destination path on S3 based storage.
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        str
+            The S3 path where the dataframe was saved.
+        """
+        fileobj = BytesIO()
+        reader = get_reader_by_object(df)
+        reader.write_df(df, fileobj, extension=extension, **kwargs)
+
+        key = self.store._get_key(dst)
+        return self.store.upload_fileobject(fileobj, key)