singlestoredb 1.7.0__py3-none-any.whl → 1.7.2__py3-none-any.whl

singlestoredb/__init__.py

@@ -13,7 +13,7 @@ Examples
 
 """
 
-__version__ = '1.7.0'
+__version__ = '1.7.2'
 
 from typing import Any
 

singlestoredb/apps/_cloud_functions.py

@@ -1,8 +1,9 @@
 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:
@@ -17,8 +18,7 @@ async def run_function_app(
     app: 'FastAPI',
     log_level: str = 'error',
     kill_existing_app_server: bool = True,
-) -> None:
-
+) -> ConnectionInfo:
     global _running_server
     from ._uvicorn_util import AwaitableUvicornServer
 
@@ -52,8 +52,7 @@ async def run_function_app(
     def ping() -> str:
         return 'Success!'
 
-    base_path = urllib.parse.urlparse(app_config.url).path
-    app.root_path = base_path
+    app.root_path = app_config.base_path
 
     config = uvicorn.Config(
         app,
@@ -66,5 +65,26 @@ async def run_function_app(
     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:
-        print(f'Cloud function available at {app_config.url}')
+        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

@@ -1,33 +1,66 @@
 import os
 from dataclasses import dataclass
+from typing import Optional
 
 
 @dataclass
 class AppConfig:
     listen_port: int
-    url: str
+    base_url: str
+    base_path: str
+    app_token: Optional[str]
+    user_token: Optional[str]
     running_interactively: bool
+    is_gateway_enabled: 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:
+    @staticmethod
+    def _read_variable(name: str) -> str:
+        value = os.environ.get(name)
+        if value is None:
             raise RuntimeError(
-                'Missing SINGLESTOREDB_APP_URL environment variable. '
+                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')
+        base_path = cls._read_variable('SINGLESTOREDB_APP_BASE_PATH')
 
         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),
-            url=url,
+            base_url=base_url,
+            base_path=base_path,
+            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

@@ -1,51 +1,47 @@
 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
+    from dash import Dash
 
 
-def run_dashboard_app(
-    figure: 'Figure',
+async def run_dashboard_app(
+    app: 'Dash',
     debug: bool = False,
     kill_existing_app_server: bool = True,
-) -> None:
+) -> ConnectionInfo:
     try:
-        import dash
+        from dash 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')
+    if not isinstance(app, Dash):
+        raise TypeError('app is not an instance of Dash App')
 
     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.requests_pathname_prefix is None or \
+            app.config.requests_pathname_prefix != app_config.base_path:
+        raise RuntimeError('''
+requests_pathname_prefix of the Dash App is invalid. Please set
+requests_pathname_prefix=os.environ['SINGLESTOREDB_APP_BASE_PATH']
+while initializing the Dash App and retry''')
+
+    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.url}')
+        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/_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-1.7.0.dist-info → singlestoredb-1.7.2.dist-info}/METADATA

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

{singlestoredb-1.7.0.dist-info → singlestoredb-1.7.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-singlestoredb/__init__.py,sha256=dYAymV6mtmpkfZMMdLoAUjKcpN7Lh7jEOdNeFM3I7jM,1634
+singlestoredb/__init__.py,sha256=UjufrohnvC56tM8JigZbe1K0NDetQIji_savOS-HmXc,1634
 singlestoredb/auth.py,sha256=u8D9tpKzrqa4ssaHjyZnGDX1q8XBpGtuoOkTkSv7B28,7599
 singlestoredb/config.py,sha256=NtONv4Etpraoy1nenHqRAS08xHJZmho00J95uDjLxQM,12290
 singlestoredb/connection.py,sha256=x5lINBa9kB_GoEEeL2uUZi9G8pNwKuFtA1uqJirR6HI,45352
@@ -10,10 +10,12 @@ singlestoredb/ai/__init__.py,sha256=7Pubobzx5OlyepNo5DOOxWev1DUW9WFc9P6Qver2xpY,
 singlestoredb/ai/embeddings.py,sha256=3jghE4WMf7vy8RobhrMOLvMLnDNGbkPCF48B3fGM38U,746
 singlestoredb/alchemy/__init__.py,sha256=dXRThusYrs_9GjrhPOw0-vw94in_T8yY9jE7SGCqiQk,2523
 singlestoredb/apps/__init__.py,sha256=uuEH2WZ1ROpmkMBBdz1tSkQSdYR9blXXU2nn7E5P4qQ,118
-singlestoredb/apps/_cloud_functions.py,sha256=qIykvR7TuTXvrNMOi25ejklQx79CpScC3tV49cejJR0,2036
-singlestoredb/apps/_config.py,sha256=kCkuEnW8rXvGvG48o4QY35PSiIm4AyltqJn_bNoHmDI,1056
-singlestoredb/apps/_dashboards.py,sha256=dSyc2NO8ocni6HC_ooruokiJgzEYUBLFg4ybS1FD9mM,1272
+singlestoredb/apps/_cloud_functions.py,sha256=NJJu0uJsK9TjY3yZjgftpFPR-ga-FrOyaiDD4jWFCtE,2704
+singlestoredb/apps/_config.py,sha256=w21kH0jMJ0_cP_VgAxHhKiLW5Iyrr7xzUIxRmfe_fqs,2118
+singlestoredb/apps/_connection_info.py,sha256=gQPYzJrBQUEH76zVTkxJ7FAypNoN2T7GYHVOSgJ7Q8Q,175
+singlestoredb/apps/_dashboards.py,sha256=_03fI-GJannamA5lxLvIoC6Mim-H1jTRuI8-dw_P--k,1474
 singlestoredb/apps/_process.py,sha256=G37fk6bzIxzhfEqp2aJBk3JCij-T2HFtTd078k5Xq9I,944
+singlestoredb/apps/_stdout_supress.py,sha256=8s9zMIIRPpeu44yluJFc_0VueAxZDmr9QVGT6TGiFeY,659
 singlestoredb/apps/_uvicorn_util.py,sha256=rEK4nEmq5hbpRgsmK16UVlxe2DyQSq7C5w5WZSp0kX8,962
 singlestoredb/functions/__init__.py,sha256=WL1LqgMTdnGOse3tQqmD-HH8TdfCPS89GNO7hO0v_aw,41
 singlestoredb/functions/decorator.py,sha256=H12MUeBw8VOppx6esntaR43ukeIffbnAr716CBpYJ4g,5193
@@ -122,9 +124,9 @@ singlestoredb/utils/events.py,sha256=9IB84T3pKQjs7aaoSSJCw7soNngnhoTDWIC52M51R9Y
 singlestoredb/utils/mogrify.py,sha256=-a56IF70U6CkfadeaZgfjRSVsAD3PuqRrzPpjZlgbwY,4050
 singlestoredb/utils/results.py,sha256=bJtaUaDiFq26IsPAKZ2FHGB7csMn94EAxLKrP4HaEEA,15277
 singlestoredb/utils/xdict.py,sha256=S9HKgrPrnu_6b7iOwa2KrW8CmU1Uqx0BWdEyogFzWbE,12896
-singlestoredb-1.7.0.dist-info/LICENSE,sha256=Mlq78idURT-9G026aMYswwwnnrLcgzTLuXeAs5hjDLM,11341
-singlestoredb-1.7.0.dist-info/METADATA,sha256=hut54uSeTSVJL5_3nTXZ5RaHNedRj7C1UU4YM0uOLG8,5557
-singlestoredb-1.7.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-singlestoredb-1.7.0.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
-singlestoredb-1.7.0.dist-info/top_level.txt,sha256=eet8bVPNRqiGeY0PrO5ERH2UpamwlrKHEQCffz4dOh8,14
-singlestoredb-1.7.0.dist-info/RECORD,,
+singlestoredb-1.7.2.dist-info/LICENSE,sha256=Mlq78idURT-9G026aMYswwwnnrLcgzTLuXeAs5hjDLM,11341
+singlestoredb-1.7.2.dist-info/METADATA,sha256=k_cNa90181RAA4XGHdWKHlQdl-9A-shPl86g7d3dJV0,5557
+singlestoredb-1.7.2.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+singlestoredb-1.7.2.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
+singlestoredb-1.7.2.dist-info/top_level.txt,sha256=eet8bVPNRqiGeY0PrO5ERH2UpamwlrKHEQCffz4dOh8,14
+singlestoredb-1.7.2.dist-info/RECORD,,