singlestoredb 1.7.0__tar.gz → 1.7.1__tar.gz

{singlestoredb-1.7.0/singlestoredb.egg-info → singlestoredb-1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: singlestoredb
-Version: 1.7.0
+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.7.0 → singlestoredb-1.7.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = singlestoredb
-version = 1.7.0
+version = 1.7.1
 description = Interface to the SingleStoreDB database and workspace management APIs
 long_description = file: README.md
 long_description_content_type = text/markdown

{singlestoredb-1.7.0 → singlestoredb-1.7.1}/singlestoredb/__init__.py

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

{singlestoredb-1.7.0 → singlestoredb-1.7.1}/singlestoredb/apps/_cloud_functions.py

@@ -1,8 +1,10 @@
 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 +19,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,7 +53,7 @@ async def run_function_app(
     def ping() -> str:
         return 'Success!'
 
-    base_path = urllib.parse.urlparse(app_config.url).path
+    base_path = urllib.parse.urlparse(app_config.base_url).path
     app.root_path = base_path
 
     config = uvicorn.Config(
@@ -66,5 +67,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-1.7.1/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-1.7.1/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-1.7.0 → singlestoredb-1.7.1}/singlestoredb/apps/_dashboards.py

@@ -3,16 +3,18 @@ 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
 
 
-def run_dashboard_app(
+async def run_dashboard_app(
     figure: 'Figure',
     debug: bool = False,
     kill_existing_app_server: bool = True,
-) -> None:
+) -> ConnectionInfo:
     try:
         import dash
     except ImportError:
@@ -31,7 +33,7 @@ def run_dashboard_app(
     if kill_existing_app_server:
         kill_process_by_port(app_config.listen_port)
 
-    base_path = urllib.parse.urlparse(app_config.url).path
+    base_path = urllib.parse.urlparse(app_config.base_url).path
 
     app = dash.Dash(requests_pathname_prefix=base_path)
     app.layout = dash.html.Div(
@@ -40,12 +42,14 @@ def run_dashboard_app(
         ],
     )
 
-    app.run(
-        host='0.0.0.0',
-        debug=debug,
-        port=str(app_config.listen_port),
-        jupyter_mode='external',
-    )
+    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-1.7.1/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 → singlestoredb-1.7.1}/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.7.0 → singlestoredb-1.7.1/singlestoredb.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: singlestoredb
-Version: 1.7.0
+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.7.0 → singlestoredb-1.7.1}/singlestoredb.egg-info/SOURCES.txt

@@ -23,8 +23,10 @@ singlestoredb/alchemy/__init__.py
 singlestoredb/apps/__init__.py
 singlestoredb/apps/_cloud_functions.py
 singlestoredb/apps/_config.py
+singlestoredb/apps/_connection_info.py
 singlestoredb/apps/_dashboards.py
 singlestoredb/apps/_process.py
+singlestoredb/apps/_stdout_supress.py
 singlestoredb/apps/_uvicorn_util.py
 singlestoredb/functions/__init__.py
 singlestoredb/functions/decorator.py

singlestoredb-1.7.0/singlestoredb/apps/_config.py

@@ -1,33 +0,0 @@
-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,
-        )