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

digitalhub/datastores/sql/datastore.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+import typing
+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.sql.store import SqlStore
+
+
+class SqlDatastore(Datastore):
+    """
+    Sql Datastore class.
+    """
+
+    def __init__(self, store: SqlStore, **kwargs) -> None:
+        super().__init__(store, **kwargs)
+        self.store: SqlStore
+
+    def write_df(self, df: Any, dst: str, extension: str | None = None, **kwargs) -> str:
+        """
+        Write a dataframe to a database. Kwargs are passed to df.to_sql().
+
+        Parameters
+        ----------
+        df : Any
+            The dataframe to write.
+        dst : str
+            The destination of the dataframe.
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        str
+            Path of written dataframe.
+        """
+        schema = self.store._get_schema(dst)
+        table = self.store._get_table_name(dst)
+        return self._upload_table(df, schema, table, **kwargs)
+
+    def _upload_table(self, df: Any, schema: str, table: str, **kwargs) -> str:
+        """
+        Upload a table to SQL based storage.
+
+        Parameters
+        ----------
+        df : DataFrame
+            The dataframe.
+        schema : str
+            Destination schema.
+        table : str
+            Destination table.
+        **kwargs : dict
+            Keyword arguments.
+
+        Returns
+        -------
+        str
+            The SQL URI where the dataframe was saved.
+        """
+        reader = get_reader_by_object(df)
+        engine = self.store._check_factory()
+        reader.write_table(df, table, engine, schema, **kwargs)
+        engine.dispose()
+        return f"sql://{engine.url.database}/{schema}/{table}"

digitalhub/entities/_base/_base/entity.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from digitalhub.utils.generic_utils import dict_to_json
+
+
+class Base:
+    """
+    Base class for all entities.
+    It implements to_dict abd to_json method to represent
+    the object as a dictionary/json and an any_setter method to
+    set generic attributes coming from a constructor.
+    """
+
+    def to_dict(self) -> dict:
+        """
+        Return object as dict with all non private keys.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        obj = {}
+        for key, value in self.__dict__.items():
+            if not key.startswith("_") and value is not None:
+                if hasattr(value, "to_dict"):
+                    sub_dict = value.to_dict()
+                    if sub_dict:
+                        obj[key] = sub_dict
+                else:
+                    obj[key] = value
+        return obj
+
+    def to_json(self) -> str:
+        """
+        Return object as json with all non private keys.
+
+        Returns
+        -------
+        str
+            A json string containing the attributes of the entity instance.
+        """
+        return dict_to_json(self.to_dict())
+
+    def _any_setter(self, **kwargs) -> None:
+        """
+        Set any attribute of the object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments to be set as attributes.
+
+        Returns
+        -------
+        None
+        """
+        for k, v in kwargs.items():
+            if k not in self.__dict__:
+                setattr(self, k, v)
+
+    def _get_private_attrs(self) -> dict:
+        """
+        Return all private attributes of the object.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the private attributes of the entity instance.
+        """
+        return {k: v for k, v in self.__dict__.items() if k.startswith("_")}
+
+    def __repr__(self) -> str:
+        """
+        Return string representation of the entity object.
+
+        Returns
+        -------
+        str
+            A string representing the entity instance.
+        """
+        return str(self.to_dict())