Autogenerated type safety parameterisation of all methods

providers/spot/spot_provider.py

@@ -1,30 +1,39 @@
+from __future__ import annotations
+
 from datetime import datetime
+from typing import TYPE_CHECKING, Any
 
 import pytz
 
 from core.data_store import DATA_STORE
+from core.live_data_cache import LiveDataCache
+
+if TYPE_CHECKING:
+    # Deferred to avoid a circular import: data.spot imports core.call_lookup_helper, which imports
+    # core.data_providers, which imports this module.
+    from data.spot import Spot
 
 
 class SpotProvider:
     """Generic spot provider class. Subclasses of this query the individual APIs for data."""
 
-    def __init__(self, name, provider_config):
+    def __init__(self, name: str, provider_config: dict[str, Any]) -> None:
         """Constructor"""
 
-        self.name = name
-        self.enabled = provider_config.get("enabled", True)
-        self.enabled_by_default_in_web_ui = provider_config.get("enabled_by_default_in_web_ui", True)
-        self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
-        self.last_spot_time = datetime.min.replace(tzinfo=pytz.UTC)
-        self.status = "Not Started" if self.enabled else "Disabled"
-        self._spots = DATA_STORE.spots
+        self.name: str = name
+        self.enabled: bool = provider_config.get("enabled", True)
+        self.enabled_by_default_in_web_ui: bool = provider_config.get("enabled_by_default_in_web_ui", True)
+        self.last_update_time: datetime = datetime.min.replace(tzinfo=pytz.UTC)
+        self.last_spot_time: datetime = datetime.min.replace(tzinfo=pytz.UTC)
+        self.status: str = "Not Started" if self.enabled else "Disabled"
+        self._spots: LiveDataCache[Spot] = DATA_STORE.spots
 
-    def start(self):
+    def start(self) -> None:
         """Start the provider. This should return immediately after spawning threads to access the remote resources"""
 
         raise NotImplementedError("Subclasses must implement this method")
 
-    def _submit_batch(self, spots):
+    def _submit_batch(self, spots: list[Spot]) -> None:
         """Submit a batch of spots retrieved from the provider. Only spots that are newer than the last spot retrieved
         by this provider will be added to the spot list, to prevent duplications. Spots passing the check will also have
         their infer_missing() method called to complete their data set. This is called by the API-querying
@@ -41,7 +50,7 @@ class SpotProvider:
         if spots:
             self.last_spot_time = datetime.fromtimestamp(max(s.time for s in spots), pytz.UTC)
 
-    def _submit(self, spot):
+    def _submit(self, spot: Spot) -> None:
         """Submit a single spot retrieved from the provider. This will be added to the list regardless of its age. Spots
         passing the check will also have their infer_missing() method called to complete their data set. This is called by
         the data streaming subclasses, which can be relied upon not to re-provide old spots."""
@@ -51,27 +60,27 @@ class SpotProvider:
         self._add_spot(spot)
         self.last_spot_time = datetime.fromtimestamp(spot.time, pytz.UTC)
 
-    def _add_spot(self, spot):
+    def _add_spot(self, spot: Spot) -> None:
         if not spot.expired():
             self._spots.set(spot.id, spot)
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown"""
 
         raise NotImplementedError("Subclasses must implement this method")
 
-    def can_submit_spot(self, activity):
+    def can_submit_spot(self, activity: str) -> bool:
         """Return True if this provider supports submitting spots upstream for the given activity."""
 
         return False
 
-    def submit_spot(self, spot, credentials):
+    def submit_spot(self, spot: Spot, credentials: dict[str, str]) -> None:
         """Submit a spot upstream to this provider's API. credentials is a dict with provider-specific keys.
         Raises an exception with a descriptive message on failure."""
 
         raise NotImplementedError("This provider does not support spot submission")
 
-    def force_poll(self):
+    def force_poll(self) -> None:
         """Trigger an immediate poll without waiting for the normal interval. Default implementation here does nothing
         because not all spot providers have a polling mechanism. Providers that do should override this method."""