Autogenerated type safety parameterisation of all methods

providers/alert/http_alert_provider.py

@@ -1,12 +1,16 @@
+from __future__ import annotations
+
 import logging
 from datetime import datetime
 from threading import Event, Thread
+from typing import Any
 
 import pytz
 import requests
 from requests.exceptions import ConnectionError, ConnectTimeout, JSONDecodeError, ReadTimeout
 
 from core.constants import HTTP_HEADERS
+from data.alert import Alert
 from providers.alert.alert_provider import AlertProvider
 
 logger = logging.getLogger(__name__)
@@ -16,34 +20,34 @@ class HTTPAlertProvider(AlertProvider):
     """Generic alert provider class for providers that request data via HTTP(S). Just for convenience to avoid code
     duplication. Subclasses of this query the individual APIs for data."""
 
-    def __init__(self, name, provider_config, url, poll_interval):
+    def __init__(self, name: str, provider_config: dict[str, Any], url: str, poll_interval: int) -> None:
         super().__init__(name, provider_config)
         self._url = url
         self._poll_interval = poll_interval
-        self._thread = None
+        self._thread: Thread | None = None
         self._stop_event = Event()
 
-    def start(self):
+    def start(self) -> None:
         # Fire off the polling thread. It will poll immediately on startup, then sleep for poll_interval between
         # subsequent polls, so start() returns immediately and the application can continue starting.
         logger.info(f"Set up query of {self.name} alert API every {self._poll_interval!s} seconds.")
         self._thread = Thread(target=self._run, name=f"HTTPAlertProvider-{self.name}", daemon=True)
         self._thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         self._stop_event.set()
         if self._thread:
             self._thread.join(timeout=12)
             if self._thread.is_alive():
                 logger.warning(f"{self.name} alert worker thread did not exit on time and will be killed.")
 
-    def _run(self):
+    def _run(self) -> None:
         while True:
             self._poll()
             if self._stop_event.wait(timeout=self._poll_interval):
                 break
 
-    def _poll(self):
+    def _poll(self) -> None:
         try:
             # Request data from API
             logger.debug(f"Polling {self.name} alert API...")
@@ -78,7 +82,7 @@ class HTTPAlertProvider(AlertProvider):
             # Brief pause on error before the next poll, but still respond promptly to stop()
             self._stop_event.wait(timeout=1)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         """Convert an HTTP response returned by the API into alert data. The whole response is provided here so the subclass
         implementations can check for HTTP status codes if necessary, and handle the response as JSON, XML, text, whatever
         the API actually provides."""