Autogenerated type safety parameterisation of all methods

providers/activityrefdata/file_download_activity_ref_data_provider.py

@@ -1,12 +1,17 @@
+from __future__ import annotations
+
 import logging
 from datetime import datetime
 from threading import Thread
+from typing import Any
 
 import pytz
+import requests
 from requests.exceptions import ConnectionError, ConnectTimeout, ReadTimeout
 
 from core.constants import HTTP_HEADERS
 from core.url_data_cache import URLDataCache
+from data.activity_ref import ActivityRef
 from providers.activityrefdata.activity_ref_data_provider import ActivityRefDataProvider
 
 logger = logging.getLogger(__name__)
@@ -16,35 +21,35 @@ class FileDownloadActivityRefDataProvider(ActivityRefDataProvider):
     """Generic activity ref data provider class for providers that fetch their data from the web by downloading a
     file."""
 
-    def __init__(self, sig_name, provider_config, url, poll_interval):
+    def __init__(self, sig_name: str, provider_config: dict[str, Any], url: str, poll_interval: float) -> None:
         """Set up the provider, note poll_interval is in *days*."""
         super().__init__(sig_name, provider_config)
         self._url = url
         self._poll_interval = poll_interval
-        self._thread = None
+        self._thread: Thread | None = None
         self._url_data_cache = URLDataCache(f"activity_ref_data_{sig_name}")
 
-    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.sig_name} activity ref data every {self._poll_interval!s} days.")
         self._thread = Thread(target=self._run, name=f"FileDownloadActivityRefDataProvider-{self.sig_name}", daemon=True)
         self._thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         super().stop()
         if self._thread:
             self._thread.join(timeout=12)
             if self._thread.is_alive():
                 logger.warning(f"{self.sig_name} activity ref data 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 * 60 * 60 * 24):
                 break
 
-    def _poll(self):
+    def _poll(self) -> None:
         try:
             # Request data from API. Use the data cache (with a TTL of 1 day) here, not as the main mechanism for
             # caching, but just so continual restarts of the software during testing don't hammer the servers.
@@ -76,7 +81,7 @@ class FileDownloadActivityRefDataProvider(ActivityRefDataProvider):
             logger.exception(f"Exception in HTTP Activity Ref Data Provider ({self.sig_name})")
             self._stop_event.wait(timeout=1)
 
-    def _http_response_to_data(self, http_response):
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
         """Convert an HTTP response returned by the server into activity ref 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, CSV, whatever the remote file actually is."""