From cb8435e2c8bfa41d028f9f67caed964e767fac00 Mon Sep 17 00:00:00 2001 From: Danglewood <85772166+deeleeramone@users.noreply.github.com> Date: Sat, 7 Dec 2024 18:02:22 -0800 Subject: [PATCH] missing docstrings --- .../websockets/openbb_websockets/broadcast.py | 11 ++++++++++- .../websockets/openbb_websockets/helpers.py | 1 - 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/openbb_platform/extensions/websockets/openbb_websockets/broadcast.py b/openbb_platform/extensions/websockets/openbb_websockets/broadcast.py index 707b5400347..3537d8b62fe 100644 --- a/openbb_platform/extensions/websockets/openbb_websockets/broadcast.py +++ b/openbb_platform/extensions/websockets/openbb_websockets/broadcast.py @@ -1,6 +1,7 @@ import asyncio import json import sys +from pathlib import Path from typing import Optional import uvicorn @@ -22,6 +23,7 @@ TABLE_NAME = kwargs.pop("table_name", None) or "records" SLEEP_TIME = kwargs.pop("sleep_time", None) or 0.25 AUTH_TOKEN = kwargs.pop("auth_token", None) + app = FastAPI() @@ -156,7 +158,6 @@ class BroadcastServer: async def stream_results(self): # noqa: PLR0915 """Continuously read the database and send new messages as JSON via WebSocket.""" import sqlite3 # noqa - from pathlib import Path from openbb_core.app.model.abstract.error import OpenBBError file_path = Path(self.results_file).absolute() @@ -232,6 +233,7 @@ class BroadcastServer: connected_clients.remove(client) def start_app(self, host: str = "127.0.0.1", port: int = 6666, **kwargs): + """Start the FastAPI app with Uvicorn.""" uvicorn.run( self._app, host=host, @@ -247,10 +249,12 @@ def create_broadcast_server( auth_token: Optional[str] = None, **kwargs, ): + """Create a new BroadcastServer instance.""" return BroadcastServer(results_file, table_name, sleep_time, auth_token) def main(): + """Main entry point.""" broadcast_server = create_broadcast_server( RESULTS_FILE, TABLE_NAME, @@ -276,4 +280,9 @@ def main(): if __name__ == "__main__": + if not RESULTS_FILE: + raise ValueError("Results file path is required for Broadcast server.") + + if not Path(RESULTS_FILE).absolute().exists(): + raise FileNotFoundError(f"Results file not found: {RESULTS_FILE}") main() diff --git a/openbb_platform/extensions/websockets/openbb_websockets/helpers.py b/openbb_platform/extensions/websockets/openbb_websockets/helpers.py index 9854cdadfb4..093834b8aa0 100644 --- a/openbb_platform/extensions/websockets/openbb_websockets/helpers.py +++ b/openbb_platform/extensions/websockets/openbb_websockets/helpers.py @@ -134,7 +134,6 @@ def parse_kwargs(): import sys args = sys.argv[1:].copy() - sys.stdout.write(f"ARGS: {args}\n") _kwargs: dict = {} for i, arg in enumerate(args): if arg.startswith("url"):