Autogenerated type safety parameterisation of all methods

providers/spot/websocket_spot_provider.py

@@ -1,11 +1,15 @@
+from __future__ import annotations
+
 import logging
 from datetime import datetime
 from threading import Event, Thread
+from typing import Any
 
 import pytz
-from websocket import create_connection
+from websocket import WebSocket, create_connection
 
 from core.constants import HTTP_HEADERS
+from data.spot import Spot
 from providers.spot.spot_provider import SpotProvider
 
 logger = logging.getLogger(__name__)
@@ -14,22 +18,22 @@ logger = logging.getLogger(__name__)
 class WebsocketSpotProvider(SpotProvider):
     """Spot provider using websockets."""
 
-    def __init__(self, name, provider_config, url):
+    def __init__(self, name: str, provider_config: dict[str, Any], url: str) -> None:
         super().__init__(name, provider_config)
-        self._url = url
-        self._ws = None
-        self._thread = None
-        self._stop_event = Event()
-        self._last_event_id = None
+        self._url: str = url
+        self._ws: WebSocket | None = None
+        self._thread: Thread | None = None
+        self._stop_event: Event = Event()
+        self._last_event_id: str | None = None
 
-    def start(self):
+    def start(self) -> None:
         logger.info(f"Set up websocket connection to {self.name} spot API.")
         self._stop_event.clear()
         self._thread = Thread(target=self._run, name=f"WebsocketSpotProvider-{self.name}")
         self._thread.daemon = True
         self._thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         self._stop_event.set()
         if self._ws:
             self._ws.close()
@@ -38,13 +42,13 @@ class WebsocketSpotProvider(SpotProvider):
             if self._thread.is_alive():
                 logger.warning(f"{self.name} websocket worker thread did not exit on time and will be killed.")
 
-    def _on_open(self):
+    def _on_open(self) -> None:
         self.status = "Waiting for Data"
 
-    def _on_error(self):
+    def _on_error(self) -> None:
         self.status = "Connecting"
 
-    def _run(self):
+    def _run(self) -> None:
         while not self._stop_event.is_set():
             try:
                 logger.debug(f"Connecting to {self.name} spot API...")
@@ -86,7 +90,7 @@ class WebsocketSpotProvider(SpotProvider):
             if not self._stop_event.is_set():
                 self._stop_event.wait(timeout=5)  # Wait before trying to reconnect
 
-    def _ws_message_to_spot(self, b):
+    def _ws_message_to_spot(self, b: str | bytes) -> Spot | None:
         """Convert a WS message received from the API into a spot. The exact message data (in bytes) is provided here so the
         subclass implementations can handle the message as string, JSON, XML, whatever the API actually provides."""