singlestoredb 1.6.3__cp38-abi3-macosx_10_9_universal2.whl → 1.7.1__cp38-abi3-macosx_10_9_universal2.whl

singlestoredb/__init__.py

@@ -13,7 +13,7 @@ Examples
 
 """
 
-__version__ = '1.6.3'
+__version__ = '1.7.1'
 
 from typing import Any
 

singlestoredb/apps/__init__.py

@@ -0,0 +1,2 @@
+from ._cloud_functions import run_function_app  # noqa: F401
+from ._dashboards import run_dashboard_app  # noqa: F401

singlestoredb/apps/_cloud_functions.py

@@ -0,0 +1,92 @@
+import asyncio
+import textwrap
+import typing
+import urllib.parse
+
+from ._config import AppConfig
+from ._connection_info import ConnectionInfo
+from ._process import kill_process_by_port
+
+if typing.TYPE_CHECKING:
+    from fastapi import FastAPI
+    from ._uvicorn_util import AwaitableUvicornServer
+
+# Keep track of currently running server
+_running_server: 'typing.Optional[AwaitableUvicornServer]' = None
+
+
+async def run_function_app(
+    app: 'FastAPI',
+    log_level: str = 'error',
+    kill_existing_app_server: bool = True,
+) -> ConnectionInfo:
+    global _running_server
+    from ._uvicorn_util import AwaitableUvicornServer
+
+    try:
+        import uvicorn
+    except ImportError:
+        raise ImportError('package uvicorn is required to run cloud functions')
+    try:
+        import fastapi
+    except ImportError:
+        raise ImportError('package fastapi is required to run cloud functions')
+
+    if not isinstance(app, fastapi.FastAPI):
+        raise TypeError('app is not an instance of FastAPI')
+
+    app_config = AppConfig.from_env()
+
+    if kill_existing_app_server:
+        # Shutdown the server gracefully if it was started by us.
+        # Since the uvicorn server doesn't start a new subprocess
+        # killing the process would result in kernel dying.
+        if _running_server is not None:
+            await _running_server.shutdown()
+            _running_server = None
+
+        # Kill if any other process is occupying the port
+        kill_process_by_port(app_config.listen_port)
+
+    # Add `GET /` route, used for liveness check
+    @app.get('/')
+    def ping() -> str:
+        return 'Success!'
+
+    base_path = urllib.parse.urlparse(app_config.base_url).path
+    app.root_path = base_path
+
+    config = uvicorn.Config(
+        app,
+        host='0.0.0.0',
+        port=app_config.listen_port,
+        log_level=log_level,
+    )
+    _running_server = AwaitableUvicornServer(config)
+
+    asyncio.create_task(_running_server.serve())
+    await _running_server.wait_for_startup()
+
+    connection_info = ConnectionInfo(app_config.base_url, app_config.token)
+
+    if app_config.running_interactively:
+        if app_config.is_gateway_enabled:
+            print(
+                'Cloud function available at '
+                f'{app_config.base_url}docs?authToken={app_config.token}',
+            )
+        else:
+            curl_header = f'-H "Authorization: Bearer {app_config.token}"'
+            curl_example = f'curl "{app_config.base_url}" {curl_header}'
+            print(
+                textwrap.dedent(f"""
+                  Cloud function available at {app_config.base_url}
+
+                  Auth Token: {app_config.token}
+
+                  Curl example: {curl_example}
+
+              """).strip(),
+            )
+
+    return connection_info

singlestoredb/apps/_config.py

@@ -0,0 +1,63 @@
+import os
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class AppConfig:
+    listen_port: int
+    base_url: str
+    app_token: Optional[str]
+    user_token: Optional[str]
+    running_interactively: bool
+    is_gateway_enabled: bool
+
+    @staticmethod
+    def _read_variable(name: str) -> str:
+        value = os.environ.get(name)
+        if value is None:
+            raise RuntimeError(
+                f'Missing {name} environment variable. '
+                'Is the code running outside SingleStoreDB notebook environment?',
+            )
+        return value
+
+    @classmethod
+    def from_env(cls) -> 'AppConfig':
+        port = cls._read_variable('SINGLESTOREDB_APP_LISTEN_PORT')
+        base_url = cls._read_variable('SINGLESTOREDB_APP_BASE_URL')
+
+        workload_type = os.environ.get('SINGLESTOREDB_WORKLOAD_TYPE')
+        running_interactively = workload_type == 'InteractiveNotebook'
+
+        is_gateway_enabled = 'SINGLESTOREDB_NOVA_GATEWAY_ENDPOINT' in os.environ
+
+        app_token = os.environ.get('SINGLESTOREDB_APP_TOKEN')
+        user_token = os.environ.get('SINGLESTOREDB_USER_TOKEN')
+
+        # Make sure the required variables are present
+        # and present useful error message if not
+        if running_interactively:
+            if is_gateway_enabled:
+                app_token = cls._read_variable('SINGLESTOREDB_APP_TOKEN')
+            else:
+                user_token = cls._read_variable('SINGLESTOREDB_USER_TOKEN')
+
+        return cls(
+            listen_port=int(port),
+            base_url=base_url,
+            app_token=app_token,
+            user_token=user_token,
+            running_interactively=running_interactively,
+            is_gateway_enabled=is_gateway_enabled,
+        )
+
+    @property
+    def token(self) -> Optional[str]:
+        """
+        Returns None if running non-interactively
+        """
+        if self.is_gateway_enabled:
+            return self.app_token
+        else:
+            return self.user_token

singlestoredb/apps/_connection_info.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class ConnectionInfo:
+    url: str
+
+    # Only present in interactive mode
+    token: Optional[str]

singlestoredb/apps/_dashboards.py

@@ -0,0 +1,55 @@
+import typing
+import urllib.parse
+
+from ._config import AppConfig
+from ._process import kill_process_by_port
+from ._stdout_supress import StdoutSuppressor
+from singlestoredb.apps._connection_info import ConnectionInfo
+
+if typing.TYPE_CHECKING:
+    from plotly.graph_objs import Figure
+
+
+async def run_dashboard_app(
+    figure: 'Figure',
+    debug: bool = False,
+    kill_existing_app_server: bool = True,
+) -> ConnectionInfo:
+    try:
+        import dash
+    except ImportError:
+        raise ImportError('package dash is required to run dashboards')
+
+    try:
+        from plotly.graph_objs import Figure
+    except ImportError:
+        raise ImportError('package dash is required to run dashboards')
+
+    if not isinstance(figure, Figure):
+        raise TypeError('figure is not an instance of plotly Figure')
+
+    app_config = AppConfig.from_env()
+
+    if kill_existing_app_server:
+        kill_process_by_port(app_config.listen_port)
+
+    base_path = urllib.parse.urlparse(app_config.base_url).path
+
+    app = dash.Dash(requests_pathname_prefix=base_path)
+    app.layout = dash.html.Div(
+        [
+            dash.dcc.Graph(figure=figure),
+        ],
+    )
+
+    with StdoutSuppressor():
+        app.run(
+            host='0.0.0.0',
+            debug=debug,
+            port=str(app_config.listen_port),
+            jupyter_mode='external',
+        )
+
+    if app_config.running_interactively:
+        print(f'Dash app available at {app_config.base_url}?authToken={app_config.token}')
+    return ConnectionInfo(app_config.base_url, app_config.token)

singlestoredb/apps/_process.py

@@ -0,0 +1,32 @@
+import os
+import signal
+import typing
+if typing.TYPE_CHECKING:
+    from psutil import Process
+
+
+def kill_process_by_port(port: int) -> None:
+    existing_process = _find_process_by_port(port)
+    kernel_pid = os.getpid()
+    # Make sure we are not killing current kernel
+    if existing_process is not None and kernel_pid != existing_process.pid:
+        print(f'Killing process {existing_process.pid} which is using port {port}')
+        os.kill(existing_process.pid, signal.SIGKILL)
+
+
+def _find_process_by_port(port: int) -> 'Process | None':
+    try:
+        import psutil
+    except ImportError:
+        raise ImportError('package psutil is required')
+
+    for proc in psutil.process_iter(['pid']):
+        try:
+            connections = proc.connections()
+            for conn in connections:
+                if conn.laddr.port == port:
+                    return proc
+        except psutil.AccessDenied:
+            pass
+
+    return None

singlestoredb/apps/_stdout_supress.py

@@ -0,0 +1,30 @@
+import io
+import sys
+from typing import Optional
+
+
+class StdoutSuppressor:
+    """
+    Supresses the stdout for code executed within the context.
+    This should not be used for asynchronous or threaded executions.
+
+    ```py
+    with Supressor():
+        print("This won't be printed")
+    ```
+
+    """
+
+    def __enter__(self) -> None:
+        self.stdout = sys.stdout
+        self.buffer = io.StringIO()
+        sys.stdout = self.buffer
+
+    def __exit__(
+        self,
+        exc_type: Optional[object],
+        exc_value: Optional[Exception],
+        exc_traceback: Optional[str],
+    ) -> None:
+        del self.buffer
+        sys.stdout = self.stdout

singlestoredb/apps/_uvicorn_util.py

@@ -0,0 +1,32 @@
+import asyncio
+import socket
+from typing import List
+from typing import Optional
+try:
+    import uvicorn
+except ImportError:
+    raise ImportError('package uvicorn is required')
+
+
+class AwaitableUvicornServer(uvicorn.Server):
+    """
+    Adds `wait_for_startup` method.
+    The function (asynchronously) blocks until the server
+    starts listening or throws an error.
+    """
+
+    def __init__(self, config: 'uvicorn.Config') -> None:
+        super().__init__(config)
+        self._startup_future = asyncio.get_event_loop().create_future()
+
+    async def startup(self, sockets: Optional[List[socket.socket]] = None) -> None:
+        try:
+            result = await super().startup(sockets)
+            self._startup_future.set_result(True)
+            return result
+        except Exception as error:
+            self._startup_future.set_exception(error)
+            raise error
+
+    async def wait_for_startup(self) -> None:
+        await self._startup_future

singlestoredb/tests/test_connection.py

@@ -1432,6 +1432,8 @@ class TestConnection(unittest.TestCase):
         conn.close()
 
     def test_alltypes_polars(self):
+        self.skipTest('Polars API needs to be fixed')
+
         if self.conn.driver in ['http', 'https']:
             self.skipTest('Data API does not surface unsigned int information')
 
@@ -1574,6 +1576,8 @@ class TestConnection(unittest.TestCase):
         conn.close()
 
     def test_alltypes_no_nulls_polars(self):
+        self.skipTest('Polars API needs to be fixed')
+
         if self.conn.driver in ['http', 'https']:
             self.skipTest('Data API does not surface unsigned int information')
 

{singlestoredb-1.6.3.dist-info → singlestoredb-1.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: singlestoredb
-Version: 1.6.3
+Version: 1.7.1
 Summary: Interface to the SingleStoreDB database and workspace management APIs
 Home-page: https://github.com/singlestore-labs/singlestoredb-python
 Author: SingleStore

{singlestoredb-1.6.3.dist-info → singlestoredb-1.7.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
-_singlestoredb_accel.abi3.so,sha256=QpW6c4u72erct3c3U6H5YvA-Ze7aYdT8DW9WkWsBMdE,206633
-singlestoredb-1.6.3.dist-info/RECORD,,
-singlestoredb-1.6.3.dist-info/LICENSE,sha256=Mlq78idURT-9G026aMYswwwnnrLcgzTLuXeAs5hjDLM,11341
-singlestoredb-1.6.3.dist-info/WHEEL,sha256=_VEguvlLpUd-c8RbFMA4yMIVNMBv2LhpxYLCEQ-Bogk,113
-singlestoredb-1.6.3.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
-singlestoredb-1.6.3.dist-info/top_level.txt,sha256=SDtemIXf-Kp-_F2f_S6x0db33cHGOILdAEsIQZe2LZc,35
-singlestoredb-1.6.3.dist-info/METADATA,sha256=320pbLCF4vRldpx3jPMtrx4l6N8b6A1FLcneyGdxufA,5570
+_singlestoredb_accel.abi3.so,sha256=OqPy-UWGebajD1O4XJtNQFeGxAIFeEs8cWG2uO5C9NU,206633
+singlestoredb-1.7.1.dist-info/RECORD,,
+singlestoredb-1.7.1.dist-info/LICENSE,sha256=Mlq78idURT-9G026aMYswwwnnrLcgzTLuXeAs5hjDLM,11341
+singlestoredb-1.7.1.dist-info/WHEEL,sha256=_VEguvlLpUd-c8RbFMA4yMIVNMBv2LhpxYLCEQ-Bogk,113
+singlestoredb-1.7.1.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
+singlestoredb-1.7.1.dist-info/top_level.txt,sha256=SDtemIXf-Kp-_F2f_S6x0db33cHGOILdAEsIQZe2LZc,35
+singlestoredb-1.7.1.dist-info/METADATA,sha256=Osc4yfUZBS_Ogzp09d0ZuaShEYrjM0Ps7yIBeh785JY,5570
 singlestoredb/auth.py,sha256=u8D9tpKzrqa4ssaHjyZnGDX1q8XBpGtuoOkTkSv7B28,7599
 singlestoredb/config.py,sha256=NtONv4Etpraoy1nenHqRAS08xHJZmho00J95uDjLxQM,12290
-singlestoredb/__init__.py,sha256=sef5VjPuehPFp3gVst6kSbrD0vAleAqwW0V7fClxr9Q,1634
+singlestoredb/__init__.py,sha256=MbDErI01usfGrRDuim_0q51kppgXnuix5LIRnqnkQAk,1634
 singlestoredb/types.py,sha256=FIqO1A7e0Gkk7ITmIysBy-P5S--ItbMSlYvblzqGS30,9969
 singlestoredb/connection.py,sha256=x5lINBa9kB_GoEEeL2uUZi9G8pNwKuFtA1uqJirR6HI,45352
 singlestoredb/pytest.py,sha256=OyF3BO9mgxenifYhOihnzGk8WzCJ_zN5_mxe8XyFPOc,9074
@@ -30,7 +30,7 @@ singlestoredb/tests/test_fusion.py,sha256=W79zv1XcPiiYIYAGtUxLadAMwcJlo2QMmGgU_6
 singlestoredb/tests/test_plugin.py,sha256=qpO9wmWc62VaijN1sJ97YSYIX7I7Y5C6sY-WzwrutDQ,812
 singlestoredb/tests/test_basics.py,sha256=1__lEF7FmQF4_pFi5R53TtJidtQznmQ592Ci6aDVgrc,46368
 singlestoredb/tests/test_ext_func.py,sha256=OWd-CJ1Owhx72nikSWWEF2EQFCJk7vEXZM2Oy9EbYQo,37357
-singlestoredb/tests/test_connection.py,sha256=fvn-kPdeIMI9RGNz0dNk5ZmTCep1amwWQDHYfPdqO60,119699
+singlestoredb/tests/test_connection.py,sha256=8F3Q0Q9dJ0Ywa-gb6Z3yH_nY4OECY83TKr9OVM3g17o,119809
 singlestoredb/tests/test_ext_func_data.py,sha256=yTADD93nPxX6_rZXXLZaOWEI_yPvYyir9psn5PK9ctU,47695
 singlestoredb/tests/test_exceptions.py,sha256=tfr_8X2w1UmG4nkSBzWGB0C7ehrf1GAVgj6_ODaG-TM,1131
 singlestoredb/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -122,4 +122,12 @@ singlestoredb/functions/ext/rowdat_1.py,sha256=JgKRsVSQYczFD6cmo2xLilbNPYpyLL2tP
 singlestoredb/notebook/__init__.py,sha256=v0j1E3MFAtaC8wTrR-F7XY0nytUvQ4XpYhVXddv2xA0,533
 singlestoredb/notebook/_objects.py,sha256=MkB1eowEq5SQXFHY00xAKAyyeLqHu_uaZiA20BCJPaE,8043
 singlestoredb/notebook/_portal.py,sha256=DLerIEQmAUymtYcx8RBeuYJ4pJSy_xl1K6t1Oc-eTf8,9698
+singlestoredb/apps/_dashboards.py,sha256=ozee2Tnq8YNdvnxOzltVtukEOckFqp_1Xr8p3idCR9A,1554
+singlestoredb/apps/__init__.py,sha256=uuEH2WZ1ROpmkMBBdz1tSkQSdYR9blXXU2nn7E5P4qQ,118
+singlestoredb/apps/_cloud_functions.py,sha256=wlZH9M-rMTMltpB6M-Iv3dKyT9giR8oXoa6bAOizPhY,2777
+singlestoredb/apps/_uvicorn_util.py,sha256=rEK4nEmq5hbpRgsmK16UVlxe2DyQSq7C5w5WZSp0kX8,962
+singlestoredb/apps/_process.py,sha256=G37fk6bzIxzhfEqp2aJBk3JCij-T2HFtTd078k5Xq9I,944
+singlestoredb/apps/_stdout_supress.py,sha256=8s9zMIIRPpeu44yluJFc_0VueAxZDmr9QVGT6TGiFeY,659
+singlestoredb/apps/_config.py,sha256=0rRp6iqjnhSlBQRWO4wFpTxM-sOno9kVOz21NAG0wqA,1996
+singlestoredb/apps/_connection_info.py,sha256=gQPYzJrBQUEH76zVTkxJ7FAypNoN2T7GYHVOSgJ7Q8Q,175
 singlestoredb/alchemy/__init__.py,sha256=dXRThusYrs_9GjrhPOw0-vw94in_T8yY9jE7SGCqiQk,2523