singlestoredb 1.6.3__cp38-abi3-win_amd64.whl → 1.7.0__cp38-abi3-win_amd64.whl

singlestoredb/__init__.py

@@ -13,7 +13,7 @@ Examples
 
 """
 
-__version__ = '1.6.3'
+__version__ = '1.7.0'
 
 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,70 @@
+import asyncio
+import typing
+import urllib.parse
+
+from ._config import AppConfig
+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,
+) -> None:
+
+    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.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()
+
+    if app_config.running_interactively:
+        print(f'Cloud function available at {app_config.url}')

singlestoredb/apps/_config.py

@@ -0,0 +1,33 @@
+import os
+from dataclasses import dataclass
+
+
+@dataclass
+class AppConfig:
+    listen_port: int
+    url: str
+    running_interactively: bool
+
+    @classmethod
+    def from_env(cls) -> 'AppConfig':
+        port = os.environ.get('SINGLESTOREDB_APP_LISTEN_PORT')
+        if port is None:
+            raise RuntimeError(
+                'Missing SINGLESTOREDB_APP_LISTEN_PORT environment variable. '
+                'Is the code running outside SingleStoreDB notebook environment?',
+            )
+        url = os.environ.get('SINGLESTOREDB_APP_URL')
+        if url is None:
+            raise RuntimeError(
+                'Missing SINGLESTOREDB_APP_URL environment variable. '
+                'Is the code running outside SingleStoreDB notebook environment?',
+            )
+
+        workload_type = os.environ.get('SINGLESTOREDB_WORKLOAD_TYPE')
+        running_interactively = workload_type == 'InteractiveNotebook'
+
+        return cls(
+            listen_port=int(port),
+            url=url,
+            running_interactively=running_interactively,
+        )

singlestoredb/apps/_dashboards.py

@@ -0,0 +1,51 @@
+import typing
+import urllib.parse
+
+from ._config import AppConfig
+from ._process import kill_process_by_port
+
+if typing.TYPE_CHECKING:
+    from plotly.graph_objs import Figure
+
+
+def run_dashboard_app(
+    figure: 'Figure',
+    debug: bool = False,
+    kill_existing_app_server: bool = True,
+) -> None:
+    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.url).path
+
+    app = dash.Dash(requests_pathname_prefix=base_path)
+    app.layout = dash.html.Div(
+        [
+            dash.dcc.Graph(figure=figure),
+        ],
+    )
+
+    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.url}')

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/_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-1.6.3.dist-info → singlestoredb-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: singlestoredb
-Version: 1.6.3
+Version: 1.7.0
 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.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-_singlestoredb_accel.pyd,sha256=Uxxes6GSjUiNKzBfXbtLHoyCFoakIZdOHcHvbv8bstQ,59392
-singlestoredb/__init__.py,sha256=SpL4-XLoAIa7QepM8vcdktkpliC5inG2FiqFYdZ181o,1697
+_singlestoredb_accel.pyd,sha256=gJJyyabIixf5VSFu-TZUyDH7e81IWGWM2AM5_XWlvaY,59392
+singlestoredb/__init__.py,sha256=QfF5_hgd3Qij5ssWBZesWxdych7o-gKPfWx4G1uR-XM,1697
 singlestoredb/auth.py,sha256=RmYiH0Wlc2RXc4pTlRMysxtBI445ggCIwojWKC_eDLE,7844
 singlestoredb/config.py,sha256=LlrwKor_23uA9u7jWBYb-IaOKs30CjWIM7o9xCXEPcc,12721
 singlestoredb/connection.py,sha256=QC5YQemwJOhdW_-ZBFpNLE15xFxwI1fB2LuvE1hNi9k,46812
@@ -10,6 +10,12 @@ singlestoredb/types.py,sha256=Lv0BEQl6aSZBiAe0OSI07FEJhcHZ9HX45iT9NU_mxHQ,10334
 singlestoredb/ai/__init__.py,sha256=nT048t90xqjaNhz7KJ10KfSVW4RcZRoujyC6po6Nmb8,61
 singlestoredb/ai/embeddings.py,sha256=KVvQY3viyYWXDBobFpj0xqiGRijt36zcHHlPNAfFAxA,770
 singlestoredb/alchemy/__init__.py,sha256=bUmCl1xUn2v36RMbXLIrvgKzZSqx71mp1ReUw9JeVA8,2613
+singlestoredb/apps/__init__.py,sha256=IKQrPKb1d_LQvmr7jXQvgPRrB5Ja_1kGAXwYvdjp6ok,120
+singlestoredb/apps/_cloud_functions.py,sha256=v8PEBz8MXryarE0nfqjwwnZiAO1S659WeITXGjJRcC4,2106
+singlestoredb/apps/_config.py,sha256=DzWlFdW0_wANnE5XddLQeUv8y_zRUvw8KNz7B4l9KnU,1089
+singlestoredb/apps/_dashboards.py,sha256=FOEPjxpiQL9vBaMQBlTfpmA0b4a-cadSdTFrfjdIcY4,1323
+singlestoredb/apps/_process.py,sha256=eMiBO4piaRX1S6zdnMx0X0E4J7E1XrXndnVW0GRYq1Y,976
+singlestoredb/apps/_uvicorn_util.py,sha256=Petkmq5keBPfXZsHBrnZfY3O2rUHvb3Cw6o-BRz5MP0,994
 singlestoredb/functions/__init__.py,sha256=EVxqWOCcXiIX4Yj7rljAYBBoVbTvm2KSuKSkMBDnEeU,42
 singlestoredb/functions/decorator.py,sha256=M103c1JAZfyGFQAU4uJ_J8XGGH3InhcfrNUCoEORNFQ,5335
 singlestoredb/functions/dtypes.py,sha256=5IwMSaSzxtSowxXrm5hZXW1lpNm6QILxiU4mAUEkBO0,32854
@@ -117,9 +123,9 @@ singlestoredb/utils/events.py,sha256=rC9cHAetua_E1f-EiFkFM-gJzQSQIH5Uk-4sspC3KjI
 singlestoredb/utils/mogrify.py,sha256=gCcn99-vgsGVjTUV7RHJ6hH4vCNrsGB_Xo4z8kiSPDQ,4201
 singlestoredb/utils/results.py,sha256=wR70LhCqlobniZf52r67zYLBOKjWHQm68NAskdRQND8,15862
 singlestoredb/utils/xdict.py,sha256=-wi1lSPTnY99fhVMBhPKJ8cCsQhNG4GMUfkEBDKYgCw,13321
-singlestoredb-1.6.3.dist-info/LICENSE,sha256=Bojenzui8aPNjlF3w4ojguDP7sTf8vFV_9Gc2UAG1sg,11542
-singlestoredb-1.6.3.dist-info/METADATA,sha256=vTNnIJWmEAPO7KExTeaoD9Xp2h8-_BNHUUhDq2lZU-U,5710
-singlestoredb-1.6.3.dist-info/WHEEL,sha256=UyMHzmWA0xVqVPKfTiLs2eN3OWWZUl-kQemNbpIqlKo,100
-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/RECORD,,
+singlestoredb-1.7.0.dist-info/LICENSE,sha256=Bojenzui8aPNjlF3w4ojguDP7sTf8vFV_9Gc2UAG1sg,11542
+singlestoredb-1.7.0.dist-info/METADATA,sha256=dx6R3uQafE_V3NoNKsT5mJCqTo1jrF6NdTdBqZ0rgY4,5710
+singlestoredb-1.7.0.dist-info/WHEEL,sha256=UyMHzmWA0xVqVPKfTiLs2eN3OWWZUl-kQemNbpIqlKo,100
+singlestoredb-1.7.0.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
+singlestoredb-1.7.0.dist-info/top_level.txt,sha256=SDtemIXf-Kp-_F2f_S6x0db33cHGOILdAEsIQZe2LZc,35
+singlestoredb-1.7.0.dist-info/RECORD,,