squirrels 0.5.0b1__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

squirrels/_connection_set.py

@@ -4,8 +4,8 @@ from sqlalchemy import Engine
 import time, polars as pl
 
 from . import _utils as u, _constants as c, _py_module as pm
-from .arguments.init_time_args import ConnectionsArgs
-from ._manifest import ManifestConfig, ConnectionProperties, ConnectionType
+from ._arguments._init_time_args import ConnectionsArgs
+from ._manifest import ManifestConfig, ConnectionProperties, ConnectionTypeEnum
 
 
 @dataclass
@@ -31,11 +31,11 @@ class ConnectionSet:
     def run_sql_query_from_conn_name(self, query: str, conn_name: str, placeholders: dict = {}) -> pl.DataFrame:
         conn = self.get_connection(conn_name)
         try:
-            if isinstance(conn, ConnectionProperties) and (conn.type == ConnectionType.CONNECTORX or conn.type == ConnectionType.ADBC):
+            if isinstance(conn, ConnectionProperties) and (conn.type == ConnectionTypeEnum.CONNECTORX or conn.type == ConnectionTypeEnum.ADBC):
                 if len(placeholders) > 0:
                     raise u.ConfigurationError(f"Connection '{conn_name}' is a ConnectorX or ADBC connection, which does not support placeholders")
                 df = pl.read_database_uri(query, conn.uri, engine=conn.type.value)
-            elif isinstance(conn, ConnectionProperties) and conn.type == ConnectionType.SQLALCHEMY:
+            elif isinstance(conn, ConnectionProperties) and conn.type == ConnectionTypeEnum.SQLALCHEMY:
                 with conn.engine.connect() as connection:
                     df = pl.read_database(query, connection, execute_options={"parameters": placeholders})
             else:
@@ -52,7 +52,7 @@ class ConnectionSet:
             if isinstance(conn, Engine):
                 conn.dispose()
             elif isinstance(conn, ConnectionProperties):
-                if conn.type == ConnectionType.SQLALCHEMY:
+                if conn.type == ConnectionTypeEnum.SQLALCHEMY:
                     conn.engine.dispose()
             elif hasattr(conn, 'close'):
                 conn.close()

squirrels/_constants.py

@@ -33,7 +33,7 @@ SQRL_CONNECTIONS_DEFAULT_NAME_USED = 'SQRL_CONNECTIONS__DEFAULT_NAME_USED'
 SQRL_DUCKDB_VENV_DB_FILE_PATH = 'SQRL_DUCKDB_VENV__DB_FILE_PATH'
 
 # Folder/File names
-PACKAGE_DATA_FOLDER = 'package_data'
+PACKAGE_DATA_FOLDER = '_package_data'
 BASE_PROJECT_FOLDER = 'base_project'
 
 GLOBAL_ENV_FOLDER = '.squirrels'

squirrels/_dashboard_types.py

@@ -0,0 +1,82 @@
+import matplotlib.figure as figure, io, abc, typing
+
+from . import _constants as c
+
+
+class Dashboard(metaclass=abc.ABCMeta):
+    """
+    Abstract parent class for all Dashboard classes.
+    """
+    
+    @property
+    @abc.abstractmethod
+    def _content(self) -> bytes | str:
+        pass
+    
+    @property
+    @abc.abstractmethod
+    def _format(self) -> str:
+        pass
+
+
+class PngDashboard(Dashboard):
+    """
+    Instantiate a Dashboard in PNG format from a matplotlib figure or bytes
+    """
+    
+    def __init__(self, content: figure.Figure | io.BytesIO | bytes) -> None:
+        """
+        Constructor for PngDashboard
+
+        Arguments:
+            content: The content of the dashboard as a matplotlib.figure.Figure or bytes
+        """
+        if isinstance(content, figure.Figure):
+            buffer = io.BytesIO()
+            content.savefig(buffer, format=c.PNG)
+            content = buffer.getvalue()
+        
+        if isinstance(content, io.BytesIO):
+            content = content.getvalue()
+        
+        self.__content = content
+
+    @property
+    def _content(self) -> bytes:
+        return self.__content
+    
+    @property
+    def _format(self) -> typing.Literal['png']:
+        return c.PNG
+    
+    def _repr_png_(self):
+        return self._content
+    
+
+class HtmlDashboard(Dashboard):
+    """
+    Instantiate a Dashboard from an HTML string
+    """
+
+    def __init__(self, content: io.StringIO | str) -> None:
+        """
+        Constructor for HtmlDashboard
+
+        Arguments:
+            content: The content of the dashboard as HTML string
+        """
+        if isinstance(content, io.StringIO):
+            content = content.getvalue()
+        
+        self.__content = content
+
+    @property
+    def _content(self) -> str:
+        return self.__content
+    
+    @property
+    def _format(self) -> typing.Literal['html']:
+        return c.HTML
+    
+    def _repr_html_(self):
+        return self._content

squirrels/_dashboards_io.py

@@ -4,11 +4,11 @@ from dataclasses import dataclass
 from pydantic import BaseModel, Field
 import os, time
 
-from .arguments.run_time_args import DashboardArgs
+from ._arguments._run_time_args import DashboardArgs
 from ._py_module import PyModule
 from ._manifest import AnalyticsOutputConfig
 from ._exceptions import InvalidInputError, ConfigurationError, FileExecutionError
-from . import _constants as c, _utils as u, dashboards as d
+from . import _constants as c, _dashboard_types as d, _utils as u
 
 T = TypeVar('T', bound=d.Dashboard)