Partial fix for mypy issues

README.md

@@ -1,4 +1,4 @@
-# ![Spothole](https://git.ianrenton.com/ian/spothole/raw/branch/main/static/img/logo.png)
+# ![Spothole](/static/img/logo.png)
 
 Spothole is a utility to aggregate "spots" from amateur radio DX clusters and xOTA spotting sites, and provide an open
 JSON API as well as a website to browse the data, and its own telnet server for integration with desktop loggers.
@@ -17,25 +17,42 @@ individual data source presents its data.
 
 Spothole itself is also open source, Public Domain licenced code that anyone can take and modify.
 
-You can read more about Spothole on [the "Help" pages of the main server instance](https://spothole.app/help).
+Supported data sources include DX Clusters, the Reverse Beacon Network (RBN), the APRS Internet Service (APRS-IS), POTA,
+SOTA, WWFF, GMA, WWBOTA, HEMA, Parks 'n' Peaks, ZLOTA, WOTA, BOTA, LLOTA, WWTOTA, Tiles on the Air, the UK Packet
+Repeater Network, NG3K, and any site based on the xOTA software by nischu. It also integrates with QRZ.com and HamQTH,
+retrieves solar data from various sources, provides information about upcoming contests, and more.
+
+You can read more about Spothole on [the "About" page of the main server instance](https://spothole.app/about).
 
 ![Screenshot](/images/screenshot2.png)
 
+![Screenshot](/images/screenshot3.png)
+
 ## Accessing the public version
 
 You can access the public version's web interface at [https://spothole.app](https://spothole.app), and
 see [https://spothole.app/apidocs](https://spothole.app/apidocs) for the API details.
 
-You are more than welcome to use the data and the API that Spothole provides to power your own software, to run your own
-Spothole server, or to modify it in any way. More details can be found
-in [the "Help" pages of the main server instance](https://spothole.app/help).
+This is a Progressive Web App, so you can also "install" it to your Android or iOS device by accessing it in Chrome or
+Safari respectively, and following the menu-driven process for installing PWAs.
 
-![Screenshot](/images/screenshot3.png)
+You are more than welcome to use the data and the API that Spothole provides to power your own software, to run your own
+Spothole server, or to modify it in any way. More details can be found in the following sections:
+
+* [Embedding Spothole in another website](docs/embedding.md)
+* [Writing your own client](docs/clients.md)
+* [Running your own copy](docs/running.md)
+    * [nginx reverse proxy configuration](docs/nginx.md)
+    * [systemd service file](docs/systemd.md)
+    * [Running in Docker](docs/docker.md)
+    * [Use of multiple cluster logins](docs/multicluster.md)
+* [Modifying the source code](docs/modifying.md)
+
+![Screenshot](/images/screenshot4.png)
 
 ## Thanks
 
-[Spothole's "Thanks" page](https://spothole.app/help/thanks) contains the full details of the thanks I owe to the
-various
+[Spothole's "About" page](https://spothole.app/about) contains the full details of the thanks I owe to the various
 programme teams, software library providers, bug fixers etc. The extra detail below contains the extra detail of
 specific files in this repository which are not all my own work and may be subject to other licences.
 

core/activity_lookup_helper.py

@@ -12,7 +12,7 @@ from data.activity_ref import ActivityRef
 logger = logging.getLogger(__name__)
 
 
-def get_activity_ref_info(activity_name, ref_id):
+def get_activity_ref_info(activity_name: str | None, ref_id: str | None) -> ActivityRef | None:
     """Look up details of an activity reference (e.g. POTA park) such as name, lat/lon, and grid. Takes in an
     activity name and a reference ID (both strings) and returns an ActivityRef object populated with as much data
     as we can find. This makes use of activity ref data in the data store, live lookups from the web, or just
@@ -52,11 +52,11 @@ def get_activity_ref_info(activity_name, ref_id):
         if activity_name.upper() == ActivityName.DTMBA:
             ref_id = ref_id.replace("-", "").replace(" ", "")
 
-        ### NO REFERENCE ACTIVITIES ###
+        ### NO DATA ACTIVITIES ###
         #
-        # If the activity doesn't have references, we have no way to either generate useful data or look it up on a
+        # If the activity is HEMA or BIWOTA, we have no way to either generate useful data or look it up on a
         # reference list, so just skip the lookup here.
-        if not activity.has_refs:
+        if activity_name.upper() == ActivityName.HEMA or activity_name.upper() == ActivityName.BIWOTA:
             return activity_ref
 
         ### PROGRAMMATIC DATA GENERATION INSTEAD OF LOOKUPS ###
@@ -102,12 +102,14 @@ def get_activity_ref_info(activity_name, ref_id):
             # the best result.
             iota_lookup = get_activity_ref_info(ActivityName.IOTA, ref_id)
             gma_lookup = get_activity_ref_info(ActivityName.GMA, ref_id)
-            for key, value in iota_lookup.__dict__.items():
-                if value is not None and activity_ref.__dict__.get(key) is None:
-                    activity_ref.__dict__[key] = value
-            for key, value in gma_lookup.__dict__.items():
-                if value is not None and activity_ref.__dict__.get(key) is None:
-                    activity_ref.__dict__[key] = value
+            if iota_lookup:
+                for key, value in iota_lookup.__dict__.items():
+                    if value is not None and activity_ref.__dict__.get(key) is None:
+                        activity_ref.__dict__[key] = value
+            if gma_lookup:
+                for key, value in gma_lookup.__dict__.items():
+                    if value is not None and activity_ref.__dict__.get(key) is None:
+                        activity_ref.__dict__[key] = value
             activity_ref.ref_type = ActivityRefType.ISLAND
             return activity_ref
 
@@ -139,7 +141,7 @@ def get_activity_ref_info(activity_name, ref_id):
     return activity_ref
 
 
-def populate_missing_activity_ref_info(activity_ref):
+def populate_missing_activity_ref_info(activity_ref: ActivityRef) -> ActivityRef:
     """Look up details of an activity reference (e.g. POTA park) such as name, lat/lon, and grid. Takes in an
     activity_ref object which must at minimum have a "sig" and an "id". The rest of the object will be populated
     and returned. Any data currently in the object will be kept, only missing data in the object will be populated

core/activity_utils.py

@@ -1,7 +1,9 @@
+from core.enums import ActivityName
 from data.activities import ACTIVITIES
+from data.activity import Activity
 
 
-def get_activity_by_name(name):
+def get_activity_by_name(name: str | None) -> Activity | None:
     """Utility function to resolve an arbitrary, case-insensitive activity name string (e.g. from a spot comment, a
     provider, or an API request) to the matching known Activity. Returns None if no match is found."""
 
@@ -13,7 +15,7 @@ def get_activity_by_name(name):
     return None
 
 
-def get_ref_regex_for_activity(activity):
+def get_ref_regex_for_activity(activity: str) -> str | None:
     """Utility function to get the regex string for an activity reference for a named activity. If no match is
     found, None will be returned."""
 
@@ -21,14 +23,14 @@ def get_ref_regex_for_activity(activity):
     return found.ref_regex if found else None
 
 
-def get_icon_for_activity(activity):
+def get_icon_for_activity(activity: str) -> str | None:
     """Utility function to get the icon for a named activity. If no match is found, None will be returned."""
 
     found = get_activity_by_name(activity)
     return found.icon if found else None
 
 
-def get_activity_name_from_comment_name(activity):
+def get_activity_name_from_comment_name(activity: str) -> ActivityName | None:
     """Utility function to get the name of an activity from its "comment name". Generally these will be the same
     but there are some cases (e.g. is "TOTA" Towers, Tiles or Toilets?) where we need to transform one to the
     other."""

core/call_lookup_helper.py

@@ -2,14 +2,15 @@ import re
 
 from core.data_providers import DATA_PROVIDERS
 from data.callsign import Callsign
+from data.lookup_credentials import LookupCredentials
 
 
-def get_call_info(callsign, lookup_credentials):
+def get_call_info(callsign: str | None, lookup_credentials: LookupCredentials | None) -> Callsign:
     """Utility method to get the best set of data for a callsign as we can, using all enabled providers.
     lookup_credentials is an optional object that carries the user's QRZ.com/HamQTH credentials, if they provided them,
     to enable lookup using those providers."""
 
-    callsign_data = Callsign(call=callsign)
+    callsign_data = Callsign(call=callsign or "")
 
     # First check our input looks like a real callsign
     if callsign and re.match(r"^[A-Za-z0-9/\-]*$", callsign):

core/cleanup.py

@@ -12,25 +12,25 @@ logger = logging.getLogger(__name__)
 class CleanupTimer:
     """Provides a timed cleanup of the spot list."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Constructor"""
 
-        self._cleanup_interval = None
+        self._cleanup_interval: float | None = None
         self.last_cleanup_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Starting"
-        self._thread = None
+        self._thread: Thread | None = None
         self._stop_event = Event()
 
-    def setup(self, cleanup_interval):
+    def setup(self, cleanup_interval: float) -> None:
         self._cleanup_interval = cleanup_interval
 
-    def start(self):
+    def start(self) -> None:
         """Start the cleanup timer"""
 
         self._thread = Thread(target=self._run, daemon=True)
         self._thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown"""
 
         self._stop_event.set()
@@ -39,11 +39,11 @@ class CleanupTimer:
             if self._thread.is_alive():
                 logger.warning("Cleanup worker thread did not exit on time and will be killed.")
 
-    def _run(self):
+    def _run(self) -> None:
         while not self._stop_event.wait(timeout=self._cleanup_interval):
             self._cleanup()
 
-    def _cleanup(self):
+    def _cleanup(self) -> None:
         """Perform cleanup and reschedule next timer"""
 
         try:

core/config.py

@@ -2,6 +2,7 @@ import importlib
 import logging
 import os
 import sys
+from typing import Any
 
 import yaml
 
@@ -16,25 +17,25 @@ if not os.path.isfile("config.yml"):
 
 # Load config
 with open("config.yml") as f:
-    config = yaml.safe_load(f)
+    config: dict[str, Any] = yaml.safe_load(f)
 logger.info("Loaded config.")
 
-BASE_URL = config.get("base_url", "http://localhost:8080")
-MAX_SPOT_AGE = config.get("max_spot_age_sec", 3600)
-MAX_ALERT_AGE = config.get("max_alert_age_sec", 604800)
-SERVER_OWNER_CALLSIGN = config.get("server_owner_callsign", "N0CALL")
-WEB_SERVER_PORT = config.get("web_server_port", 8080)
-TELNET_SERVER_ENABLED = config.get("telnet_server_enabled", False)
-TELNET_SERVER_ADDRESS = config.get("telnet_server_address", "localhost")
-TELNET_SERVER_PORT = config.get("telnet_server_port", 7373)
-ALLOW_SPOTTING = config.get("allow_spotting", True)
-ALLOW_UPSTREAM_SPOTTING = config.get("allow_upstream_spotting", True)
-WEB_UI_OPTIONS = config.get("web_ui_options", {})
-API_ONLY_MODE = config.get("api_only_mode", False)
-RECAPTCHA_SECRET_KEY = config.get("recaptcha_secret_key", "")
-RECAPTCHA_SITE_KEY = config.get("recaptcha_site_key", "")
-LOG_LEVEL = config.get("log_level", "INFO")
-LOG_WEB_REQUESTS = config.get("log_web_requests", False)
+BASE_URL: str = config.get("base_url", "http://localhost:8080")
+MAX_SPOT_AGE: int = config.get("max_spot_age_sec", 3600)
+MAX_ALERT_AGE: int = config.get("max_alert_age_sec", 604800)
+SERVER_OWNER_CALLSIGN: str = config.get("server_owner_callsign", "N0CALL")
+WEB_SERVER_PORT: int = config.get("web_server_port", 8080)
+TELNET_SERVER_ENABLED: bool = config.get("telnet_server_enabled", False)
+TELNET_SERVER_ADDRESS: str = config.get("telnet_server_address", "localhost")
+TELNET_SERVER_PORT: int = config.get("telnet_server_port", 7373)
+ALLOW_SPOTTING: bool = config.get("allow_spotting", True)
+ALLOW_UPSTREAM_SPOTTING: bool = config.get("allow_upstream_spotting", True)
+WEB_UI_OPTIONS: dict[str, Any] = config.get("web_ui_options", {})
+API_ONLY_MODE: bool = config.get("api_only_mode", False)
+RECAPTCHA_SECRET_KEY: str = config.get("recaptcha_secret_key", "")
+RECAPTCHA_SITE_KEY: str = config.get("recaptcha_site_key", "")
+LOG_LEVEL: str = config.get("log_level", "INFO")
+LOG_WEB_REQUESTS: bool = config.get("log_web_requests", False)
 
 WEB_UI_OPTIONS["qrz_enabled"] = any(p["class"] == "QRZ" and p["enabled"] for p in config["callsign_data_providers"])
 WEB_UI_OPTIONS["hamqth_enabled"] = any(
@@ -44,7 +45,7 @@ WEB_UI_OPTIONS["recaptcha_site_key"] = RECAPTCHA_SITE_KEY
 WEB_UI_OPTIONS["allow_upstream_spotting"] = ALLOW_SPOTTING and ALLOW_UPSTREAM_SPOTTING
 
 
-def create_provider_from_config(package, config_providers_entry):
+def create_provider_from_config(package: str, config_providers_entry: dict[str, Any]) -> Any:
     """Utility method to get a provider based on the class specified in its config entry. You must also provide the
     package to look for it in, as there are several types of provider. e.g. package "providers.spot", where the config
     entry is for a POTA spot provider."""

core/constants.py

@@ -2,14 +2,14 @@ from core.config import SERVER_OWNER_CALLSIGN
 from data.band import Band
 
 # General software
-SOFTWARE_VERSION = "2.2"
+SOFTWARE_VERSION: str = "2.2-pre"
 
 # HTTP headers used for spot providers that use HTTP
-HTTP_HEADERS = {"User-Agent": f"Spothole v{SOFTWARE_VERSION} (operated by {SERVER_OWNER_CALLSIGN})"}
-HAMQTH_PRG = f"Spothole v{SOFTWARE_VERSION} operated by {SERVER_OWNER_CALLSIGN}".replace(" ", "_")
+HTTP_HEADERS: dict[str, str] = {"User-Agent": f"Spothole v{SOFTWARE_VERSION} (operated by {SERVER_OWNER_CALLSIGN})"}
+HAMQTH_PRG: str = f"Spothole v{SOFTWARE_VERSION} operated by {SERVER_OWNER_CALLSIGN}".replace(" ", "_")
 
 # Band definitions
-BANDS = [
+BANDS: list[Band] = [
     Band(name="2200m", start_freq=135700, end_freq=137800),
     Band(name="600m", start_freq=472000, end_freq=479000),
     Band(name="160m", start_freq=1800000, end_freq=2000000, is_ham_hf=True),
@@ -37,11 +37,11 @@ BANDS = [
     Band(name="47GHz", start_freq=47000000000, end_freq=47200000000),
     Band(name="76GHz", start_freq=75500000000, end_freq=81500000000),
 ]
-UNKNOWN_BAND = Band(name="Unknown", start_freq=0, end_freq=0)
+UNKNOWN_BAND: Band = Band(name="Unknown", start_freq=0, end_freq=0)
 
 # Propagation modes used in VHF/UHF DX cluster comments, e.g. "JN61ES<ES>JM56XT". I don't think there's an official list
 # of these anywhere, but here are some I've seen or seen reference to
-PROPAGATION_MODES = {
+PROPAGATION_MODES: dict[str, str] = {
     "F2": "F2 layer ionospheric",
     "ES": "Sporadic-E",
     "TR": "Tropospheric ducting",

core/data_providers.py

@@ -1,25 +1,39 @@
+from __future__ import annotations
+
 import logging
 import threading
 import time
+from collections.abc import Sequence
+from typing import TYPE_CHECKING
 
 from core.config import config, create_provider_from_config
 
+if TYPE_CHECKING:
+    # Can't find a way to resolve the circular dependency on types but apparently this is a way of managing that
+    # while still having type safety in method definitions.
+    from providers.activityrefdata.activity_ref_data_provider import ActivityRefDataProvider
+    from providers.alert.alert_provider import AlertProvider
+    from providers.callsigndata.callsign_data_provider import CallsignDataProvider
+    from providers.solarconditions.solar_conditions_provider import SolarConditionsProvider
+    from providers.spot.spot_provider import SpotProvider
+    from providers.staticdata.static_data_provider import StaticDataProvider
+
 logger = logging.getLogger(__name__)
 
 
 class DataProviders:
     """Global object for storing data providers."""
 
-    def __init__(self):
-        self.spot_providers = []
-        self.alert_providers = []
-        self.solar_condition_providers = []
-        self.static_data_providers = []
-        self.sig_ref_data_providers = []
-        self.callsign_data_providers = []
-        self._startup_timers = []
+    def __init__(self) -> None:
+        self.spot_providers: list[SpotProvider] = []
+        self.alert_providers: list[AlertProvider] = []
+        self.solar_condition_providers: list[SolarConditionsProvider] = []
+        self.static_data_providers: list[StaticDataProvider] = []
+        self.sig_ref_data_providers: list[ActivityRefDataProvider] = []
+        self.callsign_data_providers: list[CallsignDataProvider] = []
+        self._startup_timers: list[threading.Timer] = []
 
-    def setup(self):
+    def setup(self) -> None:
         for entry in config["spot_providers"]:
             self.spot_providers.append(create_provider_from_config("providers.spot", entry))
         for entry in config["alert_providers"]:
@@ -34,7 +48,12 @@ class DataProviders:
             self.callsign_data_providers.append(create_provider_from_config("providers.callsigndata", entry))
 
     @staticmethod
-    def start_providers(providers, provider_type):
+    def start_providers(
+        providers: Sequence[
+            SpotProvider | AlertProvider | SolarConditionsProvider | StaticDataProvider | ActivityRefDataProvider | CallsignDataProvider
+        ],
+        provider_type: str,
+    ) -> None:
         """Helper method to activate enabled providers in the list."""
 
         logger.info(f"Starting {provider_type} providers...")
@@ -42,7 +61,7 @@ class DataProviders:
             if p.enabled:
                 p.start()
 
-    def start(self):
+    def start(self) -> None:
         # Start data providers before spot/alert providers so the lookup data is there already for incoming spots.
         # Each category is fired off after a small delay to give the rest of Spothole chance to start up.
         self._startup_timers = [
@@ -60,7 +79,7 @@ class DataProviders:
             t.daemon = True
             t.start()
 
-    def stop(self):
+    def stop(self) -> None:
         # Cancel any startup timers that haven't fired yet
         for t in self._startup_timers:
             t.cancel()
@@ -81,20 +100,22 @@ class DataProviders:
         if not all_providers:
             return
 
-        def stop_provider(p):
+        def stop_provider(
+            p: SpotProvider | AlertProvider | SolarConditionsProvider | StaticDataProvider | ActivityRefDataProvider | CallsignDataProvider,
+        ) -> None:
             try:
                 p.stop()
             except Exception:
                 logger.exception("Exception stopping provider")
 
         threads = [threading.Thread(target=stop_provider, args=(p,), daemon=True) for p in all_providers]
-        for t in threads:
-            t.start()
+        for thread in threads:
+            thread.start()
 
         deadline = time.monotonic() + 15
-        for t in threads:
-            t.join(timeout=max(0.0, deadline - time.monotonic()))
-        still_running = [t for t in threads if t.is_alive()]
+        for thread in threads:
+            thread.join(timeout=max(0.0, deadline - time.monotonic()))
+        still_running = [thread for thread in threads if thread.is_alive()]
         if still_running:
             logger.warning("Some threads did not stop in time!")
 

core/data_store.py

@@ -1,14 +1,24 @@
+from __future__ import annotations
+
 import logging
 import re
 from pathlib import Path
+from typing import TYPE_CHECKING, Any
 
 import diskcache
+import geopandas
 
 from core.config import MAX_ALERT_AGE, MAX_SPOT_AGE
 from core.live_data_cache import LiveDataCache
 from core.single_object_data_cache import SingleObjectDataCache
 from data.solar_conditions import SolarConditions
 
+if TYPE_CHECKING:
+    # Can't find a way to resolve the circular dependency on types but apparently this is a way of managing that
+    # while still having type safety in method definitions.
+    from data.alert import Alert
+    from data.spot import Spot
+
 logger = logging.getLogger(__name__)
 
 CACHE_DIR = "./cache/"
@@ -18,58 +28,115 @@ class DataStore:
     """Data caching/storage object. Handles storage of spots, alerts, solar conditions, activity reference data, and
     callsign lookup data using different caching strategies for each."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         # Constants
         self._MAX_SPOT_COUNT = 100000
         self._MAX_ALERT_COUNT = 100000
         self._SPOT_ALERT_SNAPSHOT_INTERVAL_SEC = 300
         self.CALLSIGN_DATA_TTL_SEC = 30 * 24 * 60 * 60
-        # Caches
-        self.alerts = None
-        self.spots = None
-        self.callsign_data_countryfiles = None
-        self.callsign_data_clublogxml = None
-        self.callsign_data_clublogapi = None
-        self.callsign_data_qrz = None
-        self.callsign_data_hamqth = None
-        self.dxcc_data = None
-        self.dxcc_lookup_by_call_regex = []
-        self.activity_refs = None
-        self.status = None
-        self.solar_conditions = None
+        # Caches. These are all created by setup(), which must be called before use; they are None only in the window
+        # between construction of this (global, single-instance) object and that call.
+        self._alerts: LiveDataCache[Alert] | None = None
+        self._spots: LiveDataCache[Spot] | None = None
+        self._callsign_data_countryfiles: diskcache.Cache | None = None
+        self._callsign_data_clublogxml: diskcache.Cache | None = None
+        self._callsign_data_clublogapi: diskcache.Cache | None = None
+        self._callsign_data_qrz: diskcache.Cache | None = None
+        self._callsign_data_hamqth: diskcache.Cache | None = None
+        self._dxcc_data: diskcache.Cache | None = None
+        self.dxcc_lookup_by_call_regex: list[tuple[re.Pattern[str], Any]] = []
+        self._activity_refs: diskcache.Cache | None = None
+        self._status: SingleObjectDataCache[dict[str, Any]] | None = None
+        self._solar_conditions: SingleObjectDataCache[SolarConditions] | None = None
         # ITU/CQ zone GeoJSON data is only ever loaded statically from a local file so these don't even need to be
-        # caches, they can just be straight objects
-        self.cq_zone_data = None
-        self.itu_zone_data = None
+        # caches, they can just be straight objects. Unlike the caches above, these genuinely may never be populated,
+        # if the corresponding static data provider isn't configured, so callers must handle None.
+        self.cq_zone_data: geopandas.GeoDataFrame | None = None
+        self.itu_zone_data: geopandas.GeoDataFrame | None = None
 
-    def setup(self):
+    @property
+    def alerts(self) -> LiveDataCache[Alert]:
+        assert self._alerts is not None, "DataStore.setup() must be called before use"
+        return self._alerts
+
+    @property
+    def spots(self) -> LiveDataCache[Spot]:
+        assert self._spots is not None, "DataStore.setup() must be called before use"
+        return self._spots
+
+    @property
+    def callsign_data_countryfiles(self) -> diskcache.Cache:
+        assert self._callsign_data_countryfiles is not None, "DataStore.setup() must be called before use"
+        return self._callsign_data_countryfiles
+
+    @property
+    def callsign_data_clublogxml(self) -> diskcache.Cache:
+        assert self._callsign_data_clublogxml is not None, "DataStore.setup() must be called before use"
+        return self._callsign_data_clublogxml
+
+    @property
+    def callsign_data_clublogapi(self) -> diskcache.Cache:
+        assert self._callsign_data_clublogapi is not None, "DataStore.setup() must be called before use"
+        return self._callsign_data_clublogapi
+
+    @property
+    def callsign_data_qrz(self) -> diskcache.Cache:
+        assert self._callsign_data_qrz is not None, "DataStore.setup() must be called before use"
+        return self._callsign_data_qrz
+
+    @property
+    def callsign_data_hamqth(self) -> diskcache.Cache:
+        assert self._callsign_data_hamqth is not None, "DataStore.setup() must be called before use"
+        return self._callsign_data_hamqth
+
+    @property
+    def dxcc_data(self) -> diskcache.Cache:
+        assert self._dxcc_data is not None, "DataStore.setup() must be called before use"
+        return self._dxcc_data
+
+    @property
+    def activity_refs(self) -> diskcache.Cache:
+        assert self._activity_refs is not None, "DataStore.setup() must be called before use"
+        return self._activity_refs
+
+    @property
+    def status(self) -> SingleObjectDataCache[dict[str, Any]]:
+        assert self._status is not None, "DataStore.setup() must be called before use"
+        return self._status
+
+    @property
+    def solar_conditions(self) -> SingleObjectDataCache[SolarConditions]:
+        assert self._solar_conditions is not None, "DataStore.setup() must be called before use"
+        return self._solar_conditions
+
+    def setup(self) -> None:
         Path(CACHE_DIR).mkdir(parents=True, exist_ok=True)
 
         # For solar data and status data, we use a wrapper around disk cache where each cache contains only a single
         # object exposed to the wider application, and provides a store() method for callers to notify diskcache that
         # the object has changed and needs to be re-cached.
-        self.solar_conditions = SingleObjectDataCache(f"{CACHE_DIR}solar", SolarConditions())
-        self.status = SingleObjectDataCache(f"{CACHE_DIR}status", {})
+        self._solar_conditions = SingleObjectDataCache(f"{CACHE_DIR}solar", SolarConditions())
+        self._status = SingleObjectDataCache(f"{CACHE_DIR}status", {})
 
         # Standard disk cache for static reference and activity ref data. Separate provider threads will repopulate
         # these on a regular basis but there's no need for a TTL since old data is better than no data.
-        self.dxcc_data = diskcache.Cache(f"{CACHE_DIR}dxcc_data")
+        self._dxcc_data = diskcache.Cache(f"{CACHE_DIR}dxcc_data")
         self.regenerate_call_regex_to_dxcc_entity_map()
 
         # For activity reference data specifically, we need to key on both activity *and* reference, and trying to do
         # two layers of dict in diskcache absolutely destroys performance with unpickling huge dicts, so we have an
         # ugly "activity:ref" syntax for keys to keep it a single level.
-        self.activity_refs = diskcache.Cache(f"{CACHE_DIR}activity_refs")
+        self._activity_refs = diskcache.Cache(f"{CACHE_DIR}activity_refs")
         logger.info(f"Loaded data for {len(self.activity_refs)} activity references.")
 
         # Standard disk cache for callsign data. This data does have a TTL to trigger an occasional re-lookup.
         # Old data *is* better than no data, but we can't have a background thread re-looking-up every callsign
         # we've seen, so we rely on them timing out and this triggering another lookup.
-        self.callsign_data_countryfiles = diskcache.Cache(f"{CACHE_DIR}callsign_data_countryfiles")
-        self.callsign_data_clublogxml = diskcache.Cache(f"{CACHE_DIR}callsign_data_clublogxml")
-        self.callsign_data_clublogapi = diskcache.Cache(f"{CACHE_DIR}callsign_data_clublogapi")
-        self.callsign_data_qrz = diskcache.Cache(f"{CACHE_DIR}callsign_data_qrz")
-        self.callsign_data_hamqth = diskcache.Cache(f"{CACHE_DIR}callsign_data_hamqth")
+        self._callsign_data_countryfiles = diskcache.Cache(f"{CACHE_DIR}callsign_data_countryfiles")
+        self._callsign_data_clublogxml = diskcache.Cache(f"{CACHE_DIR}callsign_data_clublogxml")
+        self._callsign_data_clublogapi = diskcache.Cache(f"{CACHE_DIR}callsign_data_clublogapi")
+        self._callsign_data_qrz = diskcache.Cache(f"{CACHE_DIR}callsign_data_qrz")
+        self._callsign_data_hamqth = diskcache.Cache(f"{CACHE_DIR}callsign_data_hamqth")
         unique_keys = set()
         for c in [
             self.callsign_data_countryfiles,
@@ -84,7 +151,7 @@ class DataStore:
         # Special caches for spots and alerts, which have TTL and write snapshots to disk at an interval. We
         # specifically load these caches *last* so that any activity ref and callsign data is already loaded from disk
         # cache before the spots and alerts are live in the system.
-        self.spots = LiveDataCache(
+        self._spots = LiveDataCache(
             maxsize=self._MAX_SPOT_COUNT,
             ttl=MAX_SPOT_AGE,
             snapshot_dir=f"{CACHE_DIR}spots",
@@ -92,7 +159,7 @@ class DataStore:
         )
         logger.info(f"Loaded {len(self.spots.keys())} spots from a previous run.")
 
-        self.alerts = LiveDataCache(
+        self._alerts = LiveDataCache(
             maxsize=self._MAX_ALERT_COUNT,
             ttl=MAX_ALERT_AGE,
             snapshot_dir=f"{CACHE_DIR}alerts",
@@ -100,7 +167,7 @@ class DataStore:
         )
         logger.info(f"Loaded {len(self.alerts.keys())} alerts from a previous run.")
 
-    def regenerate_call_regex_to_dxcc_entity_map(self):
+    def regenerate_call_regex_to_dxcc_entity_map(self) -> None:
         """DXCC entity data from K0SWE includes a regex which we can use to match a callsign, and determine which DXCC
         entity it belongs to. But getting every DXCC entity data object out of DiskCache, iterating, compiling its regex
         and testing the callsign every time is expensive. So instead we build a separate in-memory lookup of compiled
@@ -110,7 +177,7 @@ class DataStore:
         for entry in [DATA_STORE.dxcc_data[key] for key in DATA_STORE.dxcc_data]:
             self.dxcc_lookup_by_call_regex.append((re.compile(entry["prefixRegex"]), entry["entityCode"]))
 
-    def close(self):
+    def close(self) -> None:
         self.spots.close()
         self.alerts.close()
         self.solar_conditions.close()

core/enums.py

@@ -44,7 +44,7 @@ class Mode(str, Enum):
         return not (self.is_cw or self.is_phone)
 
     @staticmethod
-    def from_name(name):
+    def from_name(name: str) -> "Mode | None":
         """Convert a string to an enum mode using the alias table."""
 
         if not name:
@@ -140,7 +140,7 @@ class ActivityName(str, Enum):
     PGA = "PGA"
     TOILETS = "Toilets"
 
-    def __str__(self):
+    def __str__(self) -> str:
         return str(self.value)
 
 
@@ -163,7 +163,6 @@ class ActivityRefType(str, Enum):
     BUILDING = "BUILDING"
     REGION = "REGION"
     GRID = "GRID"
-    SATELLITE = "SATELLITE"
     TOILET = "TOILET"
 
 
@@ -180,7 +179,7 @@ class ActivityType(str, Enum):
 # we already know, or we want to normalise things for consistency. The lookup table for this is here. Incoming spots
 # that match a key in this table will be converted to the corresponding value, so only the modes above will actually be
 # present in the spots.
-MODE_ALIASES = {
+MODE_ALIASES: dict[str, str] = {
     "USB": "SSB",
     "LSB": "SSB",
     "DIGITALVOICE": "DV",

core/geo_utils.py

@@ -14,7 +14,7 @@ TRANSFORMER_IRISH_GRID_TO_WGS84 = Transformer.from_crs("EPSG:29903", "EPSG:4326"
 TRANSFORMER_CI_UTM_GRID_TO_WGS84 = Transformer.from_crs("+proj=utm +zone=30 +ellps=WGS84", "EPSG:4326")
 
 
-def lat_lon_to_cq_zone(lat, lon):
+def lat_lon_to_cq_zone(lat: float, lon: float) -> int | None:
     """Finds out which CQ zone a lat/lon point is in."""
 
     if DATA_STORE.cq_zone_data is not None:
@@ -36,7 +36,7 @@ def lat_lon_to_cq_zone(lat, lon):
     return None
 
 
-def lat_lon_to_itu_zone(lat, lon):
+def lat_lon_to_itu_zone(lat: float, lon: float) -> int | None:
     """Finds out which ITU zone a lat/lon point is in."""
 
     if DATA_STORE.itu_zone_data is not None:
@@ -58,7 +58,7 @@ def lat_lon_to_itu_zone(lat, lon):
     return None
 
 
-def lat_lon_for_grid_centre(grid):
+def lat_lon_for_grid_centre(grid: str) -> list[float] | None:
     """Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the centre point of the square.
     Returns None if the grid format is invalid."""
 
@@ -69,7 +69,7 @@ def lat_lon_for_grid_centre(grid):
         return None
 
 
-def lat_lon_for_grid_sw_corner(grid):
+def lat_lon_for_grid_sw_corner(grid: str) -> list[float] | None:
     """Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the southwest corner of the square.
     Returns None if the grid format is invalid."""
 
@@ -80,7 +80,7 @@ def lat_lon_for_grid_sw_corner(grid):
         return None
 
 
-def lat_lon_for_grid_ne_corner(grid):
+def lat_lon_for_grid_ne_corner(grid: str) -> list[float] | None:
     """Convert a Maidenhead grid reference of arbitrary precision to the lat/long of the northeast corner of the square.
     Returns None if the grid format is invalid."""
 
@@ -91,7 +91,9 @@ def lat_lon_for_grid_ne_corner(grid):
         return None
 
 
-def lat_lon_for_grid_sw_corner_plus_size(grid):
+def lat_lon_for_grid_sw_corner_plus_size(
+    grid: str,
+) -> tuple[float, float, float, float] | tuple[None, None, None, None]:
     """Convert a Maidenhead grid reference of arbitrary precision to lat/long, including in the result the size of the
     lowest grid square. This is a utility method used by the main methods that return the centre, southwest, and
     northeast coordinates of a grid square.
@@ -162,7 +164,7 @@ def lat_lon_for_grid_sw_corner_plus_size(grid):
     return lat, lon, lat_cell_size, lon_cell_size
 
 
-def wab_wai_square_to_lat_lon(ref):
+def wab_wai_square_to_lat_lon(ref: str) -> tuple[float, float] | None:
     """Convert a Worked All Britain or Worked All Ireland reference to a lat/lon point."""
 
     # First check we have a valid grid square, and based on what it looks like, use either the Ordnance Survey, Irish,
@@ -178,7 +180,7 @@ def wab_wai_square_to_lat_lon(ref):
         return None
 
 
-def os_grid_square_to_lat_lon(ref):
+def os_grid_square_to_lat_lon(ref: str) -> tuple[float, float]:
     """Get a lat/lon point for the centre of an Ordnance Survey grid square"""
 
     # Convert the letters into multipliers for the 500km squares and 100km squares
@@ -209,7 +211,7 @@ def os_grid_square_to_lat_lon(ref):
     return lat, lon
 
 
-def irish_grid_square_to_lat_lon(ref):
+def irish_grid_square_to_lat_lon(ref: str) -> tuple[float, float]:
     """Get a lat/lon point for the centre of an Irish Grid square."""
 
     # Convert the letters into multipliers for the 100km squares
@@ -237,7 +239,7 @@ def irish_grid_square_to_lat_lon(ref):
     return lat, lon
 
 
-def utm_grid_square_to_lat_lon(ref):
+def utm_grid_square_to_lat_lon(ref: str) -> tuple[float, float]:
     """Get a lat/lon point for the centre of a UTM grid square (supports only squares WA & WV for the Channel Islands, nothing else implemented)"""
 
     # Take the numeric parts of the grid square and multiply by 10000 to get metres from the corner of the letter-based grid square

core/live_data_cache.py

@@ -1,33 +1,37 @@
 import logging
 import threading
 import time
+from collections.abc import Callable
+from typing import Generic, TypeVar
 
 import diskcache
 from cachetools import TTLCache
 
 logger = logging.getLogger(__name__)
 
+VT = TypeVar("VT")
 
-class LiveDataCache:
+
+class LiveDataCache(Generic[VT]):
     """Cache for spots and alerts. Uses the fast in-memory TTLCache for normal data I/O, including the TTL to enforce
     maximum lifetime, and adds a separate diskcache to which we can save and load the TTLCache to provide persistence.
     Also adds thread safety so spots and alerts can come from any thread, and a listener mechanism so the web server
     can get a callback when new spots/alerts are added, and send them to any SSE clients."""
 
-    def __init__(self, maxsize, ttl, snapshot_dir, snapshot_interval_sec):
-        self._cache = TTLCache(maxsize=maxsize, ttl=ttl)
+    def __init__(self, maxsize: int, ttl: int, snapshot_dir: str, snapshot_interval_sec: int) -> None:
+        self._cache: TTLCache = TTLCache(maxsize=maxsize, ttl=ttl)
         self._lock = threading.Lock()
         self._ttl = ttl
-        self._listeners = []
+        self._listeners: list[Callable[[VT], None]] = []
         self._listeners_lock = threading.Lock()
         self._snapshot_dir = snapshot_dir
         self._disk_cache = diskcache.Cache(str(snapshot_dir))
         self._stop_event = threading.Event()
-        self._snapshot_thread = None
+        self._snapshot_thread: threading.Thread | None = None
         self._load_snapshot()
         self._start_periodic_snapshot(snapshot_interval_sec)
 
-    def set(self, key, value):
+    def set(self, key: str, value: VT) -> None:
         with self._lock:
             self._cache[key] = value
 
@@ -40,34 +44,34 @@ class LiveDataCache:
             except Exception:
                 logger.exception(f"Listener raised an exception for key {key}")
 
-    def get(self, key, default=None):
+    def get(self, key: str, default: VT | None = None) -> VT | None:
         with self._lock:
             return self._cache.get(key, default)
 
-    def delete(self, key):
+    def delete(self, key: str) -> None:
         with self._lock:
             self._cache.pop(key, None)
 
-    def keys(self):
+    def keys(self) -> list[str]:
         with self._lock:
             return list(self._cache.keys())
 
-    def values(self):
+    def values(self) -> list[VT]:
         with self._lock:
             return list(self._cache.values())
 
-    def add_listener(self, callback):
+    def add_listener(self, callback: Callable[[VT], None]) -> None:
         """Register callback(value) which will be called whenever a new spot/alert item is added via set(). Used by the
         web server (via SSEBroadcaster) to send SSE clients an update on every new spot."""
 
         with self._listeners_lock:
             self._listeners.append(callback)
 
-    def remove_listener(self, callback):
+    def remove_listener(self, callback: Callable[[VT], None]) -> None:
         with self._listeners_lock:
             self._listeners.remove(callback)
 
-    def save_snapshot(self):
+    def save_snapshot(self) -> None:
         with self._lock:
             # Store the time with the data so we can avoid loading anything nxt time that's older than TTL
             data = [(k, v, time.time()) for k, v in self._cache.items()]
@@ -76,9 +80,9 @@ class LiveDataCache:
         except Exception:
             logger.exception(f"Failed to write snapshot to {self._snapshot_dir}")
 
-    def _load_snapshot(self):
+    def _load_snapshot(self) -> None:
         try:
-            data = self._disk_cache.get("snapshot")
+            data: list[tuple[str, VT, float]] | None = self._disk_cache.get("snapshot")
         except Exception:  # noqa: BLE001 (If any exceptions we treat the data as junk and start from scratch, it's probably due to a version upgrade having incompatible data structures, fine to not log the exception in this case)
             logger.warning(f"Failed to load snapshot from {self._snapshot_dir}, clearing it.")
             self._disk_cache.clear()
@@ -94,8 +98,8 @@ class LiveDataCache:
                     self._cache[key] = value
         logger.info(f"Loaded snapshot from {self._snapshot_dir}")
 
-    def _start_periodic_snapshot(self, interval):
-        def loop():
+    def _start_periodic_snapshot(self, interval: int) -> None:
+        def loop() -> None:
             while not self._stop_event.wait(timeout=interval):
                 self.save_snapshot()
 
@@ -104,7 +108,7 @@ class LiveDataCache:
         )
         self._snapshot_thread.start()
 
-    def close(self):
+    def close(self) -> None:
         self._stop_event.set()
         if self._snapshot_thread:
             self._snapshot_thread.join(timeout=15)

core/prometheus_metrics_handler.py

@@ -25,7 +25,7 @@ memory_use_gauge = Gauge(
 )
 
 
-def get_metrics():
+def get_metrics() -> bytes:
     """Get a Prometheus metrics response for the web server"""
 
     return generate_latest(registry)

core/single_object_data_cache.py

@@ -1,18 +1,21 @@
 import logging
 import threading
+from typing import Generic, TypeVar
 
 import diskcache
 
 logger = logging.getLogger(__name__)
 
+T = TypeVar("T")
 
-class SingleObjectDataCache:
+
+class SingleObjectDataCache(Generic[T]):
     """Cache for status and solar conditions. This uses DiskCache, but unlike the standard DiskCache users like
     activity ref and callsign lookup handlers, status and solar conditions are persisted as a single object. If we
     just load the object from DiskCache and modify it, DiskCache doesn't know that it's been updated and needs
     re-caching, so we provide a store() method that any functions updating the object can call afterwards."""
 
-    def __init__(self, cache_dir, object_if_empty):
+    def __init__(self, cache_dir: str, object_if_empty: T) -> None:
         """Initialize a SingleObjectDataCache. Provide the directory to load the cache from and save it to. If the cache
         is empty, the provided object_if_empty parameter will be used to initialise it."""
 
@@ -22,24 +25,24 @@ class SingleObjectDataCache:
         if "object" not in self._cache:
             self._cache.add("object", object_if_empty)
         try:
-            self._obj = self._cache.get("object")
+            self._obj: T = self._cache.get("object")
         except Exception:  # noqa: BLE001 (If any exceptions we treat the data as junk and start from scratch, it's probably due to a version upgrade having incompatible data structures, fine to not log the exception in this case)
             logger.warning(f"Failed to load cache from {cache_dir}, clearing it.")
             self._cache.clear()
             self._cache.add("object", object_if_empty)
             self._obj = object_if_empty
 
-    def get(self):
+    def get(self) -> T:
         """Get the data object. This can then be manipulated as necessary across multiple threads. Any function
         modifying the object must remember to call store() afterwards."""
         return self._obj
 
-    def store(self):
+    def store(self) -> None:
         """Store the updated object in the cache. Any function modifying the object must remember to call this
         afterwards."""
         with self._lock:
             self._cache.set("object", self._obj)
 
-    def close(self):
+    def close(self) -> None:
         self.store()
         self._cache.close()

core/status_reporter.py

@@ -21,11 +21,11 @@ logger = logging.getLogger(__name__)
 class StatusReporter:
     """Provides a timed update of the application's status data."""
 
-    def __init__(self, run_interval):
+    def __init__(self, run_interval: float) -> None:
         """Constructor"""
 
         self._run_interval = run_interval
-        self._thread = None
+        self._thread: Thread | None = None
         self._stop_event = Event()
         self._startup_time = datetime.now(pytz.UTC)
 
@@ -33,13 +33,13 @@ class StatusReporter:
         DATA_STORE.status.get()["server_owner_callsign"] = SERVER_OWNER_CALLSIGN
         DATA_STORE.status.store()
 
-    def start(self):
+    def start(self) -> None:
         """Start the reporter thread"""
 
         self._thread = Thread(target=self._run, name="StatusReporter", daemon=True)
         self._thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown"""
 
         self._stop_event.set()
@@ -48,7 +48,7 @@ class StatusReporter:
             if self._thread.is_alive():
                 logger.warning("Status reporter worker thread did not exit on time and will be killed.")
 
-    def _run(self):
+    def _run(self) -> None:
         """Thread entry point: report immediately on startup, then on each interval until stopped"""
 
         while True:
@@ -56,7 +56,7 @@ class StatusReporter:
             if self._stop_event.wait(timeout=self._run_interval):
                 break
 
-    def _report(self):
+    def _report(self) -> None:
         """Write status information"""
 
         DATA_STORE.status.get()["uptime"] = (datetime.now(pytz.UTC) - self._startup_time).total_seconds()

core/url_data_cache.py

@@ -1,7 +1,8 @@
 import threading
 from datetime import timedelta
+from typing import Any
 
-from requests_cache import CachedSession
+from requests_cache import AnyResponse, CachedSession
 
 from core.data_store import CACHE_DIR
 
@@ -14,14 +15,14 @@ class URLDataCache(CachedSession):
     used across multiple threads, though note that URL lookups will block each other this way, so it is still better to
     create one of these objects per thread if possible."""
 
-    def __init__(self, name):
+    def __init__(self, name: str) -> None:
         super().__init__(
             f"{CACHE_DIR}urls/{name}",
             expire_after=timedelta(days=1),
             allowable_codes=(200, 400, 401, 403, 404),
         )
-        self._lock = threading.Lock()
+        self._get_lock = threading.Lock()
 
-    def get(self, *args, **kwargs):
-        with self._lock:
+    def get(self, *args: Any, **kwargs: Any) -> AnyResponse:
+        with self._get_lock:
             return super().get(*args, **kwargs)

core/utils.py

@@ -1,19 +1,22 @@
 import logging
 import re
+from typing import Any
 
 import simplejson
+from pyhamtools import Callinfo
 from pyhamtools.frequency import freq_to_band
 from pyhamtools.locator import latlong_to_locator
 
 from core.constants import BANDS, UNKNOWN_BAND
 from core.data_store import DATA_STORE
 from core.enums import MODE_ALIASES, Continent, Mode, ModeType
+from data.band import Band
 from data.callsign import Callsign, LocationSourceForCallsign
 
 logger = logging.getLogger(__name__)
 
 
-def safe_json_dumps(obj):
+def safe_json_dumps(obj: Any) -> str:
     """Safe version of json.dumps that also converts objects to dicts so they can be output, and ignores NaN floats
     which are invalid in JSON."""
 
@@ -59,7 +62,7 @@ def infer_mode_type_from_mode(mode: str) -> ModeType | None:
         return None
 
 
-def infer_band_from_freq(freq):
+def infer_band_from_freq(freq: float) -> Band:
     """Infer a band from a frequency in Hz"""
 
     for b in BANDS:
@@ -68,7 +71,7 @@ def infer_band_from_freq(freq):
     return UNKNOWN_BAND
 
 
-def infer_mode_from_frequency(freq):
+def infer_mode_from_frequency(freq: float) -> Mode | None:
     """Infer a mode from the frequency (in Hz) according to the band plan. Just a guess really."""
 
     try:
@@ -113,14 +116,14 @@ def infer_mode_from_frequency(freq):
         return None
 
 
-def get_flag_for_dxcc(dxcc):
+def get_flag_for_dxcc(dxcc: int) -> str | None:
     """Get an emoji flag for a given DXCC entity ID"""
 
     dxcc_data = DATA_STORE.dxcc_data.get(dxcc, None)
     return dxcc_data["flag"] if dxcc_data else None
 
 
-def get_callsign_object_from_pyhamtools_callinfo(callsign, callinfo):
+def get_callsign_object_from_pyhamtools_callinfo(callsign: str, callinfo: Callinfo) -> Callsign:
     """Utility function to take the data provided by a PyHamTools CallInfo object and populate our own Callsign data
     object from it"""
 

data/activities.py

@@ -20,7 +20,9 @@ ACTIVITIES: dict[ActivityName, Activity] = {
         sig_type=ActivityType.TRADITIONAL,
         has_refs=False,
         refs_globally_unique=False,
-        comment_names=["DXPEDITION"],
+        # DXpedition stations are never really spotted with "DXpedition" in the comments, but we can assign
+        # this activity to a spot other ways.
+        comment_names=[],
         icon="fa-book-atlas",
         alerts_possible=True,
     ),
@@ -28,12 +30,8 @@ ACTIVITIES: dict[ActivityName, Activity] = {
         name=ActivityName.SATELLITE,
         description="Amateur Radio Satellite",
         sig_type=ActivityType.TRADITIONAL,
-        # Satellite "references" are the names of the satellites themselves. This is not an exhaustive list, it just
-        # matches some of the most commonly used amateur radio satellites so they can be picked out of spot comments.
-        has_refs=True,
-        refs_globally_unique=True,
-        ref_type=ActivityRefType.SATELLITE,
-        ref_regex=r"ISS|AO-(?:7|27|73|91|95|123)|QO-100|QO100|QO 100|RS-44|SO-50",
+        has_refs=False,
+        refs_globally_unique=False,
         comment_names=[],
         icon="fa-satellite",
         alerts_possible=True,

data/alert.py

@@ -5,13 +5,14 @@ from dataclasses import dataclass, field
 from datetime import datetime, timedelta
 
 import pytz
-from pyhamtools.locator import locator_to_latlong, latlong_to_locator
 
 from core.activity_lookup_helper import populate_missing_activity_ref_info
 from core.activity_utils import get_icon_for_activity
 from core.call_lookup_helper import get_call_info
 from core.enums import Continent
 from core.utils import get_flag_for_dxcc
+from data.activity_ref import ActivityRef
+from data.lookup_credentials import LookupCredentials
 
 logger = logging.getLogger(__name__)
 
@@ -26,9 +27,9 @@ class Alert:
     # DX (alerting) operator info
 
     # Callsigns of the operators that has been alerted
-    dx_calls: list | None = None
+    dx_calls: list[str] | None = None
     # Names of the operators that has been alerted
-    dx_names: list | None = None
+    dx_names: list[str | None] | None = None
     # Country of the DX operator
     dx_country: str | None = None
     # Country flag of the DX operator
@@ -41,11 +42,6 @@ class Alert:
     dx_cq_zone: int | None = None
     # ITU zone of the DX operator
     dx_itu_zone: int | None = None
-    # Maidenhead grid locator for the DX. This could be from a geographical reference e.g. POTA or grid.
-    dx_grid: str | None = None
-    # Latitude & longitude of the DX, in degrees. This could be from a geographical reference e.g. POTA or grid.
-    dx_latitude: float | None = None
-    dx_longitude: float | None = None
 
     # General alert info
 
@@ -70,7 +66,7 @@ class Alert:
     sig: str | None = None
     # Activity references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO. Still named
     # "sig_refs" for API backwards compatibility.
-    sig_refs: list = field(default_factory=list)
+    sig_refs: list[ActivityRef] = field(default_factory=list)
 
     # Timing info
 
@@ -93,7 +89,7 @@ class Alert:
     # Icon to use when displaying this alert in the web UI. Chosen from the Font Awesome set.
     icon: str | None = None
 
-    def infer_missing(self, credentials=None):
+    def infer_missing(self, credentials: LookupCredentials | None = None) -> None:
         """Infer missing parameters where possible"""
 
         try:
@@ -114,7 +110,8 @@ class Alert:
             if self.received_time and not self.received_time_iso:
                 self.received_time_iso = datetime.fromtimestamp(self.received_time, pytz.UTC).isoformat()
 
-            # DX country, continent, zones etc. from callsign.
+            # DX country, continent, zones etc. from callsign. CQ/ITU zone are better looked up with a location but we don't
+            # have a real location for alerts.
             if self.dx_calls and self.dx_calls[0]:
                 call_info = get_call_info(self.dx_calls[0], credentials)
                 if self.dx_calls and self.dx_calls[0] and not self.dx_country:
@@ -130,41 +127,18 @@ class Alert:
                 if self.dx_dxcc_id and not self.dx_flag:
                     self.dx_flag = get_flag_for_dxcc(self.dx_dxcc_id)
 
-            # Fetch activity data, and set a real position if we can get one.
+            # Fetch activity data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a
+            # reference in its initial call, we use this code to populate the rest of the data. This includes working
+            # out grid refs from WAB and WAI, which count as an activity even though there's no real lookup, just maths
             if self.sig_refs:
                 for activity_ref in self.sig_refs:
-                    activity_ref = populate_missing_activity_ref_info(activity_ref)
-                    # If the alert itself doesn't have location yet, but the activity ref does, extract it
-                    if activity_ref.grid and not self.dx_grid:
-                        self.dx_grid = activity_ref.grid
-                    if (
-                        activity_ref.latitude
-                        and not self.dx_latitude
-                        and activity_ref.longitude
-                        and not self.dx_longitude
-                    ):
-                        self.dx_latitude = activity_ref.latitude
-                        self.dx_longitude = activity_ref.longitude
+                    populate_missing_activity_ref_info(activity_ref)
 
             # If the spot itself doesn't have an activity yet, but we have at least one activity reference, take that
             # reference's activity and apply it to the whole spot.
             if self.sig_refs and self.sig_refs[0] and not self.sig:
                 self.sig = self.sig_refs[0].sig
 
-            # DX Grid to lat/lon and vice versa in case one is missing
-            if self.dx_grid and (not self.dx_latitude or not self.dx_longitude):
-                try:
-                    ll = locator_to_latlong(self.dx_grid)
-                    self.dx_latitude = ll[0]
-                    self.dx_longitude = ll[1]
-                except Exception:
-                    logger.debug("Invalid grid received for spot", exc_info=True)
-            if self.dx_latitude and self.dx_longitude and not self.dx_grid:
-                try:
-                    self.dx_grid = latlong_to_locator(self.dx_latitude, self.dx_longitude, 8)
-                except Exception:
-                    logger.debug("Invalid lat/lon received for spot", exc_info=True)
-
             # Create an ID based on the source and source ID if possible, as these guaranee uniqueness. If there is no
             # source ID, use a combination of callsign and start time. Excluding things like the comment here allows for
             # user updates of their alert comments without duplicating in the system.
@@ -188,12 +162,12 @@ class Alert:
         except Exception:
             logger.exception("Exception while inferring missing data from spot")
 
-    def to_json(self):
+    def to_json(self) -> str:
         """JSON serialise"""
 
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True)
 
-    def expired(self):
+    def expired(self) -> bool:
         """Decide if this alert has expired (in which case it should not be added to the system in the first place, and not
         returned by the web server if later requested, and removed by the cleanup functions). "Expired" is defined as
         either having an end_time in the past, or if it only has a start_time, then that start time was more than 3 hours

data/callsign.py

@@ -40,7 +40,7 @@ class Callsign:
     # Location source
     location_source: LocationSourceForCallsign | None = None
 
-    def fully_populated(self):
+    def fully_populated(self) -> bool:
         """Utility method to indicate that the callsign data is fully populated. Multiple providers can return data for
         a callsign, and we try them in sequence until we have all the data we can, in which case there's no point
         querying any other providers."""

data/lookup_credentials.py

@@ -1,5 +1,7 @@
 from dataclasses import dataclass
 
+from tornado.httputil import HTTPHeaders
+
 
 @dataclass
 class LookupCredentials:
@@ -13,7 +15,7 @@ class LookupCredentials:
     hamqth_session_id: str = ""  # alternative to username/password
 
 
-def extract_credentials(headers):
+def extract_credentials(headers: HTTPHeaders) -> LookupCredentials | None:
     """Build a LookupCredentials from HTTP request headers; returns None if no usable credentials are present."""
     creds = LookupCredentials(
         qrz_username=headers.get("X-QRZ-Username", ""),

data/solar_conditions.py

@@ -1,5 +1,8 @@
 import json
 from dataclasses import dataclass
+from typing import Any, TypeVar
+
+T = TypeVar("T")
 
 # Lookup tables for derived text descriptions.
 # Each threshold-based table is a list of (min_value, description) pairs in descending order;
@@ -71,7 +74,7 @@ ELECTRON_FLUX_DESCRIPTIONS = [
 ]
 
 
-def _xray_blackout_scale(xray):
+def _xray_blackout_scale(xray: str | None) -> int:
     """Return the NOAA Radio Blackout scale number (R0-R5) for the given X-ray flux class string
     (e.g. "M4.5", "X12")."""
 
@@ -93,7 +96,7 @@ def _xray_blackout_scale(xray):
     return 0
 
 
-def _lookup_by_threshold(value, table, default=None):
+def _lookup_by_threshold(value: int | None, table: list[tuple[int, T]], default: T | None = None) -> T | None:
     """Return the description from a threshold table for the given numeric value.
     The table is a list of (min_value, description) pairs in descending order."""
 
@@ -150,20 +153,20 @@ class SolarConditions:
     # Geomagnetic background noise level, e.g. "S0", "S1", "S2"
     geomag_noise: str | None = None
     # HF band propagation conditions, keyed by "{band}-{time}" e.g. "80m-40m-day"
-    hf_conditions: dict | None = None
+    hf_conditions: dict[str, str] | None = None
     # VHF propagation conditions, keyed by condition name
-    vhf_conditions: dict | None = None
+    vhf_conditions: dict[str, str | None] | None = None
     # NOAA Kp index 3-day forecast, keyed by UNIX timestamp of the start of each 3-hour UTC period
-    k_index_forecast: dict | None = None
+    k_index_forecast: dict[float, float] | None = None
     # NOAA Solar Radiation Storm (S1 or greater) probability forecast, keyed by UNIX timestamp of start of day UTC
-    solar_storm_forecast: dict | None = None
+    solar_storm_forecast: dict[float, int] | None = None
     # NOAA Radio Blackout (R1-R2) probability forecast, keyed by UNIX timestamp of start of day UTC
-    blackout_forecast_r1r2: dict | None = None
+    blackout_forecast_r1r2: dict[float, int] | None = None
     # NOAA Radio Blackout (R3 or greater) probability forecast, keyed by UNIX timestamp of start of day UTC
-    blackout_forecast_r3_or_greater: dict | None = None
+    blackout_forecast_r3_or_greater: dict[float, int] | None = None
     # Ionosonde measurements, dict keyed by URSI code, values are dicts with keys: ursi, name, fof2, muf, luf,
     # band_states. Populated by GIROIonosonde or KC2GProp providers.
-    ionosonde_data: dict | None = None
+    ionosonde_data: dict[str, Any] | None = None
 
     # Derived values (populated by infer_descriptions())
     # HF radio blackout risk description, derived from xray
@@ -183,7 +186,7 @@ class SolarConditions:
     # Electron flux description, derived from electron_flux
     electron_flux_desc: str | None = None
 
-    def infer_descriptions(self):
+    def infer_descriptions(self) -> None:
         """Populate derived text description fields from the current numeric/raw field values."""
 
         if self.xray and len(self.xray) > 0:
@@ -196,7 +199,7 @@ class SolarConditions:
         self.band_conditions_desc = _lookup_by_threshold(self.sfi, BAND_CONDITIONS_DESCRIPTIONS)
         self.electron_flux_desc = _lookup_by_threshold(self.electron_flux, ELECTRON_FLUX_DESCRIPTIONS)
 
-    def to_json(self):
+    def to_json(self) -> str:
         """JSON serialise. Dict key order is insertion order (Python 3.7+ guarantee), so callers receive
         fields in a predictable, logical sequence without relying on sort_keys."""
 

data/spot.py

@@ -32,6 +32,7 @@ from core.utils import (
 )
 from data.activities import ACTIVITIES
 from data.activity_ref import ActivityRef
+from data.lookup_credentials import LookupCredentials
 
 logger = logging.getLogger(__name__)
 
@@ -129,7 +130,7 @@ class Spot:
     sig: str | None = None
     # Activity references. We allow multiple here for e.g. n-fer activations, unlike ADIF SIG_INFO. Still named
     # "sig_refs" for API backwards compatibility.
-    sig_refs: list = field(default_factory=list)
+    sig_refs: list[ActivityRef] = field(default_factory=list)
 
     # Timing info
 
@@ -156,7 +157,7 @@ class Spot:
     # Icon to use when displaying this spot in the web UI. Chosen from the Font Awesome set.
     icon: str | None = None
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         """Normalise fields that don't survive a plain dict to Spot conversion. This is used in the "add spot" API
         endpoint where the client is submitting JSON, and we want to recreate a full Spot object, including nested
         objects such as the sig_refs list.."""
@@ -167,7 +168,7 @@ class Spot:
                 for activity_ref in self.sig_refs
             ]
 
-    def infer_missing(self, credentials=None):
+    def infer_missing(self, credentials: LookupCredentials | None = None) -> None:
         """Infer missing parameters where possible"""
 
         try:
@@ -298,7 +299,7 @@ class Spot:
                     # Now look to see if that activity name was followed by something that looks like a reference ID
                     # for that activity. If so, add that to the sig_refs list for this spot.
                     found_activity_info = get_activity_by_name(found_activity)
-                    if found_activity_info and found_activity_info.has_refs and found_activity_info.ref_regex:
+                    if found_activity and found_activity_info and found_activity_info.has_refs and found_activity_info.ref_regex:
                         ref_matches = re.finditer(
                             r"(^|\W)" + found_activity + r"([ -])(" + found_activity_info.ref_regex + r")($|\W)",
                             self.comment,
@@ -313,19 +314,19 @@ class Spot:
             # name, but where the activity reference is unique-looking enough that we can't confuse it with any other
             # activity.
             if self.comment:
-                for activity in ACTIVITIES.values():
-                    if activity.has_refs and activity.refs_globally_unique and activity.ref_regex:
+                for candidate_activity in ACTIVITIES.values():
+                    if candidate_activity.has_refs and candidate_activity.refs_globally_unique and candidate_activity.ref_regex:
                         ref_matches = re.finditer(
-                            r"(^|\W)(" + activity.ref_regex + r")($|\W)", self.comment, re.IGNORECASE
+                            r"(^|\W)(" + candidate_activity.ref_regex + r")($|\W)", self.comment, re.IGNORECASE
                         )
                         for ref_match in ref_matches:
                             # First of all, if we haven't got an activity for this spot set yet, now we have. This
                             # covers things like cluster spots where the comment is just "OHFF-1234", now we know
                             # it's WWFF.
                             if not self.sig:
-                                self.sig = activity.name
+                                self.sig = candidate_activity.name
                             self._append_activity_ref_if_missing(
-                                ActivityRef(id=ref_match.group(2).upper(), sig=activity.name)
+                                ActivityRef(id=ref_match.group(2).upper(), sig=candidate_activity.name)
                             )
 
             # Fetch activity data. In case a particular API doesn't provide a full set of name, lat, lon & grid for a
@@ -472,12 +473,14 @@ class Spot:
                 self.dx_latitude = dx_call_info.latitude
                 self.dx_longitude = dx_call_info.longitude
                 self.dx_grid = dx_call_info.grid
-                self.dx_location_source = dx_call_info.location_source
+                self.dx_location_source = (
+                    LocationSourceForSpot(dx_call_info.location_source) if dx_call_info.location_source else None
+                )
 
             # Determine a "QTH" string. If we have an activity ref, pick the first one and turn it into a suitable
             # string, otherwise see what they have set on an online lookup service.
             if self.sig_refs:
-                qth = self.sig_refs[0].id
+                qth = self.sig_refs[0].id or ""
                 if self.sig_refs[0].name:
                     qth += f" {self.sig_refs[0].name}"
                 self.dx_qth = qth
@@ -498,8 +501,8 @@ class Spot:
 
             # DXCC lookup from callsign if nothing else has provided it
             if self.dx_call and not self.dx_dxcc_id:
-                for regex, entity_code in DATA_STORE.dxcc_lookup_by_call_regex:
-                    if regex.pattern and regex.match(self.dx_call):
+                for dxcc_regex, entity_code in DATA_STORE.dxcc_lookup_by_call_regex:
+                    if dxcc_regex.pattern and dxcc_regex.match(self.dx_call):
                         self.dx_dxcc_id = entity_code
                         break
             if self.dx_dxcc_id and not self.dx_flag:
@@ -538,15 +541,15 @@ class Spot:
         except Exception:
             logger.exception("Exception while inferring missing data from spot")
 
-    def to_json(self):
+    def to_json(self) -> str:
         """JSON serialise"""
 
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True)
 
-    def _append_activity_ref_if_missing(self, new_activity_ref):
+    def _append_activity_ref_if_missing(self, new_activity_ref: ActivityRef) -> None:
         """Append an activity ref to the list, so long as it's not already there."""
 
-        new_activity_ref.id = new_activity_ref.id.strip().upper()
+        new_activity_ref.id = (new_activity_ref.id or "").strip().upper()
         new_activity_ref.sig = new_activity_ref.sig.strip().upper()
         if new_activity_ref.id == "":
             return
@@ -555,7 +558,7 @@ class Spot:
                 return
         self.sig_refs.append(new_activity_ref)
 
-    def expired(self):
+    def expired(self) -> bool:
         """Decide if this spot has expired (in which case it should not be added to the system in the first place, and not
         returned by the web server if later requested, and removed by the cleanup functions). "Expired" is defined as
         either having a time further ago than the server's MAX_SPOT_AGE. If it somehow doesn't have a time either, it is

docs/clients.md

@@ -0,0 +1,39 @@
+## Writing your own client
+
+One of the key strengths of Spothole is that the API is well-defined and open to anyone to use. This means you can build
+your own software that uses data from Spothole.
+
+As well as the main API endpoints to fetch spots and alerts, with various possible query parameters, there are also
+Server-Sent Events (SSE) API endpoints to receive a live feed, plus various utility lookup endpoints for things like
+callsign and park data.
+
+Various approaches exist to writing your own client, but in general:
+
+* Refer to the API docs. These are built on an OpenAPI definition file (`/static/apidocs/openapi.yml`), which you can
+  automatically use to generate a client skeleton using various software.
+* Call the main "spots" or "alerts" API endpoints to get the data you want. For example, your app could call
+  `https://spothole.app/api/v2/spots` once every few minutes. Apply filters if necessary.
+* Call the "options" API to get an idea of which bands, modes etc. the server knows about. You might want to do that
+  first before calling the spots/alerts APIs, to allow you to populate your filters correctly.
+* Refer to the provided HTML/JS interface for a reference on different approaches. For example, the "alerts"/"upcoming"
+  page simply query the main spot API on a timer, whereas the spots, map and bands pages combine this approach with
+  using the Server-Sent Events (SSE) endpoint to update live.
+* Let me know if you get stuck, I'm happy to help.
+
+Please don't hammer the API with an unnecessarily high request rate. For example, Spothole only queries the POTA API
+once every two minutes, so if your client is interested in POTA data there's no need to poll Spothole any more often
+than that.
+
+If you absolutely must be informed within seconds of a spot arriving in Spothole, please use the SSE endpoints instead,
+e.g. `https://spothole.app/api/v2/spots/stream`.
+
+If you want to handle different types of spot or alert differently within your client, please consider making a single
+request to the Spothole API to retrieve all the data, then filtering on your side. For example, call
+`https://spothole.app/api/v2/spots?sig=POTA,SOTA` rather than making two separate calls to
+`https://spothole.app/api/v2/spots?sig=POTA` and `https://spothole.app/api/v2/spots?sig=SOTA`.
+
+Remember, here at Spothole Inc. we offer an industry-standard "five nines" uptime on our server, with our own unique
+twist: we don't tell you which side of the decimal point the nines start! (Translation: This is a hobby project.
+`spothole.app` runs on the same server as my blog and other stuff. It might go down without warning. By all means base
+your own project on data from the main server if you like, but if you want any control over reliability and downtime,
+please run your own copy instead.)

docs/docker.md

@@ -1,11 +1,11 @@
-{% extends "../help_page.html" %}
-{% block help_content %}
+## Running using Docker
 
-<h2 class="mt-4 mb-4">Running using Docker</h2>
-<p>Spothole comes with a Docker configuration to make it easy to run it in a containerised environment. To set it up
-    using Docker, the easiest way is to use a Docker Compose file. Create a new directory such as <code>/opt/docker/spothole</code>
-    and create a <code>compose.yaml</code> file inside it with the following contents:</p>
-<pre><code>services:
+Spothole comes with a Docker configuration to make it easy to run it in a containerised environment. To set it up using
+Docker, the easiest way is to use a Docker Compose file. Create a new directory such as `/opt/docker/spothole` and
+create a `compose.yaml` file inside it with the following contents:
+
+```yaml
+services:
   spothole:
     container_name: spothole
     build:
@@ -17,29 +17,34 @@
     volumes:
       - ./config.yml:/app/config.yml
       - ./cache:/app/cache
-</code></pre>
-<p>You can replace <code>#main</code> with any other branch or tag reference, for example <code>#1.5</code> to pin the
-    build to tagged version 1.5.</p>
-<p>Save the file. You will still need to create a copy of <code>config-example.yml</code> and name it
-    <code>config.yml</code>, though with the Docker setup nothing has actually been downloaded yet, so you will have to
-    copy the example from the repository some other way, e.g. <a
-            href="https://git.ianrenton.com/ian/spothole/src/branch/main/config-example.yml">from the repo in a web
-        browser</a>.</p>
-<p>With that in place, run <code>docker compose up</code> and you should be good to go. To detach, press <code>d</code>
-    or run the command with the <code>-d</code> flag.</p>
+```
 
-<h3 class="mt-4">nginx Reverse Proxy with Docker</h3>
-<p>In a containerised setup, it's typical to run an nginx reverse proxy in one container, alongside certbot for renewal
-    of HTTPS certificates, and then applications like Spothole in a separate container. In this case, there are a couple
-    of variations of the docker compose file above, and the nginx reverse proxy configuration covered <a
-            href="/help/usage/nginx">here</a>, that you will want to make.</p>
-<ol>
-    <li>A port mapping is no longer required in the docker compose file; nginx will access into the docker container
-        directly on e.g. <code>http://spothole:8080</code></li>
-    <li>Spothole and nginx will need to be on the same docker network.</li>
-</ol>
-<p>So your <code>compose.yaml</code> might look like this:</p>
-<pre><code>services:
+You can replace `#main` with any other branch or tag reference, for example `#1.5` to pin the build to tagged version
+1.5.
+
+Save the file. You will still need to create a copy of `config-example.yml` and name it `config.yml`, though with the
+Docker setup nothing has actually been downloaded yet, so you will have to copy the example from the repository some
+other way,
+e.g. [from the repo in a web browser](https://git.ianrenton.com/ian/spothole/src/branch/main/config-example.yml).
+
+With that in place, run `docker compose up` and you should be good to go. To detach, press `d` or run the command with
+the `-d` flag.
+
+### nginx Reverse Proxy with Docker
+
+In a containerised setup, it's typical to run an nginx reverse proxy in one container, alongside certbot for renewal of
+HTTPS certificates, and then applications like Spothole in a separate container. In this case, there are a couple of
+variations of the docker compose file above, and the nginx reverse proxy configuration covered [here](./nginx.md), that
+you will want to make.
+
+1. A port mapping is no longer required in the docker compose file; nginx will access into the docker container directly
+   on e.g. `http://spothole:8080`
+2. Spothole and nginx will need to be on the same docker network.
+
+So your `compose.yaml` might look like this:
+
+```yaml
+services:
   spothole:
     container_name: spothole
     build:
@@ -54,11 +59,14 @@
 networks:
   docker-network:
     external: true
-</code></pre>
-<p>In your nginx site configuration, you'll want to refer to the Spothole container directly, and drop the block that
-    allows nginx to access static files directly, as these will be inaccessible in another container. So you may end up
-    with something like:</p>
-<pre><code>server {
+```
+
+In your nginx site configuration, you'll want to refer to the Spothole container directly, and drop the block that
+allows nginx to access static files directly, as these will be inaccessible in another container. So you may end up with
+something like:
+
+```nginx
+server {
     server_name spothole.app;
 
     # Global proxy settings
@@ -66,7 +74,7 @@ networks:
     proxy_set_header Connection "";
     proxy_connect_timeout 10s;
     proxy_buffering on;
-
+    
     # Pass on IP address and host information to Spothole, in case logging this information is required
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -77,11 +85,11 @@ networks:
     location /.well-known/acme-challenge/ {
         root /var/www/certbot;
     }
-
+    
     # SSE endpoints
     location ~ ^/api/v\d*/(spots|alerts)/stream/? {
         proxy_pass http://spothole:8080;
-
+        
         # Remove buffering, remove caching, add suitable timeouts for SSE API calls
         proxy_buffering off;
         proxy_cache off;
@@ -89,22 +97,22 @@ networks:
         proxy_send_timeout 24h;
         proxy_set_header X-Accel-Buffering no;
         add_header Cache-Control no-store always;
-
+        
         # Allow cross-origin requests to API
         proxy_hide_header Access-Control-Allow-Origin;
-        add_header Access-Control-Allow-Origin * always;
+        add_header Access-Control-Allow-Origin * always; 
     }
 
     # Other API endpoints
     location /api/ {
         proxy_pass http://spothole:8080;
-
+        
         # Remove buffering, remove caching, add suitable timeouts for API calls
         proxy_buffering off;
         proxy_cache off;
         proxy_read_timeout 30s;
         add_header Cache-Control no-store always;
-
+        
         # Allow cross-origin requests to API
         proxy_hide_header Access-Control-Allow-Origin;
         add_header Access-Control-Allow-Origin * always;
@@ -116,7 +124,7 @@ networks:
         proxy_read_timeout 30s;
         add_header Cache-Control "no-cache, must-revalidate" always;
     }
-
+    
     listen 443 ssl;
     listen [::]:443 ssl;
 
@@ -137,16 +145,19 @@ server {
     listen [::]:80;
     return 404;
 }
-</code></pre>
-<p>If desired, you could even change the port on which Spothole runs from 8080 to a plain 80, in which case your
-    <code>proxy_pass</code> statements could drop the <code>:8080</code> suffix. Since Spothole is in a container, it
-    can serve HTTP on port 80 if desired, because it doesn't conflict with the host system.</p>
+```
 
-<h3 class="mt-4">Restoring the static files bypass</h3>
-<p>If you would still like to bypass Spothole's web server for the static files, and serve them with nginx, you can do.
-    The easiest way is to run another nginx container to serve the files, so your Spothole <code>compose.yaml</code>
-    becomes:</p>
-<pre><code>services:
+If desired, you could even change the port on which Spothole runs from 8080 to a plain 80, in which case your
+`proxy_pass` statements could drop the `:8080` suffix. Since Spothole is in a container, it can serve HTTP on port 80 if
+desired, because it doesn't conflict with the host system.
+
+### Restoring the static files bypass
+
+If you would still like to bypass Spothole's web server for the static files, and serve them with nginx, you can do. The
+easiest way is to run another nginx container to serve the files, so your Spothole `compose.yaml` becomes:
+
+```yaml
+services:
   spothole:
     container_name: spothole
     build:
@@ -172,15 +183,16 @@ server {
 networks:
   docker-network:
     external: true
-</code></pre>
-<p>Then you can re-add the block that handles the <code>/static</code> path in your nginx reverse proxy config, but this
-    time point it at the new container rather than at a filesystem path:</p>
-<pre><code>    # Load static assets from the spothole-static-nginx container
+```
+
+Then you can re-add the block that handles the `/static` path in your nginx reverse proxy config, but this time point it
+at the new container rather than at a filesystem path:
+
+```nginx
+    # Load static assets from the spothole-static-nginx container
     location /static/ {
         proxy_pass http://spothole-static-nginx/;
         expires 1h;
         add_header Cache-Control "public, max-age=3600, must-revalidate";
     }
-</code></pre>
-
-{% end %}
+```

docs/embedding.md

@@ -0,0 +1,41 @@
+## Embedding Spothole in another website
+
+You can embed Spothole's web interface in another website, e.g. for use as part of a ham radio custom dashboard.
+
+URL parameters can be used to trigger an "embedded" mode which hides the headers, footers and settings. In this mode,
+you provide configuration for the various filter and display options via additional URL parameters. Any settings that
+the user has set for Spothole are ignored. This is so that the embedding site can select, for example, their choice of
+dark mode or activity filters, which will not impact how Spothole appears when the user accesses it directly. Effectively, it
+becomes separate to their normal Spothole settings.
+
+Setting `embedded` to true is important for the rest of the settings to be applied; otherwise, the user's defaults will
+be used in preference to the URL params.
+
+These are supplied with the URL to the page you want to embed, for example for an embedded version of the band map in
+dark mode, use `https://spothole.app/bands?embedded=true&dark-mode=true`. For an embedded version of the main spots/home
+page in the system light/dark mode, use `https://spothole.app/?embedded=true`. For dark mode showing 70cm TOTA spots
+only, use `https://spothole.app/?embedded=true&dark-mode=true&sig=TOTA&band=70cm`. Providing no URL params causes the
+page to be loaded in the normal way it would when accessed directly in the user's browser.
+
+The supported parameters are as follows. Generally these match the equivalent parameters in the real Spothole API, where
+a mapping exists.
+
+| Name             | Allowed Values          | Default | Example                 | Description                                                                                                                                                           |
+|------------------|-------------------------|---------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `embedded`       | `true`, `false`         | `false` | `?embedded=true`        | Enables embedded mode.                                                                                                                                                |
+| `color_scheme`   | `light`, `dark`, `auto` | `auto`  | `?color_scheme=dark`    | Forces light or dark mode in preference to the operating system default.                                                                                              |
+| `time_zone`      | `UTC`, `local`          | `UTC`   | `?time_zone=local`      | Sets times to be in UTC or local time.                                                                                                                                |
+| `limit`          | 10, 25, 50, 100         | 50      | `?limit=50`             | Sets the number of spots that will be displayed on the main spots page                                                                                                |
+| `limit`          | 25, 50, 100, 200, 500   | 100     | `?limit=100`            | Sets the number of alerts that will be displayed on the alerts page                                                                                                   |
+| `max_age`        | 300, 600, 1800, 3600    | 1800    | `?max_age=1800`         | Sets the maximum age of spots displayed on the map and bands pages, in seconds.                                                                                       |
+| `band`           | Comma-separated list    | (all)   | `?band=20m,40m`         | Sets the list of bands that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.         |
+| `sig`            | Comma-separated list    | (all)   | `?sig=POTA,SOTA,NO_SIG` | Sets the list of activities that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.    |
+| `source`         | Comma-separated list    | (all)   | `?source=Cluster`       | Sets the list of sources that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.              |
+| `mode_type`      | Comma-separated list    | (all)   | `?mode_type=PHONE,CW`   | Sets the list of mode types that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface.    |
+| `dx_continent`   | Comma-separated list    | (all)   | `?dx_continent=NA,SA`   | Sets the list of DX Continents that will be shown on any spot or alert pages. Available options match the labels of the buttons in the standard web interface.        |
+| `de_continent`   | Comma-separated list    | (all)   | `?de_continent=EU`      | Sets the list of DE Continents that will be shown on the spots, bands and map pages. Available options match the labels of the buttons in the standard web interface. |
+| `map-center-lat` | Numeric (decimal)       | (auto)  | `?map-center-lat=51.5`  | Sets the initial latitude of the map centre on the map page. If omitted, the map auto-fits to the loaded spots.                                                       |
+| `map-center-lon` | Numeric (decimal)       | (auto)  | `?map-center-lon=-0.1`  | Sets the initial longitude of the map centre on the map page. If omitted, the map auto-fits to the loaded spots.                                                      |
+| `map-zoom`       | Numeric (integer)       | (auto)  | `?map-zoom=6`           | Sets the initial zoom level of the map on the map page. If omitted, the map auto-fits to the loaded spots.                                                            |
+
+See the comment at the end of the next section regarding reliability and uptime of the "main" server.

docs/modifying.md

@@ -0,0 +1,79 @@
+## Modifying the source code
+
+Spothole is Public Domain licenced, so you can grab the source code and start modifying it for your own needs.
+Contributions of code back to the main repository are encouraged, but completely optional.
+
+### Code structure
+
+To navigate your way around the source code, this list may help.
+
+*Python back-end code*
+
+* `/core` - Core classes and utilities
+* `/data` - Data storage classes
+* `/providers/spot` - Classes providing spots by accessing the APIs of other services
+* `/providers/alert` - Classes providing alerts by accessing the APIs of other services
+* `/providers/solarconditions` - Classes providing solar and propagation by accessing the APIs of other services
+* `/providers/staticdata` - Classes providing static lookup data by accessing bundled data files or the APIs of other
+  services
+* `/providers/callsign` - Classes providing callsign lookup data by accessing bundled data files or the APIs of other
+  services
+* `/providers/activityrefdata` - Classes providing activity reference lookup data by accessing bundled data files or
+  the APIs of other services
+* `/webserver` - Classes for running Spothole's own web server
+* `/telnetserver` - Classes for running Spothole's telnet server
+* `spothole.py` - Main application script
+
+*Templates*
+
+* `/templates` - Templates used for constructing Spothole's user-targeted HTML pages
+
+*HTML/JS/CSS front-end code*
+
+* `/static` - Root for static files served by the web server. These are all served from a path starting `/static/`.
+* `/static/apidocs` - Contains the OpenAPI spec (`openapi.yml`)
+* `/static/audio` - Audio files used by the web front-end
+* `/static/css` - CSS files used by the web front-end
+* `/static/img` - image files used by the web front-end
+* `/static/js` - JavaScript used by the web front-end
+* `/static/vendor` - Third-party libraries (CSS, JS, fonts and images)
+
+*Miscellaneous*
+
+* `/` - pip `requirements.txt`, config, README, etc.
+* `/docs` - Documentation
+* `/images` - Image sources
+* `/datafiles` - Local data files, used by some providers when the data will never change and/or is not easily available
+  online in a format Spothole can handle
+* `/cache` - Directory where Spothole stores all the data it uses that should be persisted to disk. Created on first
+  run.
+
+### Extending the server
+
+Spothole is designed to be easily extensible. If you want to write your own spot provider, for example, simply add a
+module to the `providers.spot` package containing your class. (Currently, in order to be loaded correctly, the module
+(file) name should be the same as the class name, but lower case.)
+
+Your class should extend "SpotProvider"; if it operates by polling an HTTP Server on a timer, it can instead extend "
+HTTPSpotProvider" where some of the work is done for you.
+
+The class will need to implement a constructor that takes in the `provider_config` and provides it to the superclass
+constructor, while also taking any other config parameters it needs.
+
+If you're extending the base `SpotProvider` class, you will need to implement `start()` and `stop()` methods that start
+and stop a separate thread which handles the provider's processing needs. The thread should call `submit()` or
+`submit_batch()` when it has one or more spots to report.
+
+If you're extending the `HTTPSpotProvider` class, you will need to provide a URI to query and an interval to the
+superclass constructor. You'll then need to implement the `http_response_to_spots()` method which is called when new
+data is retrieved. Your implementation should then call `submit()` or `submit_batch()` when it has one or more spots to
+report.
+
+When constructing spots, use the comments in the Spot class and the existing implementations as an example. All
+parameters are optional, but you will at least want to provide a `time` (which must be timezone-aware) and a `dx_call`.
+
+Finally, simply add the appropriate config to the `spot_providers` section of `config.yml`, and your provider should be
+instantiated on startup.
+
+The same approach as above is also used for alerts, and other types of providers. Give me a shout if you need any
+advice.

docs/multicluster.md

@@ -0,0 +1,96 @@
+## Multiple cluster nodes with different settings
+
+Dan, S50U has written in with his Spothole cluster settings. He is using a cluster node which provides RBN spots, and
+uses different SSIDs on his callsign to get different settings when logged into the same cluster node. For example:
+
+```
+  -
+    class: "DXCluster"
+    name: "S50CLX"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-10"
+```
+
+Telnet to DXSpider and log in with "callsign-10" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`SET/DX` (enable human DX spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN CW"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-11"
+    allow_rbn_spots: true
+    enabled_by_default_in_web_ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-11" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER CW` (enable CW RBN spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN RTTY"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-12"
+    allow_rbn_spots: true
+    enabled_by_default_in_web_ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-12" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER RTTY` (enable RTTY RBN spots)
+
+```
+  -
+    class: "DXCluster"
+    name: "RBN FT4/8"
+    enabled: true
+    host: "s50clx.si"
+    port: 41112
+    login_prompt: "login: "
+    login_callsign: "callsign-13"
+    allow_rbn_spots: true
+    enabled_by_default_in_web_ui: false
+```
+
+Telnet to DXSpider and log in with "callsign-13" and execute the following commands:
+
+`CLEAR/SPOTS ALL` (delete all previous filters)<br/>
+`UNSET/ANN` (stop announce messages)<br/>
+`UNSET/WCY` (stop wcy messages)<br/>
+`UNSET/WWV` (stop wwv messages)<br/>
+`UNSET/DX` (stop human DX spots)<br/>
+`SET/SKIMMER FT` (enable FT RBN spots)
+
+For each callsign-SSID, we also specify our basic information with commands:
+
+`SET/NAME Spothole10`, Spothole11... etc.<br/>
+`SET/QTH Cerkno`<br/>
+`SET/QRA JN66XD`<br/>
+`SET/HOME S50CLX`

docs/nginx.md

@@ -0,0 +1,118 @@
+## nginx Reverse Proxy configuration
+
+Web servers generally serve their pages from port 80. However, it's best not to serve Spothole's web interface directly
+on port 80, as that requires root privileges on a Linux system. It also and prevents us using HTTPS to serve a secure
+site, since Spothole itself doesn't directly support acting as an HTTPS server. The normal solution to this is to use a
+"reverse proxy" setup, where a general web server handles HTTP and HTTP requests (to port 80 & 443 respectively), then
+passes on the request to the back-end application (in this case Spothole). nginx is a common choice for this general web
+server.
+
+To set up nginx as a reverse proxy that sits in front of Spothole, first ensure it's installed e.g.
+`sudo apt install nginx`, and enabled e.g. `sudo systemd enable nginx`.
+
+Create a file at `/etc/nginx/sites-available/` called `spothole`. Give it the following contents, replacing
+`spothole.app` with the domain name on which you want to run Spothole. If you changed the port on which Spothole runs,
+update that on the "proxy_pass" line, and if you installed Spothole somewhere other than `/home/spothole/spothole`,
+adjust the alias location for serving static files.
+
+(The latter section, configuring the nginx server to serve static files directly, improves efficiency because it saves
+Spothole itself from serving JS, CSS etc. files. If you can't do this for some reason, e.g. your nginx and spothole are
+on different computers, you can omit the `location /static/ {}` block.)
+
+```nginx
+server {
+    server_name spothole.app;
+
+    # Global proxy settings
+    proxy_http_version 1.1;
+    proxy_set_header Connection "";
+    proxy_connect_timeout 10s;
+    proxy_buffering on;
+    
+    # Pass on IP address and host information to Spothole, in case logging this information is required
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_set_header X-Forwarded-Proto $scheme;
+
+    # Wellknown area for Lets Encrypt
+    location /.well-known/ {
+        alias /var/www/html/.well-known/;
+    }
+
+    # Load static assets directly from the Spothole static directory
+    location /static/ {
+        alias /home/spothole/spothole/static/;
+        expires 1h;
+        add_header Cache-Control "public, max-age=3600, must-revalidate";
+    }
+    
+    # SSE endpoints
+    location ~ ^/api/v\d*/(spots|alerts)/stream/? {
+        proxy_pass http://127.0.0.1:8080;
+        
+        # Remove buffering, remove caching, add suitable timeouts for SSE API calls
+        proxy_buffering off;
+        proxy_cache off;
+        proxy_read_timeout 24h;
+        proxy_send_timeout 24h;
+        proxy_set_header X-Accel-Buffering no;
+        add_header Cache-Control no-store always;
+        
+        # Allow cross-origin requests to API
+        proxy_hide_header Access-Control-Allow-Origin;
+        add_header Access-Control-Allow-Origin * always; 
+    }
+
+    # Other API endpoints
+    location /api/ {
+        proxy_pass http://127.0.0.1:8080;
+        
+        # Remove buffering, remove caching, add suitable timeouts for API calls
+        proxy_buffering off;
+        proxy_cache off;
+        proxy_read_timeout 30s;
+        add_header Cache-Control no-store always;
+        
+        # Allow cross-origin requests to API
+        proxy_hide_header Access-Control-Allow-Origin;
+        add_header Access-Control-Allow-Origin * always;
+    }
+
+    # Templated pages
+    location / {
+        proxy_pass http://127.0.0.1:8080;
+        proxy_read_timeout 30s;
+        add_header Cache-Control "no-cache, must-revalidate" always;
+    }
+}
+```
+
+One further change you might want to make to the file above is the `add_header Access-Control-Allow-Origin` statements.
+These are what's used on my own Spothole server to make sure that other third-party web-based software can get the data
+from my instance, and applies to any endpoint underneath `/api`. If you want *your* Spothole instance to be set up the
+same way, so that others can write software in JavaScript that can access it, leave this intact. But if you want your
+Spothole instance to only be usable by scripts running on the web server you write, you can remove these lines. (Note
+that this doesn't stop other people writing *non-web-based* software that accesses your Spothole API—the
+enforcement of cross-origin headers only happens within the user's browser. If you need to lock your instance down so
+that no-one else can access it with *any* software, that's an aspect of nginx or firewall config that you will need to
+find help with elsewhere.)
+
+Now, make a symbolic link to enable the site:
+
+```bash
+cd /etc/nginx/sites-enabled
+sudo ln -sf ../sites-available/spothole
+```
+
+Test that your nginx config isn't broken using `nginx -t`. If it works, restart nginx with
+`sudo systemctl restart nginx`.
+
+If you haven't already done so, set up a DNS entry to make sure requests for your domain name end up at the server
+that's running Spothole.
+
+You should now be able to access the web interface by going to the domain from your browser.
+
+Once that's working, [install certbot](https://certbot.eff.org/instructions?ws=nginx&os=snap) onto your server. Run it
+as root, and when prompted pick your domain name from the list. After a few seconds, it should successfully provision a
+certificate and modify your nginx config files automatically. You should then be able to access the site via HTTPS.

docs/running.md

@@ -0,0 +1,54 @@
+## Running your own copy
+
+If you want to run a copy of Spothole with different configuration settings than the main instance, you can download it
+and run it on your own local machine or server.
+
+You will require Python version 3.10 or later. If you encounter an error about `gdal-config` during the following
+process, you will also need `libgdal-dev` installed.
+
+To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be
+similar.
+
+```bash
+git clone ssh://git@git.ianrenton.com/ian/spothole.git
+cd spothole
+python3 -m venv ./.venv
+source .venv/bin/activate
+pip install -r requirements.txt
+deactivate
+cp config-example.yml config.yml
+```
+
+Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve
+enabling or disabling the various providers of spot and alert data.
+
+By default, all outdoor programme providers are enabled, as is one cluster node and the NG3K DXpedition data. The RBN
+spot providers are turned off by default due to the volume of traffic from CW/RTTY/FT8 skimmers, and the APRS and Packet
+spot providers are off by default on the assumption that Spothole users want a spot with a human at the other end of it,
+but all can be easily re-enabled.
+
+Other parameters you will want to update include the base URL to your instance, and whether you want to serve a full
+web-based DX cluster interface or just the API endpoints for client software to use.
+
+`config.yml` has an entry for a Clublog API key. If provided, this will allow Spothole to retrieve some more information
+about DX spots. The software will work just fine without it, but you may find a few country flags etc. are less accurate
+or missing. Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining
+what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you
+change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your
+server too.
+
+Once you're happy with the content of `config.yml`, you can proceed to running the software.
+
+To run the software this time and any future times you want to run it directly from the command line:
+
+```bash
+source .venv/bin/activate
+python3 spothole.py
+```
+
+The software can take a few seconds to start up, particularly if it's been run previously and has a large amount of
+cache data to sort through. This is normal, don't panic! Once you see `You can access your copy of Spothole at
+http://localhost:8080` in the log, your server is good to go.
+
+If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server
+that is already in use by something else.

docs/systemd.md

@@ -0,0 +1,34 @@
+## systemd configuration
+
+If you want Spothole to run automatically on startup on a Linux distribution that uses `systemd`, follow the
+instructions here. For distros that don't use `systemd`, or Windows/OSX/etc., you can find generic instructions for your
+OS online.
+
+Create a file at `/etc/systemd/system/spothole.service`. Give it the following content, adjusting for the user you want
+to run it as and the directory in which you have installed it:
+
+```
+[Unit]
+Description=Spothole
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=spothole
+WorkingDirectory=/home/spothole/spothole
+ExecStart=/home/spothole/spothole/.venv/bin/python /home/spothole/spothole/spothole.py --serve-in-foreground
+Restart=on-abort
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Run the following:
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable spothole
+sudo systemctl start spothole
+```
+
+Check the service has started up correctly with `sudo journalctl -u spothole -f`.

providers/activityrefdata/activity_ref_data_provider.py

@@ -1,10 +1,12 @@
 import logging
 from datetime import datetime
 from threading import Event
+from typing import Any
 
 import pytz
 
 from core.data_store import DATA_STORE
+from data.activity_ref import ActivityRef
 
 logger = logging.getLogger(__name__)
 
@@ -13,29 +15,29 @@ class ActivityRefDataProvider:
     """Generic activity reference data provider class. Subclasses of this query the individual URLs or files for
     data."""
 
-    def __init__(self, sig_name, provider_config):
+    def __init__(self, sig_name: str, provider_config: dict[str, Any]) -> None:
         """Constructor. Note the parameter and attribute are still named "sig_name" for consistency with the API's
         "sig" field name."""
 
         self.sig_name = sig_name
-        self.enabled = provider_config["enabled"]
-        self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
-        self.status = "Not Started" if self.enabled else "Disabled"
-        self.reference_count = 0
+        self.enabled: bool = provider_config["enabled"]
+        self.last_update_time: datetime = datetime.min.replace(tzinfo=pytz.UTC)
+        self.status: str = "Not Started" if self.enabled else "Disabled"
+        self.reference_count: int = 0
         self._stop_event = Event()
 
-    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 stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown. Subclasses should implement this method and call
         super()."""
 
         self._stop_event.set()
 
-    def _add_data(self, new_data):
+    def _add_data(self, new_data: list[ActivityRef]) -> None:
         """Add all the provided reference data objects to the data store."""
 
         # with transact() batches all writes together to save making thousands of individual sqlite writes. However,

providers/activityrefdata/arlhs.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class ARLHS(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.ARLHS
     DATA_URL = "https://www.gma.rocks/download/lighthouse.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()[1:]):
             if "ARLHS" in row and row["ARLHS"] != "":
                 ref_id = row["ARLHS"]

providers/activityrefdata/cota.py

@@ -1,5 +1,7 @@
 from time import sleep
+from typing import Any
 
+import requests
 from pyhamtools.locator import latlong_to_locator
 
 from core.enums import ActivityName, ActivityRefType
@@ -14,11 +16,11 @@ class COTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.COTA
     DATA_URL = "https://www.cotagroup.org/cotagroup/map/data/castles-all-7d90ee2a5e1175e5dece1bbf9dc87504.json"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         data = http_response.json()
         if isinstance(data, list):
             for ref in data[2]:

providers/activityrefdata/dce.py

@@ -1,7 +1,9 @@
 import io
 from time import sleep
+from typing import Any
 
 import pandas as pd
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +17,11 @@ class DCE(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.DCE
     DATA_URL = "https://www.acracb.org/dce/descargas/General/directorio_referencias_dce.xls"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
 
         file_stream = io.BytesIO(http_response.content)
         df = pd.read_excel(file_stream, engine="xlrd", header=None)

providers/activityrefdata/defe.py

@@ -1,7 +1,9 @@
 import io
 from time import sleep
+from typing import Any
 
 import pandas as pd
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +17,11 @@ class DEFE(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.DEFE
     DATA_URL = "https://www.acracb.org/defe/descargas/General/directorio_referencias_defe.xls"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
 
         file_stream = io.BytesIO(http_response.content)
         df = pd.read_excel(file_stream, engine="xlrd", header=None)

providers/activityrefdata/dme.py

@@ -1,5 +1,6 @@
 import csv
 from time import sleep
+from typing import Any
 
 from pyhamtools.locator import latlong_to_locator
 
@@ -16,11 +17,11 @@ class DME(LocalFileActivityRefDataProvider):
     ACTIVITY = ActivityName.DME
     PATH = "datafiles/MUNICIPIOS.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.PATH)
 
-    def _file_to_data(self, path):
-        new_data = []
+    def _file_to_data(self, path: str) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         with open(path, encoding="latin-1") as _f:
             for row in csv.DictReader(_f, delimiter=";"):
                 # Store reference IDs with the "DME-" prefix rather than just the number. This will prevent Spothole

providers/activityrefdata/dmue.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -13,11 +16,11 @@ class DMUE(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.DMUE
     DATA_URL = "https://dmue.radiogalena.es/nom_dmue.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
 
         for row in csv.reader(http_response.content.decode("utf-8-sig").splitlines(), delimiter=";"):
             if len(row) > 1 and row[0] and row[1]:

providers/activityrefdata/dmve.py

@@ -1,7 +1,9 @@
 import io
 from time import sleep
+from typing import Any
 
 import pandas as pd
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +17,11 @@ class DMVE(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.DMVE
     DATA_URL = "https://www.acracb.org/dmve/descargas/General/directorio_referencias_dmve.xls"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
 
         file_stream = io.BytesIO(http_response.content)
         # Despide the .xls extension this is actually an xlsx file, so we need openpyxl not xlrd

providers/activityrefdata/dtmba.py

@@ -1,4 +1,7 @@
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -12,11 +15,11 @@ class DTMBA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.DTMBA
     DATA_URL = "https://www.iu1fig.com/share/iz0eik/dtmba/export.php"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in http_response.content.decode("utf-8-sig").splitlines():
             split = row.split(";")
             ref_id = split[0]

providers/activityrefdata/fea.py

@@ -1,7 +1,9 @@
 from io import BytesIO
 from time import sleep
+from typing import Any
 
 import pdfplumber
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +17,11 @@ class FEA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.FEA
     DATA_URL = "http://ea5ol.net/Lista%20Faros.pdf"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
 
         # Use PDFPlumber to extract the tables in the PDF
         with pdfplumber.open(BytesIO(http_response.content)) as pdf:

providers/activityrefdata/file_download_activity_ref_data_provider.py

@@ -1,12 +1,15 @@
 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 +19,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 +79,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."""

providers/activityrefdata/gma.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class GMA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.GMA
     DATA_URL = "https://www.gma.rocks/download/summits.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()[1:]):
             ref_id = row["Reference"]
             new_data.append(

providers/activityrefdata/illw.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class ILLW(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.ILLW
     DATA_URL = "https://www.gma.rocks/download/lighthouse.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()[1:]):
             if "ILLW" in row and row["ILLW"] != "":
                 ref_id = row["ILLW"]

providers/activityrefdata/iota.py

@@ -1,6 +1,8 @@
 import logging
 from time import sleep
+from typing import Any
 
+import requests
 from pyhamtools.locator import latlong_to_locator
 
 from core.enums import ActivityName, ActivityRefType
@@ -19,11 +21,11 @@ class IOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.IOTA
     DATA_URL = "https://www.iota-world.org/islands-on-the-air/downloads/download-file.html?path=groups.json"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         data = http_response.json()
         if isinstance(data, list):
             for ref in data:

providers/activityrefdata/krmnpa.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from core.enums import ActivityName
 from providers.activityrefdata.pnp_kml_activity_ref_data_provider import (
     ParksNPeaksKMLActivityRefDataProvider,
@@ -11,5 +13,5 @@ class KRMNPA(ParksNPeaksKMLActivityRefDataProvider):
     ACTIVITY = ActivityName.KRMNPA
     DATA_URL = "https://parksnpeaks.org/getPOI.php?poiClass=KRMNPA&poiFormat=4"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)

providers/activityrefdata/llota.py

@@ -1,5 +1,7 @@
 from time import sleep
+from typing import Any
 
+import requests
 from pyhamtools.locator import locator_to_latlong
 
 from core.enums import ActivityName, ActivityRefType
@@ -16,11 +18,11 @@ class LLOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.LLOTA
     DATA_URL = "https://llota.app/api/public/references"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         data = http_response.json()
         if isinstance(data, list):
             for ref in data:

providers/activityrefdata/local_file_activity_ref_data_provider.py

@@ -1,8 +1,10 @@
 import logging
 from datetime import datetime
+from typing import Any
 
 import pytz
 
+from data.activity_ref import ActivityRef
 from providers.activityrefdata.activity_ref_data_provider import ActivityRefDataProvider
 
 logger = logging.getLogger(__name__)
@@ -11,11 +13,11 @@ logger = logging.getLogger(__name__)
 class LocalFileActivityRefDataProvider(ActivityRefDataProvider):
     """Generic activity ref data provider class for providers that fetch their data from a local file on startup."""
 
-    def __init__(self, sig_name, provider_config, path):
+    def __init__(self, sig_name: str, provider_config: dict[str, Any], path: str) -> None:
         super().__init__(sig_name, provider_config)
         self._path = path
 
-    def start(self):
+    def start(self) -> None:
         logger.debug(f"Loading {self.sig_name} activity ref data from file.")
         try:
             new_data = self._file_to_data(self._path)
@@ -30,7 +32,7 @@ class LocalFileActivityRefDataProvider(ActivityRefDataProvider):
             self.status = "Error"
             logger.exception(f"Exception in local file Activity Ref Data Provider ({self.sig_name})")
 
-    def _file_to_data(self, path):
+    def _file_to_data(self, path: str) -> list[ActivityRef]:
         """Load a file on the given path and turn it into activity ref data."""
 
         raise NotImplementedError("Subclasses must implement this method")

providers/activityrefdata/mota.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class MOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.MOTA
     DATA_URL = "https://www.gma.rocks/download/mills.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()[1:]):
             ref_id = row["Reference"]
             new_data.append(

providers/activityrefdata/pga.py

@@ -1,5 +1,7 @@
 from time import sleep
+from typing import Any
 
+import requests
 from bs4 import BeautifulSoup
 
 from core.enums import ActivityName, ActivityRefType
@@ -14,11 +16,11 @@ class PGA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.PGA
     DATA_URL = "http://www.spga.pl/lista_pga2.php"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         soup = BeautifulSoup(http_response.text, "html.parser")
 
         # Iterate through tables in the page

providers/activityrefdata/pnp_kml_activity_ref_data_provider.py

@@ -1,7 +1,12 @@
 import re
 from time import sleep
+from typing import Any
 
+import requests
 from fastkml import kml
+from fastkml.containers import Document, Folder
+from fastkml.features import Placemark
+from fastkml.geometry import Point
 from pyhamtools.locator import latlong_to_locator
 
 from core.enums import ActivityRefType
@@ -17,20 +22,26 @@ class ParksNPeaksKMLActivityRefDataProvider(FileDownloadActivityRefDataProvider)
 
     REF_PATTERN = re.compile(r"VKFF-\d+")
 
-    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, url, poll_interval)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
 
-        k = kml.KML.from_string(http_response.content)
+        # KML content may carry an XML encoding declaration, which lxml's parser (used internally here) refuses to
+        # accept as a decoded str, so bytes must be passed even though the type stub only declares str.
+        k = kml.KML.from_string(http_response.content)  # type: ignore[arg-type]
 
         for document in k.features:
-            # noinspection unresolved-references
+            if not isinstance(document, Document):
+                continue
             for folder in document.features:
-                # noinspection unresolved-references
+                if not isinstance(folder, Folder):
+                    continue
                 for placemark in folder.features:
+                    if not isinstance(placemark, Placemark):
+                        continue
                     description = placemark.description or ""
                     match = self.REF_PATTERN.search(description)
                     if not match:
@@ -38,6 +49,9 @@ class ParksNPeaksKMLActivityRefDataProvider(FileDownloadActivityRefDataProvider)
                         continue
                     ref_id = match.group(0)
 
+                    if not isinstance(placemark.geometry, Point):
+                        # Not a point location (e.g. a boundary polygon) - skip it, we can't get a single lat/lon from it
+                        continue
                     longitude, latitude = placemark.geometry.x, placemark.geometry.y
 
                     ref = ActivityRef(

providers/activityrefdata/pota.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class POTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.POTA
     DATA_URL = "https://pota.app/all_parks_ext.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()):
             ref_id = row["reference"]
             new_data.append(

providers/activityrefdata/sanpcpa.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from core.enums import ActivityName
 from providers.activityrefdata.pnp_kml_activity_ref_data_provider import (
     ParksNPeaksKMLActivityRefDataProvider,
@@ -11,5 +13,5 @@ class SANPCPA(ParksNPeaksKMLActivityRefDataProvider):
     ACTIVITY = ActivityName.SANPCPA
     DATA_URL = "https://parksnpeaks.org/getPOI.php?poiClass=SANPCPA&poiFormat=4"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)

providers/activityrefdata/siota.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class SIOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.SIOTA
     DATA_URL = "https://www.silosontheair.com/data/silos.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()):
             ref_id = row["SILO_CODE"]
             new_data.append(

providers/activityrefdata/sota.py

@@ -1,6 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
 
+import requests
 from pyhamtools.locator import latlong_to_locator
 
 from core.enums import ActivityName, ActivityRefType
@@ -17,11 +19,11 @@ class SOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.SOTA
     DATA_URL = "https://storage.sota.org.uk/summitslist.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()[1:]):
             ref_id = row["SummitCode"]
             latitude = float(row["Latitude"]) if "Latitude" in row and row["Latitude"] != "" else None

providers/activityrefdata/toilets.py

@@ -1,4 +1,5 @@
 import csv
+from typing import Any
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -13,11 +14,11 @@ class Toilets(LocalFileActivityRefDataProvider):
     ACTIVITY = ActivityName.TOILETS
     PATH = "datafiles/toilets.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.PATH)
 
-    def _file_to_data(self, path):
-        new_data = []
+    def _file_to_data(self, path: str) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         with open(path) as _f:
             csv_data = _f.read()
             dr = csv.DictReader(csv_data.splitlines())

providers/activityrefdata/towers.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class Towers(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.TOWERS
     DATA_URL = "https://wwtota.com/servis/generate_csv.php?ref=&filter=all"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines(), delimiter=";"):
             ref_id = row["Ref"]
             new_data.append(

providers/activityrefdata/wca.py

@@ -1,7 +1,9 @@
 import csv
 import logging
 from time import sleep
+from typing import Any
 
+import requests
 from pyhamtools.locator import latlong_to_locator
 
 from core.enums import ActivityName, ActivityRefType
@@ -20,11 +22,11 @@ class WCA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.WCA
     DATA_URL = "https://polo.ham2k.com/data/activities/wca/all-castles.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()):
             ref_id = row["REF"]
 

providers/activityrefdata/wota.py

@@ -1,4 +1,7 @@
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -14,11 +17,11 @@ class WOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.WOTA
     DATA_URL = "https://www.wota.org.uk/mapping/data/summits.json"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for feature in http_response.json().get("features", []):
             ref_id = feature["properties"]["wotaId"]
             # Fudge WOTA URLs. Outlying fell (LDO) URLs don't match their ID numbers but require 214 to be

providers/activityrefdata/wwbota.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class WWBOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.WWBOTA
     DATA_URL = "https://api.wwbota.org/bunkers/?format=CSV"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()):
             ref_id = row["Reference"]
             new_data.append(

providers/activityrefdata/wwff.py

@@ -1,5 +1,8 @@
 import csv
 from time import sleep
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType
 from data.activity_ref import ActivityRef
@@ -15,11 +18,11 @@ class WWFF(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.WWFF
     DATA_URL = "https://wwff.co/wwff-data/wwff_directory.csv"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         for row in csv.DictReader(http_response.content.decode("utf-8-sig").splitlines()):
             ref_id = row["reference"]
             new_data.append(

providers/activityrefdata/zlota.py

@@ -1,5 +1,7 @@
 from time import sleep
+from typing import Any
 
+import requests
 from pyhamtools.locator import latlong_to_locator
 
 from core.enums import ActivityName, ActivityRefType
@@ -16,11 +18,11 @@ class ZLOTA(FileDownloadActivityRefDataProvider):
     ACTIVITY = ActivityName.ZLOTA
     DATA_URL = "https://ontheair.nz/assets/assets.json"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(self.ACTIVITY, provider_config, self.DATA_URL, self.POLL_INTERVAL_DAYS)
 
-    def _http_response_to_data(self, http_response):
-        new_data = []
+    def _http_response_to_data(self, http_response: requests.Response) -> list[ActivityRef]:
+        new_data: list[ActivityRef] = []
         data = http_response.json()
         if isinstance(data, list):
             for ref in data:

providers/alert/alert_provider.py

@@ -1,28 +1,31 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
 
 from core.data_store import DATA_STORE
+from core.live_data_cache import LiveDataCache
+from data.alert import Alert
 
 
 class AlertProvider:
     """Generic alert provider class. Subclasses of this query the individual APIs for alerts."""
 
-    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.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"
-        self._alerts = DATA_STORE.alerts
+        self._alerts: LiveDataCache[Alert] = DATA_STORE.alerts
 
-    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, alerts):
+    def _submit_batch(self, alerts: list[Alert]) -> None:
         """Submit a batch of alerts retrieved from the provider. There is no timestamp checking like there is for spots,
         because alerts could be created at any point for any time in the future. Rely on hashcode-based id matching
         to deal with duplicates."""
@@ -35,11 +38,12 @@ class AlertProvider:
             alert.infer_missing()
             self._add_alert(alert)
 
-    def _add_alert(self, alert):
+    def _add_alert(self, alert: Alert) -> None:
+        assert alert.id is not None, "infer_missing() always assigns an id"
         if not alert.expired():
             self._alerts.set(alert.id, alert)
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown"""
 
         raise NotImplementedError("Subclasses must implement this method")

providers/alert/bota.py

@@ -1,6 +1,8 @@
 from datetime import datetime, timedelta
+from typing import Any
 
 import pytz
+import requests
 from bs4 import BeautifulSoup
 
 from core.enums import ActivityName
@@ -15,10 +17,10 @@ class BOTA(HTTPAlertProvider):
     POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://www.beachesontheair.com/"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("BOTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         # Find the table of upcoming alerts
         bs = BeautifulSoup(http_response.content.decode("utf-8-sig"), features="lxml")

providers/alert/hamsat.py

@@ -1,6 +1,8 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
+import requests
 
 from core.enums import ActivityName
 from data.activity_ref import ActivityRef
@@ -14,28 +16,25 @@ class Hamsat(HTTPAlertProvider):
     POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://hams.at/api/alerts"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("Hamsat", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json()["data"]:
             # Convert to our alert format
-            freqs_modes = source_alert.get("mode") or ""
-            mhz = source_alert.get("mhz")
-            if mhz is not None:
-                mhz_direction = source_alert.get("mhz_direction")
-                if mhz_direction is not None:
-                    freqs_modes = f"{mhz!s} {mhz_direction}, {freqs_modes}"
+            freqs_modes = source_alert.get("mode", "")
+            if "mhz" in source_alert:
+                if "mhz_direction" in source_alert:
+                    freqs_modes = f"{source_alert['mhz']!s} {source_alert['mhz_direction']}, {freqs_modes}"
                 else:
-                    freqs_modes = f"{mhz!s}, {freqs_modes}"
+                    freqs_modes = f"{source_alert['mhz']!s}, {freqs_modes}"
 
             alert = Alert(
                 source=self.name,
                 source_id=source_alert["id"],
                 dx_calls=[source_alert["callsign"].upper()],
-                dx_grid=source_alert["grids"][0],
                 freqs_modes=freqs_modes,
                 comment=source_alert["comment"],
                 sig=ActivityName.SATELLITE,
@@ -43,7 +42,7 @@ class Hamsat(HTTPAlertProvider):
                 sig_refs=[
                     ActivityRef(
                         sig=ActivityName.SATELLITE,
-                        id=source_alert["satellite"]["name"],
+                        id=f"{source_alert['satellite']['name']} from {source_alert['grids'][0]}",
                     )
                 ],
                 start_time=datetime.strptime(source_alert["aos_at"], "%Y-%m-%dT%H:%M:%SZ")

providers/alert/http_alert_provider.py

@@ -1,12 +1,14 @@
 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 +18,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 +80,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."""

providers/alert/ical_alert_provider.py

@@ -1,7 +1,8 @@
-from datetime import datetime, time
-from typing import cast
+from datetime import date, datetime, time
+from typing import Any, cast
 
 import pytz
+import requests
 from icalendar import Calendar, Event
 
 from data.alert import Alert
@@ -12,10 +13,10 @@ class ICALAlertProvider(HTTPAlertProvider):
     """Generic alert provider for iCal calendars. Defines an abstract method event_to_alert(event) that subclasses must
     implement, and use it to convert an iCal event to an Alert object based on whatever format their iCal events use."""
 
-    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, url, poll_interval)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         cal = Calendar.from_ical(http_response.content)
 
@@ -34,7 +35,7 @@ class ICALAlertProvider(HTTPAlertProvider):
         """Convert an ICal event to an Alert object. Subclasses must implement this method."""
 
     @staticmethod
-    def _to_utc_timestamp(value):
+    def _to_utc_timestamp(value: datetime | date) -> float:
         """Convert a date or datetime value from an iCal field into a UTC UNIX timestamp."""
 
         # Datetime object so we can treat it as-is, check if it has a non-UTC tz and convert it if necessary

providers/alert/ng3k.py

@@ -1,8 +1,9 @@
 import re
 from datetime import datetime
-from typing import cast
+from typing import Any, cast
 
 import pytz
+import requests
 from rss_parser import Parser
 from rss_parser.models.rss import RSS
 
@@ -18,10 +19,10 @@ class NG3K(HTTPAlertProvider):
     ALERTS_URL = "https://www.ng3k.com/adxo.xml"
     AS_CALL_PATTERN = re.compile("as ([a-z0-9/]+)", re.IGNORECASE)
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("NG3K", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_DAYS * 24 * 60 * 60)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         rss = cast(RSS, Parser.parse(http_response.content.decode("utf-8-sig")))
         # Iterate through source data

providers/alert/parksnpeaks.py

@@ -1,7 +1,9 @@
 import logging
 from datetime import datetime
+from typing import Any
 
 import pytz
+import requests
 
 from core.enums import ActivityName
 from data.activity_ref import ActivityRef
@@ -17,10 +19,10 @@ class ParksNPeaks(HTTPAlertProvider):
     POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://parksnpeaks.org/api/ALERTS/"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("ParksNPeaks", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():

providers/alert/pota.py

@@ -1,6 +1,8 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
+import requests
 
 from core.enums import ActivityName
 from data.activity_ref import ActivityRef
@@ -14,10 +16,10 @@ class POTA(HTTPAlertProvider):
     POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://api.pota.app/activation"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("POTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():

providers/alert/rsgb_ical_alert_provider.py

@@ -1,4 +1,5 @@
 import re
+from typing import Any
 
 from icalendar import Event
 
@@ -12,7 +13,7 @@ class RSGBICALAlertProvider(ICALAlertProvider):
     handling specific to how RSGB's iCal events are formatted. This is still effectively an abstract class itself;
     RSGB has two contest calendars (HF & VHF) that each subclass this."""
 
-    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, url, poll_interval)
 
     FREQ_PATTERN = re.compile(r"([\d.]+(?:MHz|GHz))|SHF")

providers/alert/rsgbhfcontests.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from providers.alert.rsgb_ical_alert_provider import RSGBICALAlertProvider
 
 
@@ -7,5 +9,5 @@ class RSGBHFContests(RSGBICALAlertProvider):
     POLL_INTERVAL_DAYS = 30
     ALERTS_URL = "https://calendar.google.com/calendar/ical/a5ff31ebb1b4834dc7fff4c5415ae8251c6a9aa11f98c6af6e472b6c552b1915%40group.calendar.google.com/public/basic.ics"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("RSGB HF Contests", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_DAYS * 24 * 60 * 60)

providers/alert/rsgbvhfcontests.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from providers.alert.rsgb_ical_alert_provider import RSGBICALAlertProvider
 
 
@@ -7,5 +9,5 @@ class RSGBVHFContests(RSGBICALAlertProvider):
     POLL_INTERVAL_DAYS = 30
     ALERTS_URL = "https://calendar.google.com/calendar/ical/40f3552bff39a016f1cdca205864177070dcad68d55be17eb061cb021f39f96c%40group.calendar.google.com/public/basic.ics"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("RSGB VHF Contests", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_DAYS * 24 * 60 * 60)

providers/alert/sota.py

@@ -1,6 +1,8 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
+import requests
 
 from core.enums import ActivityName
 from data.activity_ref import ActivityRef
@@ -14,10 +16,10 @@ class SOTA(HTTPAlertProvider):
     POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://api-db2.sota.org.uk/api/alerts/365/all/all"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("SOTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():

providers/alert/wa7bnm.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from icalendar import Event
 
 from core.enums import ActivityName
@@ -11,7 +13,7 @@ class WA7BNM(ICALAlertProvider):
     POLL_INTERVAL_DAYS = 1
     ALERTS_URL = "https://contestcalendar.com/weeklycontcustom.php"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(
             "WA7BNM Contest Calendar", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_DAYS * 24 * 60 * 60
         )

providers/alert/wota.py

@@ -1,9 +1,10 @@
 import logging
 from datetime import datetime
-from typing import cast
+from typing import Any, cast
 from xml.parsers.expat import ExpatError
 
 import pytz
+import requests
 from rss_parser import Parser as RSSParser
 from rss_parser.models.rss import RSS
 
@@ -22,10 +23,10 @@ class WOTA(HTTPAlertProvider):
     ALERTS_URL = "https://www.wota.org.uk/alerts_rss.php"
     RSS_DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S %z"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("WOTA", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
 
         try:

providers/alert/wwff.py

@@ -1,6 +1,8 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
+import requests
 
 from core.enums import ActivityName
 from data.activity_ref import ActivityRef
@@ -14,10 +16,10 @@ class WWFF(HTTPAlertProvider):
     POLL_INTERVAL_SEC = 1800
     ALERTS_URL = "https://spots.wwff.co/static/agendas.json"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("WWFF", provider_config, self.ALERTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_alerts(self, http_response):
+    def _http_response_to_alerts(self, http_response: requests.Response) -> list[Alert]:
         new_alerts = []
         # Iterate through source data
         for source_alert in http_response.json():

providers/callsigndata/api_query_callsign_data_provider.py

@@ -1,18 +1,22 @@
+from typing import Any
+
+import diskcache
+
 from providers.callsigndata.callsign_data_provider import CallsignDataProvider
 
 
 class APIQueryCallsignDataProvider(CallsignDataProvider):
     """Generic callsign data provider class for providers that fetch their data from the web on-demand using an API."""
 
-    def __init__(self, name, provider_config, storage):
+    def __init__(self, name: str, provider_config: dict[str, Any], storage: diskcache.Cache) -> None:
         """Set up the provider."""
         super().__init__(name, provider_config, storage)
 
         if self.enabled:
             self.status = "Ready"
 
-    def start(self):
+    def start(self) -> None:
         pass
 
-    def stop(self):
+    def stop(self) -> None:
         pass

providers/callsigndata/callsign_data_provider.py

@@ -1,15 +1,19 @@
 from datetime import datetime
+from typing import Any
 
+import diskcache
 import pytz
 
 from core.data_store import DATA_STORE
+from data.callsign import Callsign
+from data.lookup_credentials import LookupCredentials
 
 
 class CallsignDataProvider:
     """Generic callsign reference data provider class. Subclasses of this set up the various mechanisms via which
     Spothole can look up data for callsigns."""
 
-    def __init__(self, name, provider_config, storage):
+    def __init__(self, name: str, provider_config: dict[str, Any], storage: diskcache.Cache) -> None:
         """Constructor. As well as name and config, provide the storage object from DATA_STORE that will be used to
         store the result of lookups to speed up future access."""
 
@@ -21,18 +25,18 @@ class CallsignDataProvider:
         self.lookup_count = 0
         self._storage = storage
 
-    def start(self):
+    def start(self) -> None:
         """Start the provider. This should return immediately after spawning threads to access remote resources, if
         needed."""
 
         raise NotImplementedError("Subclasses must implement this method")
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown"""
 
         raise NotImplementedError("Subclasses must implement this method")
 
-    def lookup(self, callsign, lookup_credentials):
+    def lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         """Looks up data for the provided callsign. Takes a LookupCredentials object, which provides any credentials
         that have been provided by the user for this session (QRZ.com/HamQTH) to allow us to look up using those
         services on the user's behalf. (Clublog is looked up using an API key owned by the server and provided in its
@@ -57,7 +61,7 @@ class CallsignDataProvider:
         else:
             return None
 
-    def _perform_new_lookup(self, callsign, lookup_credentials):
+    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         """Makes a new request to the data source for callsign data."""
 
         raise NotImplementedError("Subclasses must implement this method")

providers/callsigndata/clublogapi.py

@@ -1,5 +1,6 @@
 import logging
 from datetime import datetime
+from typing import Any
 
 import pytz
 from pyhamtools import Callinfo, LookupLib
@@ -7,6 +8,7 @@ from pyhamtools import Callinfo, LookupLib
 from core.data_store import DATA_STORE
 from core.utils import get_callsign_object_from_pyhamtools_callinfo
 from data.callsign import Callsign
+from data.lookup_credentials import LookupCredentials
 from providers.callsigndata.api_query_callsign_data_provider import (
     APIQueryCallsignDataProvider,
 )
@@ -17,9 +19,9 @@ logger = logging.getLogger(__name__)
 class ClublogAPI(APIQueryCallsignDataProvider):
     """Callsign data provider for Clublog's API."""
 
-    _callinfo = None
+    _callinfo: Callinfo | None = None
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         # API key required for this provider
         self._api_key = provider_config.get("api_key", "")
         if self._api_key != "":
@@ -33,7 +35,7 @@ class ClublogAPI(APIQueryCallsignDataProvider):
 
         super().__init__("Clublog API", provider_config, DATA_STORE.callsign_data_clublogapi)
 
-    def _perform_new_lookup(self, callsign, lookup_credentials):
+    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         callsign_data = Callsign(call=callsign)
 
         try:

providers/callsigndata/clublogxml.py

@@ -1,11 +1,13 @@
 import gzip
 import logging
+from typing import Any
 
 from pyhamtools import Callinfo, LookupLib
 
 from core.data_store import DATA_STORE
 from core.utils import get_callsign_object_from_pyhamtools_callinfo
 from data.callsign import Callsign
+from data.lookup_credentials import LookupCredentials
 from providers.callsigndata.file_download_callsign_data_provider import (
     FileDownloadCallsignDataProvider,
 )
@@ -20,9 +22,9 @@ class ClublogXML(FileDownloadCallsignDataProvider):
     DATA_URL = "https://cdn.clublog.org/cty.php"
     CACHE_PATH_ZIPPED = "cache/cty.xml.gz"
     CACHE_PATH_UNZIPPED = "cache/cty.xml"
-    _callinfo = None
+    _callinfo: Callinfo | None = None
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         # API key required for this provider
         self._api_key = provider_config.get("api_key", "")
         if self._api_key == "":
@@ -40,7 +42,7 @@ class ClublogXML(FileDownloadCallsignDataProvider):
             DATA_STORE.callsign_data_clublogxml,
         )
 
-    def _handle_file(self, path):
+    def _handle_file(self, path: str) -> bool:
         try:
             # The download from Clublog is gzipped so we need to uncompress that and re-save as a separate file that
             # the LookupLib can actually use.
@@ -60,7 +62,7 @@ class ClublogXML(FileDownloadCallsignDataProvider):
             logger.exception("Exception when loading Clublog XML.")
             return False
 
-    def _perform_new_lookup(self, callsign, lookup_credentials):
+    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         callsign_data = Callsign(call=callsign)
 
         try:

providers/callsigndata/countryfiles.py

@@ -1,10 +1,12 @@
 import logging
+from typing import Any
 
 from pyhamtools import Callinfo, LookupLib
 
 from core.data_store import DATA_STORE
 from core.utils import get_callsign_object_from_pyhamtools_callinfo
 from data.callsign import Callsign
+from data.lookup_credentials import LookupCredentials
 from providers.callsigndata.file_download_callsign_data_provider import (
     FileDownloadCallsignDataProvider,
 )
@@ -18,9 +20,9 @@ class CountryFiles(FileDownloadCallsignDataProvider):
     POLL_INTERVAL_DAYS = 30
     DATA_URL = "https://www.country-files.com/cty/cty.plist"
     CACHE_PATH = "cache/cty.plist"
-    _callinfo = None
+    _callinfo: Callinfo | None = None
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__(
             "CountryFiles.com",
             provider_config,
@@ -30,7 +32,7 @@ class CountryFiles(FileDownloadCallsignDataProvider):
             DATA_STORE.callsign_data_countryfiles,
         )
 
-    def _handle_file(self, path):
+    def _handle_file(self, path: str) -> bool:
         try:
             lookuplib = LookupLib(lookuptype="countryfile", filename=path)
             self._callinfo = Callinfo(lookuplib)
@@ -40,7 +42,7 @@ class CountryFiles(FileDownloadCallsignDataProvider):
             logger.exception("Exception when loading Country Files cty.plist.")
             return False
 
-    def _perform_new_lookup(self, callsign, lookup_credentials):
+    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         callsign_data = Callsign(call=callsign)
 
         try:

providers/callsigndata/file_download_callsign_data_provider.py

@@ -1,7 +1,9 @@
 import logging
 from datetime import datetime
 from threading import Event, Thread
+from typing import Any
 
+import diskcache
 import pytz
 from requests.exceptions import ConnectionError, ConnectTimeout, ReadTimeout
 
@@ -15,40 +17,48 @@ logger = logging.getLogger(__name__)
 class FileDownloadCallsignDataProvider(CallsignDataProvider):
     """Generic callsign data provider class for providers that fetch their data from the web by downloading a file."""
 
-    def __init__(self, name, provider_config, url, cache_file_path, poll_interval, storage):
+    def __init__(
+        self,
+        name: str,
+        provider_config: dict[str, Any],
+        url: str,
+        cache_file_path: str,
+        poll_interval: int,
+        storage: diskcache.Cache,
+    ) -> None:
         """Set up the provider, note poll_interval is in *days*."""
         super().__init__(name, provider_config, storage)
         self._url = url
         self._cache_file_path = cache_file_path
         self._poll_interval = poll_interval
-        self._thread = None
+        self._thread: Thread | None = None
         self._stop_event = Event()
         self._url_data_cache = URLDataCache(f"callsigndata_{name}")
 
         if self.enabled:
             self.status = "Ready"
 
-    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} callsign reference data every {self._poll_interval!s} days.")
         self._thread = Thread(target=self._run, name=f"FileDownloadCallsignDataProvider-{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} callsign 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 the file. 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.
@@ -87,7 +97,7 @@ class FileDownloadCallsignDataProvider(CallsignDataProvider):
             logger.exception(f"Exception in callsign reference data provider ({self.name})")
             self._stop_event.wait(timeout=1)
 
-    def _handle_file(self, path):
+    def _handle_file(self, path: str) -> bool:
         """Handle an updated file downloaded from the server. Return true if successful, false otherwise."""
 
         raise NotImplementedError("Subclasses must implement this method")

providers/callsigndata/hamqth.py

@@ -1,7 +1,7 @@
 import logging
 import urllib.parse
 from datetime import datetime, timedelta
-from xml.parsers.expat import ExpatError
+from typing import Any
 
 import pytz
 import xmltodict
@@ -15,6 +15,7 @@ from core.data_store import CACHE_DIR, DATA_STORE
 from core.enums import Continent
 from core.url_data_cache import URLDataCache
 from data.callsign import Callsign, LocationSourceForCallsign
+from data.lookup_credentials import LookupCredentials
 from providers.callsigndata.api_query_callsign_data_provider import (
     APIQueryCallsignDataProvider,
 )
@@ -25,7 +26,7 @@ logger = logging.getLogger(__name__)
 class HamQTH(APIQueryCallsignDataProvider):
     """Callsign data provider for HamQTH."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("HamQTH", provider_config, DATA_STORE.callsign_data_hamqth)
         self._HAMQTH_BASE_URL = "https://www.hamqth.com/xml.php"
         self._PRG = f"Spothole v{SOFTWARE_VERSION} operated by {SERVER_OWNER_CALLSIGN}".replace(" ", "_")
@@ -34,7 +35,7 @@ class HamQTH(APIQueryCallsignDataProvider):
         # and password, this is valid for an hour, so our cache stores this specifically for 55 minutes.
         self._CREDENTIALS_CACHE = CachedSession(f"{CACHE_DIR}/urls/hamqth-creds", expire_after=timedelta(minutes=55))
 
-    def _perform_new_lookup(self, callsign, lookup_credentials):
+    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         # If we don't have HamQTH credentials, skip this lookup Return None so we don't *cache* the lack of data, because
         #         # someone might provide credentials next time around.
         if not lookup_credentials or not (
@@ -61,9 +62,6 @@ class HamQTH(APIQueryCallsignDataProvider):
                         # Log this failure at debug level only, not our problem if user entered the wrong password.
                         logger.debug("HamQTH login details incorrect, failed to look up with HamQTH.")
                         return None
-                except ExpatError:
-                    logger.warning("HamQTH provided blank or malformed content when trying to authenticate")
-                    return None
                 except Exception:
                     logger.exception("Exception when getting HamQTH session key")
                     return None
@@ -121,7 +119,7 @@ class HamQTH(APIQueryCallsignDataProvider):
             return None
 
     @staticmethod
-    def hamqth_response_to_callsign(callsign, data):
+    def hamqth_response_to_callsign(callsign: str, data: dict[str, Any]) -> Callsign:
         """Convert the "Callsign" block in HamQTH's API response to our own Callsign object."""
 
         # Check for sensible latitudes

providers/callsigndata/qrz.py

@@ -1,7 +1,7 @@
 import logging
 import urllib.parse
 from datetime import datetime, timedelta
-from xml.parsers.expat import ExpatError
+from typing import Any
 
 import pytz
 import xmltodict
@@ -14,6 +14,7 @@ from core.data_store import CACHE_DIR, DATA_STORE
 from core.enums import Continent, LocationSourceForCallsign
 from core.url_data_cache import URLDataCache
 from data.callsign import Callsign
+from data.lookup_credentials import LookupCredentials
 from providers.callsigndata.api_query_callsign_data_provider import APIQueryCallsignDataProvider
 
 logger = logging.getLogger(__name__)
@@ -22,7 +23,7 @@ logger = logging.getLogger(__name__)
 class QRZ(APIQueryCallsignDataProvider):
     """Callsign data provider for QRZ.com."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("QRZ.com", provider_config, DATA_STORE.callsign_data_qrz)
         self._QRZ_BASE_URL = "https://xmldata.qrz.com/xml/current/"
         self._URL_DATA_CACHE = URLDataCache("qrz")
@@ -30,7 +31,7 @@ class QRZ(APIQueryCallsignDataProvider):
         # and password, this is valid for an hour, so our cache stores this specifically for 55 minutes.
         self._CREDENTIALS_CACHE = CachedSession(f"{CACHE_DIR}/urls/qrz-creds", expire_after=timedelta(minutes=55))
 
-    def _perform_new_lookup(self, callsign, lookup_credentials):
+    def _perform_new_lookup(self, callsign: str, lookup_credentials: LookupCredentials | None) -> Callsign | None:
         # If we don't have QRZ credentials, skip this lookup. Return None so we don't *cache* the lack of data, because
         # someone might provide credentials next time around.
         if not lookup_credentials or not (
@@ -57,9 +58,6 @@ class QRZ(APIQueryCallsignDataProvider):
                         # Log this failure at debug level only, not our problem if user entered the wrong password.
                         logger.debug("QRZ.com login details incorrect, failed to look up with QRZ.")
                         return None
-                except ExpatError:
-                    logger.warning("QRZ.com provided blank or malformed content when trying to authenticate")
-                    return None
                 except Exception:
                     logger.exception("Exception when getting QRZ.com session key")
                     return None
@@ -129,7 +127,7 @@ class QRZ(APIQueryCallsignDataProvider):
             return None
 
     @staticmethod
-    def qrz_response_to_callsign(callsign, data):
+    def qrz_response_to_callsign(callsign: str, data: dict[str, Any] | list[Any]) -> Callsign:
         """Convert the "Callsign" block in QRZ's API response to our own Callsign object."""
 
         # I have encountered a user passing multiple callsigns to the QRZ lookup function in a way that QRZ actually
@@ -137,7 +135,9 @@ class QRZ(APIQueryCallsignDataProvider):
         # functions can't deal with multiple calls this way.
         if isinstance(data, list):
             data = data[0]
+            assert isinstance(data, dict)
             callsign = data["call"]
+        assert isinstance(data, dict)
 
         # Get a name
         name = None

providers/solarconditions/giroionosonde.py

@@ -2,6 +2,7 @@ import csv
 import logging
 from datetime import datetime, timedelta, timezone
 from threading import Event, Thread
+from typing import Any
 
 import pytz
 import requests
@@ -31,17 +32,17 @@ class GIROIonosonde(SolarConditionsProvider):
     Designed to run alongside KC2GProp even though they produce similar data. GIRO has more stations and includes LUF
     data, but is less reliable and often offline."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("GIRO Ionosonde Data", provider_config)
-        self._stations = self._load_stations()
-        self._thread = None
-        self._stop_event = Event()
+        self._stations: list[dict[str, str]] = self._load_stations()
+        self._thread: Thread | None = None
+        self._stop_event: Event = Event()
 
         # Pre-populate ionosonde_data with known station names for stations not already present,
         # so the station dropdown is available before the first poll. Does not overwrite existing
         # entries so KC2G cache data is preserved.
-        existing = self._solar_conditions.ionosonde_data or {}
-        new_entries = {
+        existing: dict[str, Any] = self._solar_conditions.ionosonde_data or {}
+        new_entries: dict[str, Any] = {
             s["ursi"]: {
                 "ursi": s["ursi"],
                 "name": s["name"],
@@ -57,27 +58,27 @@ class GIROIonosonde(SolarConditionsProvider):
             self.update_data({"ionosonde_data": {**existing, **new_entries}})
 
     @staticmethod
-    def _load_stations():
-        stations = []
+    def _load_stations() -> list[dict[str, str]]:
+        stations: list[dict[str, str]] = []
         with open(STATIONS_INDEX, newline="") as f:
             for row in csv.reader(f):
                 if len(row) >= 2:
                     stations.append({"ursi": row[0].strip(), "name": row[1].strip()})
         return stations
 
-    def start(self):
+    def start(self) -> None:
         logger.info(f"Set up query of GIRO ionosonde data API every {POLL_INTERVAL} seconds.")
         self._thread = Thread(target=self._run, name="GIROIonosondeDataProvider", 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("GIRO ionosonde worker thread did not exit on time and will be killed.")
 
-    def _run(self):
+    def _run(self) -> None:
         # Real interval at which we poll is the "once per hour" divided by the number of stations, so each one gets
         # polled once per hour, just not all at once
         interval = POLL_INTERVAL / len(self._stations)
@@ -88,7 +89,7 @@ class GIROIonosonde(SolarConditionsProvider):
             if self._stop_event.wait(timeout=interval):
                 break
 
-    def _poll_station(self, station):
+    def _poll_station(self, station: dict[str, str]) -> None:
         ursi = station["ursi"]
         name = station["name"]
         try:
@@ -139,7 +140,9 @@ class GIROIonosonde(SolarConditionsProvider):
             self.status = "Error"
             logger.exception(f"Exception fetching GIRO ionosonde data for {ursi} ({name})")
 
-    def _fetch_station_data(self, ursi, from_time, to_time):
+    def _fetch_station_data(
+        self, ursi: str, from_time: datetime, to_time: datetime
+    ) -> tuple[dict[float, float] | None, dict[float, float] | None, dict[float, float] | None]:
         """Fetch foF2, MUF and LUF readings for a station. Returns (fof2_dict, muf_dict, luf_dict) keyed by UNIX timestamp."""
 
         from_str = from_time.strftime("%Y.%m.%d+%H:%M:%S")
@@ -159,12 +162,12 @@ class GIROIonosonde(SolarConditionsProvider):
             return None, None, None
 
     @staticmethod
-    def _parse_all(text):
+    def _parse_all(text: str) -> tuple[dict[float, float], dict[float, float], dict[float, float]]:
         """Parse web server response and return (fof2_dict, muf_dict, luf_dict) keyed by UNIX timestamp."""
 
-        fof2_data = {}
-        muf_data = {}
-        luf_data = {}
+        fof2_data: dict[float, float] = {}
+        muf_data: dict[float, float] = {}
+        luf_data: dict[float, float] = {}
         for line in text.splitlines():
             line = line.strip()
             if not line or line.startswith("#"):

providers/solarconditions/hamqsl.py

@@ -1,7 +1,9 @@
 import logging
+from typing import Any
 from xml.etree import ElementTree
 
 import pytz
+import requests
 from dateutil import parser as dateutil_parser
 from dateutil import tz as dateutil_tz
 
@@ -19,10 +21,10 @@ class HamQSL(HTTPSolarConditionsProvider):
     """Solar conditions provider using the HamQSL.com XML API (https://www.hamqsl.com/solarxml.php).
     Provides solar flux index, geomagnetic indices, and HF/VHF propagation condition summaries."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("HamQSL", provider_config, URL, POLL_INTERVAL)
 
-    def _http_response_to_solar_conditions(self, http_response):
+    def _http_response_to_solar_conditions(self, http_response: requests.Response) -> dict[str, Any] | None:
         root = ElementTree.fromstring(http_response.text)
         sd = root.find("solardata")
         if sd is None:
@@ -31,27 +33,27 @@ class HamQSL(HTTPSolarConditionsProvider):
 
         # Some error checking functions in case the data is janky.
 
-        def text(tag, default=None):
+        def text(tag: str, default: str | None = None) -> str | None:
             if sd is None:
                 logger.warning("HamQSL solar conditions API returned unexpected XML structure")
                 return default
             el = sd.find(tag)
             return el.text.strip() if el is not None and el.text else default
 
-        def float_val(tag, default=None):
+        def float_val(tag: str, default: float | None = None) -> float | None:
             try:
                 return float(text(tag))
             except (ValueError, TypeError):
                 return default
 
-        def int_val(tag, default=None):
+        def int_val(tag: str, default: int | None = None) -> int | None:
             try:
                 return int(text(tag))
             except (ValueError, TypeError):
                 return default
 
         # Process HF band conditions
-        hf_conditions = {}
+        hf_conditions: dict[str, str] = {}
         calc = sd.find("calculatedconditions")
         if calc is not None:
             for band_el in calc.findall("band"):
@@ -62,7 +64,7 @@ class HamQSL(HTTPSolarConditionsProvider):
                     hf_conditions[f"{name}-{time}"] = condition
 
         # Process VHF propagation conditions
-        vhf_map = {}
+        vhf_map: dict[tuple[str | None, str | None], str | None] = {}
         vhf = sd.find("calculatedvhfconditions")
         if vhf is not None:
             for ph_el in vhf.findall("phenomenon"):

providers/solarconditions/http_solar_conditions_provider.py

@@ -1,6 +1,7 @@
 import logging
 from datetime import datetime
 from threading import Event, Thread
+from typing import Any
 
 import pytz
 import requests
@@ -16,32 +17,32 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
     """Generic solar conditions provider for providers that request data via HTTP(S). Subclasses implement
     _http_response_to_solar_conditions() to parse the specific API response format."""
 
-    def __init__(self, name, provider_config, url, poll_interval):
+    def __init__(self, name: str, provider_config: dict[str, Any], url: str, poll_interval: float) -> None:
         super().__init__(name, provider_config)
-        self._url = url
-        self._poll_interval = poll_interval
-        self._thread = None
-        self._stop_event = Event()
+        self._url: str = url
+        self._poll_interval: float = poll_interval
+        self._thread: Thread | None = None
+        self._stop_event: Event = Event()
 
-    def start(self):
+    def start(self) -> None:
         logger.info(f"Set up query of {self.name} solar conditions API every {self._poll_interval!s} seconds.")
         self._thread = Thread(target=self._run, name=f"HTTPSolarConditionsProvider-{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} solar conditions 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:
             logger.debug(f"Polling {self.name} solar conditions API...")
             http_response = requests.get(self._url, headers=HTTP_HEADERS, timeout=(5, 30))
@@ -66,7 +67,7 @@ class HTTPSolarConditionsProvider(SolarConditionsProvider):
             logger.exception(f"Exception in HTTP Solar Conditions Provider ({self.name})")
             self._stop_event.wait(timeout=1)
 
-    def _http_response_to_solar_conditions(self, http_response):
+    def _http_response_to_solar_conditions(self, http_response: requests.Response) -> dict[str, Any] | None:
         """Convert an HTTP response into solar conditions data. Returns a dict mapping SolarConditions field
         names to their new values, or None if the response could not be parsed. Only the fields returned will
         be updated on the shared SolarConditions object; any fields not included will be left unchanged."""

providers/solarconditions/ionosonde_utils.py

@@ -1,9 +1,10 @@
 from core.constants import BANDS
+from data.band import Band
 
-HF_BANDS = [b for b in BANDS if b.is_ham_hf]
+HF_BANDS: list[Band] = [b for b in BANDS if b.is_ham_hf]
 
 
-def _latest(d) -> float | None:
+def _latest(d: dict[float, float | str] | None) -> float | None:
     """Given a map where the key is a timestamp and the value is a number represented as a string, find the latest
     timestamp and return the corresponding value as a float."""
 
@@ -11,7 +12,11 @@ def _latest(d) -> float | None:
     return float(val) if (val is not None and val != "None") else None
 
 
-def compute_band_states(fof2_dict, muf_dict, luf_dict):
+def compute_band_states(
+    fof2_dict: dict[float, float | str] | None,
+    muf_dict: dict[float, float | str] | None,
+    luf_dict: dict[float, float | str] | None,
+) -> dict[str, str]:
     """Compute HF band states from the latest foF2, MUF and LUF values.
 
     Returns a map where the keys are HF bands and the values are as follows:

providers/solarconditions/kc2gprop.py

@@ -1,6 +1,7 @@
 import logging
 from datetime import datetime, timedelta, timezone
 from threading import Event, Thread
+from typing import Any
 
 import pytz
 import requests
@@ -25,30 +26,30 @@ class KC2GProp(SolarConditionsProvider):
     Designed to run alongside GIROIonosonde even though they produce similar data. KC2G is more reliable and is always
     online, but has fewer stations and does not provide LUF data."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("KC2G Propagation Data", provider_config)
-        self._thread = None
-        self._stop_event = Event()
+        self._thread: Thread | None = None
+        self._stop_event: Event = Event()
 
-    def start(self):
+    def start(self) -> None:
         logger.info(f"Set up query of KC2G ionosonde data API every {POLL_INTERVAL} seconds.")
         self._thread = Thread(target=self._run, name="KC2GPropProvider", 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("KC2G ionosonde 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=POLL_INTERVAL):
                 break
 
-    def _poll(self):
+    def _poll(self) -> None:
         try:
             logger.debug("Polling KC2G ionosonde data...")
             http_response = requests.get(KC2G_URL, headers=HTTP_HEADERS, timeout=(5, 30))
@@ -61,7 +62,7 @@ class KC2GProp(SolarConditionsProvider):
 
             # Start from existing ionosonde_data so the accumulated time series survives across polls and restarts and
             # stations provided only by GIROIonosonde are not discarded
-            ionosonde_data = dict(self._solar_conditions.ionosonde_data or {})
+            ionosonde_data: dict[str, Any] = dict(self._solar_conditions.ionosonde_data or {})
             updated_count = 0
 
             for reading in http_response.json():

providers/solarconditions/noaa3dayforecast.py

@@ -1,6 +1,9 @@
 import logging
 import re
-from datetime import datetime, timezone
+from datetime import date, datetime, timezone
+from typing import Any
+
+import requests
 
 from providers.solarconditions.http_solar_conditions_provider import (
     HTTPSolarConditionsProvider,
@@ -16,11 +19,11 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
     """Solar conditions provider using the NOAA 3-day forecast text file. Parses the NOAA forecast and populates
     corresponding fields in the solar conditions object.."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("NOAA 3-day Forecast", provider_config, URL, POLL_INTERVAL)
 
     @staticmethod
-    def _parse_percentage_table(lines, section_header, year):
+    def _parse_percentage_table(lines: list[str], section_header: str, year: int) -> dict[str, dict[float, int]] | None:
         """Find and parse a forecast table using percentages, identified by section_header. This is common to the lookup
         of the solar storm and radio blackout forecast parsing."""
 
@@ -48,7 +51,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
             return None
 
         # Figure out the date based on the line found
-        column_timestamps = []
+        column_timestamps: list[float] = []
         for month_str, day_str in date_matches:
             try:
                 dt = datetime.strptime(f"{day_str} {month_str} {year}", "%d %b %Y").replace(tzinfo=timezone.utc)
@@ -58,7 +61,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
                 return None
 
         # Parse data rows. Each non-empty line should have a text label followed by percentage values
-        result = {}
+        result: dict[str, dict[float, int]] = {}
         for line in lines[date_header_idx + 1 :]:
             line_stripped = line.strip()
             if not line_stripped:
@@ -73,7 +76,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
 
             # Row label is everything before the first percentage value
             row_label = line_stripped[: line_stripped.index(pct_matches[0].group())].strip()
-            row_data = {}
+            row_data: dict[float, int] = {}
             for j, match in enumerate(pct_matches):
                 if j >= len(column_timestamps):
                     break
@@ -83,7 +86,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
 
         return result if result else None
 
-    def _http_response_to_solar_conditions(self, http_response):
+    def _http_response_to_solar_conditions(self, http_response: requests.Response) -> dict[str, Any] | None:
         lines = http_response.text.splitlines()
 
         # Find the "NOAA Kp index breakdown" section header
@@ -115,7 +118,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
             logger.warning(f"NOAA K-index forecast: could not parse date headers from: {date_header_line}")
             return None
 
-        column_dates = []
+        column_dates: list[date] = []
         for month_str, day_str in date_matches:
             try:
                 column_dates.append(
@@ -126,7 +129,7 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
                 return None
 
         # Parse each data row, e.g. "00-03UT          2.00          3.00          2.00"
-        k_index_forecast = {}
+        k_index_forecast: dict[float, float] = {}
         for line in lines[start_idx + 3 :]:
             time_match = re.match(r"^(\d{2})-(\d{2})UT\s+(.*)", line.strip())
             if not time_match:
@@ -147,11 +150,11 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
                 except (ValueError, IndexError):
                     continue
 
-                date = column_dates[i]
+                column_date = column_dates[i]
                 start_dt = datetime(
-                    date.year,
-                    date.month,
-                    date.day,
+                    column_date.year,
+                    column_date.month,
+                    column_date.day,
                     start_hour,
                     0,
                     0,
@@ -167,14 +170,14 @@ class NOAA3dayForecast(HTTPSolarConditionsProvider):
             return None
 
         # Parse Solar Radiation Storm Forecast (single row: "S1 or greater")
-        solar_storm_forecast = None
+        solar_storm_forecast: dict[float, int] | None = None
         radiation_table = self._parse_percentage_table(lines, "Solar Radiation Storm Forecast", year)
         if radiation_table:
             solar_storm_forecast = radiation_table.get("S1 or greater")
 
         # Parse Radio Blackout Forecast (two rows: "R1-R2" and "R3 or greater")
-        blackout_forecast_r1r2 = None
-        blackout_forecast_r3_or_greater = None
+        blackout_forecast_r1r2: dict[float, int] | None = None
+        blackout_forecast_r3_or_greater: dict[float, int] | None = None
         blackout_table = self._parse_percentage_table(lines, "Radio Blackout Forecast", year)
         if blackout_table:
             blackout_forecast_r1r2 = blackout_table.get("R1-R2")

providers/solarconditions/solar_conditions_provider.py

@@ -1,34 +1,36 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
 
 from core.data_store import DATA_STORE
+from data.solar_conditions import SolarConditions
 
 
 class SolarConditionsProvider:
     """Generic solar conditions provider class. Subclasses of this query individual APIs for space weather and
     propagation 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.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
-        self.status = "Not Started" if self.enabled else "Disabled"
-        self._solar_conditions = DATA_STORE.solar_conditions.get()
+        self.name: str = name
+        self.enabled: bool = provider_config.get("enabled", True)
+        self.last_update_time: datetime = datetime.min.replace(tzinfo=pytz.UTC)
+        self.status: str = "Not Started" if self.enabled else "Disabled"
+        self._solar_conditions: SolarConditions = DATA_STORE.solar_conditions.get()
 
-    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 stop(self):
+    def stop(self) -> None:
         """Stop any threads and prepare for application shutdown"""
 
         raise NotImplementedError("Subclasses must implement this method")
 
-    def update_data(self, new_data):
+    def update_data(self, new_data: dict[str, Any] | None) -> None:
         """Update the solar conditions object with new data"""
 
         if new_data:

providers/spot/aprsis.py

@@ -1,6 +1,7 @@
 import logging
 from datetime import datetime
 from threading import Event, Thread
+from typing import Any
 
 import aprslib
 import pytz
@@ -15,17 +16,17 @@ logger = logging.getLogger(__name__)
 class APRSIS(SpotProvider):
     """Spot provider for the APRS-IS."""
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("APRS-IS", provider_config)
-        self._thread = None
-        self._aprsis = None
-        self._stop_event = Event()
+        self._thread: Thread | None = None
+        self._aprsis: aprslib.IS | None = None
+        self._stop_event: Event = Event()
 
-    def start(self):
+    def start(self) -> None:
         self._thread = Thread(target=self._run, name="APRSISSpotProvider", daemon=True)
         self._thread.start()
 
-    def _run(self):
+    def _run(self) -> None:
         while not self._stop_event.is_set():
             try:
                 self._aprsis = aprslib.IS(SERVER_OWNER_CALLSIGN)
@@ -43,7 +44,7 @@ class APRSIS(SpotProvider):
             if not self._stop_event.is_set():
                 self._stop_event.wait(timeout=5)
 
-    def stop(self):
+    def stop(self) -> None:
         self.status = "Shutting down"
         self._stop_event.set()
         if self._aprsis:
@@ -53,7 +54,7 @@ class APRSIS(SpotProvider):
             if self._thread.is_alive():
                 logger.warning("APRS-IS worker thread did not exit on time and will be killed.")
 
-    def _handle(self, data):
+    def _handle(self, data: dict[str, Any]) -> None:
         try:
             # Split SSID in "from" call and store separately
             from_parts = str(data["from"]).split("-")

providers/spot/dxcluster.py

@@ -1,17 +1,22 @@
 import logging
 import re
+import socket
 from datetime import datetime
+from threading import Event, Lock, Thread
+from typing import Any
 
 import pytz
+import telnetlib3
 
 from core.config import SERVER_OWNER_CALLSIGN
+from core.utils import decode_telnet_bytes
 from data.spot import Spot
-from providers.spot.telnet_spot_provider import TelnetSpotProvider
+from providers.spot.spot_provider import SpotProvider
 
 logger = logging.getLogger(__name__)
 
 
-class DXCluster(TelnetSpotProvider):
+class DXCluster(SpotProvider):
     """Spot provider for a DX Cluster. Hostname, port, login_prompt, login_callsign and allow_rbn_spots are provided in config.
     See config-example.yml for examples."""
 
@@ -24,37 +29,116 @@ class DXCluster(TelnetSpotProvider):
         re.IGNORECASE,
     )
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         """Constructor requires hostname and port"""
 
         name = provider_config.get("name", "Cluster")
-        allow_rbn_spots = provider_config.get("allow_rbn_spots", False)
-        self._spot_line_pattern = self._LINE_PATTERN_ALLOW_RBN if allow_rbn_spots else self._LINE_PATTERN_EXCLUDE_RBN
-        super().__init__(
-            name,
-            provider_config,
-            host=provider_config["host"],
-            port=provider_config["port"],
-            login_prompt=provider_config.get("login_prompt", "login:"),
-            login_response=provider_config.get("login_callsign", SERVER_OWNER_CALLSIGN),
+        super().__init__(name, provider_config)
+        self._hostname: str = provider_config["host"]
+        self._port: int = provider_config["port"]
+        self._login_prompt: str = provider_config.get("login_prompt", "login:")
+        self._login_callsign: str = provider_config.get("login_callsign", SERVER_OWNER_CALLSIGN)
+        self._allow_rbn_spots: bool = provider_config.get("allow_rbn_spots", False)
+        self._spot_line_pattern: re.Pattern[str] = (
+            self._LINE_PATTERN_ALLOW_RBN if self._allow_rbn_spots else self._LINE_PATTERN_EXCLUDE_RBN
         )
+        self._telnet: telnetlib3.Telnet | None = None
+        self._telnet_lock: Lock = Lock()
+        self._thread: Thread | None = None
+        self._stop_event: Event = Event()
 
-    def _parse_line(self, line):
-        match = self._spot_line_pattern.match(line)
-        if not match:
-            return None
+    def start(self) -> None:
+        self._thread = Thread(target=self._handle, name=f"DXClusterSpotProvider-{self.name}", daemon=True)
+        self._thread.start()
 
-        spot_time = datetime.strptime(match.group(5), "%H%MZ").replace(tzinfo=pytz.UTC)
-        spot_datetime = datetime.combine(
-            datetime.now(pytz.UTC).date(),
-            spot_time.time(),
-            tzinfo=pytz.UTC,
-        )
-        return Spot(
-            source=self.name,
-            dx_call=match.group(3),
-            de_call=match.group(1),
-            freq=float(match.group(2)) * 1000,
-            comment=match.group(4).strip(),
-            time=spot_datetime.timestamp(),
-        )
+    def stop(self) -> None:
+        self._stop_event.set()
+        with self._telnet_lock:
+            if self._telnet:
+                try:
+                    self._telnet.sock.shutdown(socket.SHUT_RDWR)
+                except (AttributeError, OSError):
+                    pass
+                self._telnet.close()
+        if self._thread:
+            self._thread.join(timeout=5)
+            if self._thread.is_alive():
+                logger.warning(f"DX Cluster {self._hostname} worker thread did not exit on time and will be killed.")
+
+    def _handle(self) -> None:
+        while not self._stop_event.is_set():
+            connected = False
+            while not connected and not self._stop_event.is_set():
+                try:
+                    self.status = "Connecting"
+                    logger.info(f"DX Cluster {self._hostname} connecting...")
+                    new_telnet = telnetlib3.Telnet(self._hostname, self._port)
+                    with self._telnet_lock:
+                        self._telnet = new_telnet
+                        if self._stop_event.is_set():
+                            # stop() was called while we were connecting, close the connection rather than trying to
+                            # read when we know it won't work
+                            new_telnet.close()
+                            break
+                    self._telnet.read_until(self._login_prompt.encode("latin-1"))
+                    self._telnet.write(f"{self._login_callsign}\n".encode("latin-1"))
+                    connected = True
+                    logger.info(f"DX Cluster {self._hostname} connected.")
+                except ConnectionRefusedError:
+                    self.status = "Error"
+                    logger.warning(f"Connection refused to DX cluster {self._hostname}")
+                    self._stop_event.wait(timeout=300)
+                except Exception:
+                    self.status = "Error"
+                    logger.exception(f"Exception while connecting to DX Cluster Provider ({self._hostname}).")
+                    self._stop_event.wait(timeout=5)
+
+            self.status = "Waiting for Data"
+            while connected and not self._stop_event.is_set():
+                try:
+                    # Check new telnet info against regular expression
+                    telnet_output = self._telnet.read_until("\n".encode("latin-1"))
+                    match = self._spot_line_pattern.match(decode_telnet_bytes(telnet_output))
+                    if match:
+                        spot_time = datetime.strptime(match.group(5), "%H%MZ").replace(tzinfo=pytz.UTC)
+                        spot_datetime = datetime.combine(
+                            datetime.now(pytz.UTC).date(),
+                            spot_time.time(),
+                            tzinfo=pytz.UTC,
+                        )
+                        spot = Spot(
+                            source=self.name,
+                            dx_call=match.group(3),
+                            de_call=match.group(1),
+                            freq=float(match.group(2)) * 1000,
+                            comment=match.group(4).strip(),
+                            time=spot_datetime.timestamp(),
+                        )
+
+                        # Add to our list
+                        self._submit(spot)
+
+                        self.status = "OK"
+                        self.last_update_time = datetime.now(pytz.UTC)
+                        logger.debug(f"Data received from DX Cluster {self._hostname}.")
+
+                except EOFError:
+                    connected = False
+                    if not self._stop_event.is_set():
+                        self.status = "Restarting"
+                        logger.warning(f"Disconnected from DX Cluster {self._hostname}. Reconnecting...")
+                        self._stop_event.wait(timeout=5)
+                    else:
+                        logger.info(f"DX Cluster {self._hostname} shutting down...")
+                        self.status = "Shutting down"
+                except Exception:
+                    connected = False
+                    if not self._stop_event.is_set():
+                        self.status = "Error"
+                        logger.exception(f"Exception in DX Cluster Provider ({self._hostname})")
+                        self._stop_event.wait(timeout=5)
+                    else:
+                        logger.info(f"DX Cluster {self._hostname} shutting down...")
+                        self.status = "Shutting down"
+
+            self.status = "Disconnected"

providers/spot/gma.py

@@ -1,7 +1,9 @@
 import logging
 from datetime import datetime
+from typing import Any
 
 import pytz
+import requests
 
 from core.constants import HTTP_HEADERS
 from core.enums import ActivityName, ActivityRefType, Mode
@@ -21,14 +23,14 @@ class GMA(HTTPSpotProvider):
     # GMA spots don't contain the details of the programme they are for, we need a separate lookup for that
     REF_INFO_URL_ROOT = "https://www.gma.rocks/api/ref/?"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         # Ensure there is an API key in our config, and set up the query URL using it. If no key is provided,
         # disable this spot provider.
-        self._api_key = provider_config.get("api_key", "")
+        self._api_key: str = provider_config.get("api_key", "")
         if self._api_key == "":
             provider_config["enabled"] = False
             logger.warning("GMA spot provider configured but no api key was provided, this API will not be queried.")
-        self._url_data_cache = URLDataCache("GMA")
+        self._url_data_cache: URLDataCache = URLDataCache("GMA")
 
         super().__init__(
             "GMA",
@@ -37,8 +39,8 @@ class GMA(HTTPSpotProvider):
             self.POLL_INTERVAL_SEC,
         )
 
-    def _http_response_to_spots(self, http_response):
-        new_spots = []
+    def _http_response_to_spots(self, http_response: requests.Response) -> list[Spot]:
+        new_spots: list[Spot] = []
         # Iterate through source data
         if "RCD" in http_response.json():
             for source_spot in http_response.json()["RCD"]:
@@ -172,10 +174,10 @@ class GMA(HTTPSpotProvider):
 
         return new_spots
 
-    def can_submit_spot(self, activity):
+    def can_submit_spot(self, activity: str) -> bool:
         return activity == ActivityName.GMA
 
-    def submit_spot(self, spot, credentials):
+    def submit_spot(self, spot: Spot, credentials: dict[str, str]) -> None:
         # TODO: Implement.
         # Spotting to GMA is documented: https://www.cqgma.org/api/doc/apigma_spot.pdf We (or the user) need a GMA account, and to send the password in plaintext(!!)
         raise NotImplementedError("GMA upstream spot submission is not yet implemented")

providers/spot/hema.py

@@ -1,6 +1,7 @@
 import logging
 import re
 from datetime import datetime
+from typing import Any
 
 import pytz
 import requests
@@ -27,17 +28,17 @@ class HEMA(HTTPSpotProvider):
     FREQ_MODE_PATTERN = re.compile("^([\\d.]*) \\((.*)\\)$")
     SPOTTER_COMMENT_PATTERN = re.compile("^\\((.*)\\) (.*)$")
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("HEMA", provider_config, self.SPOT_SEED_URL, self.POLL_INTERVAL_SEC)
-        self._spot_seed = ""
+        self._spot_seed: str = ""
 
-    def _http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response: requests.Response) -> list[Spot]:
         # OK, source data is actually just the spot seed at this point. We'll then go on to fetch real data if we know
         # this has changed.
         spot_seed_changed = http_response.text != self._spot_seed
         self._spot_seed = http_response.text
 
-        new_spots = []
+        new_spots: list[Spot] = []
         # OK, if the spot seed actually changed, now we make the real request for data.
         if spot_seed_changed:
             try:
@@ -89,10 +90,10 @@ class HEMA(HTTPSpotProvider):
                 logger.warning("Connection error when accessing HEMA spots API.")
         return new_spots
 
-    def can_submit_spot(self, activity):
+    def can_submit_spot(self, activity: str) -> bool:
         return activity == ActivityName.HEMA
 
-    def submit_spot(self, spot, credentials):
+    def submit_spot(self, spot: Spot, credentials: dict[str, str]) -> None:
         # TODO: Implement. Currently blocked awaiting their API team to make a change to allow us to spot with a
         # reference and not a reference *number*.
         raise NotImplementedError("HEMA upstream spot submission is not yet implemented")

providers/spot/http_spot_provider.py

@@ -1,12 +1,14 @@
 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.spot import Spot
 from providers.spot.spot_provider import SpotProvider
 
 logger = logging.getLogger(__name__)
@@ -16,22 +18,22 @@ class HTTPSpotProvider(SpotProvider):
     """Generic spot 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: float) -> None:
         super().__init__(name, provider_config)
-        self._url = url
-        self._poll_interval = poll_interval
-        self._thread = None
-        self._stop_event = Event()
-        self._wakeup_event = Event()
+        self._url: str = url
+        self._poll_interval: float = poll_interval
+        self._thread: Thread | None = None
+        self._stop_event: Event = Event()
+        self._wakeup_event: 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} spot API every {self._poll_interval!s} seconds.")
         self._thread = Thread(target=self._run, name=f"HTTPSpotProvider-{self.name}", daemon=True)
         self._thread.start()
 
-    def stop(self):
+    def stop(self) -> None:
         self._stop_event.set()
         self._wakeup_event.set()
         if self._thread:
@@ -39,12 +41,12 @@ class HTTPSpotProvider(SpotProvider):
             if self._thread.is_alive():
                 logger.warning(f"{self.name} spot worker thread did not exit on time and will be killed.")
 
-    def force_poll(self):
+    def force_poll(self) -> None:
         """Trigger an immediate poll without waiting for the normal interval."""
 
         self._wakeup_event.set()
 
-    def _run(self):
+    def _run(self) -> None:
         while True:
             self._wakeup_event.clear()
             self._poll()
@@ -52,7 +54,7 @@ class HTTPSpotProvider(SpotProvider):
             if self._stop_event.is_set():
                 break
 
-    def _poll(self):
+    def _poll(self) -> None:
         try:
             # Request data from API
             logger.debug(f"Polling {self.name} spot API...")
@@ -86,7 +88,7 @@ class HTTPSpotProvider(SpotProvider):
             logger.exception(f"Exception in HTTP Spot Provider ({self.name})")
             self._stop_event.wait(timeout=1)
 
-    def _http_response_to_spots(self, http_response):
+    def _http_response_to_spots(self, http_response: requests.Response) -> list[Spot] | None:
         """Convert an HTTP response returned by the API into spot 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."""

providers/spot/llota.py

@@ -1,4 +1,7 @@
 from datetime import datetime
+from typing import Any
+
+import requests
 
 from core.enums import ActivityName, ActivityRefType, Mode
 from data.activity_ref import ActivityRef
@@ -12,11 +15,11 @@ class LLOTA(HTTPSpotProvider):
     POLL_INTERVAL_SEC = 120
     SPOTS_URL = "https://llota.app/api/public/spots"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("LLOTA", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_spots(self, http_response):
-        new_spots = []
+    def _http_response_to_spots(self, http_response: requests.Response) -> list[Spot]:
+        new_spots: list[Spot] = []
         # Iterate through source data
         for source_spot in http_response.json():
             # Find the most recent spotter and comment from the history array

providers/spot/parksnpeaks.py

@@ -1,7 +1,7 @@
 import logging
 import re
 from datetime import datetime
-from typing import ClassVar
+from typing import Any, ClassVar
 
 import pytz
 import requests
@@ -33,11 +33,11 @@ class ParksNPeaks(HTTPSpotProvider):
         ActivityName.SANPCPA,
     ]
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("ParksNPeaks", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_spots(self, http_response):
-        new_spots = []
+    def _http_response_to_spots(self, http_response: requests.Response) -> list[Spot]:
+        new_spots: list[Spot] = []
         # Iterate through source data
         if http_response and http_response != "":
             for source_spot in http_response.json():
@@ -117,10 +117,10 @@ class ParksNPeaks(HTTPSpotProvider):
                 new_spots.append(spot)
         return new_spots
 
-    def can_submit_spot(self, activity):
+    def can_submit_spot(self, activity: str) -> bool:
         return activity in self.SUBMITTABLE_ACTIVITIES
 
-    def submit_spot(self, spot, credentials):
+    def submit_spot(self, spot: Spot, credentials: dict[str, str]) -> None:
         # TODO test this works
         user_id = credentials.get("user_id", "")
         api_key = credentials.get("api_key", "")
@@ -128,6 +128,8 @@ class ParksNPeaks(HTTPSpotProvider):
             raise ValueError(
                 "Parks N Peaks user ID and API key are required. Get yours from your Parks N Peaks account."
             )
+        if not spot.freq:
+            raise RuntimeError("The Parks N Peaks API requires a frequency to be set.")
         ref_id = spot.sig_refs[0].id if spot.sig_refs else ""
         body = {
             "actClass": spot.sig or "",

providers/spot/pota.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Any
 
 import pytz
 import requests
@@ -17,11 +18,11 @@ class POTA(HTTPSpotProvider):
     SPOTS_URL = "https://api.pota.app/spot/activator"
     SUBMIT_URL = "https://api.pota.app/spot"
 
-    def __init__(self, provider_config):
+    def __init__(self, provider_config: dict[str, Any]) -> None:
         super().__init__("POTA", provider_config, self.SPOTS_URL, self.POLL_INTERVAL_SEC)
 
-    def _http_response_to_spots(self, http_response):
-        new_spots = []
+    def _http_response_to_spots(self, http_response: requests.Response) -> list[Spot]:
+        new_spots: list[Spot] = []
         # Iterate through source data
         for source_spot in http_response.json():
             # Convert to our spot format
@@ -57,12 +58,14 @@ class POTA(HTTPSpotProvider):
             new_spots.append(spot)
         return new_spots
 
-    def can_submit_spot(self, activity):
+    def can_submit_spot(self, activity: str) -> bool:
         return activity == ActivityName.POTA
 
-    def submit_spot(self, spot, credentials):
+    def submit_spot(self, spot: Spot, credentials: dict[str, str]) -> None:
         sig_ref = spot.sig_refs[0].id if spot.sig_refs else None
         if sig_ref:
+            if not spot.freq:
+                raise RuntimeError("The POTA API requires a frequency to be set.")
             body = {
                 "activator": spot.dx_call,
                 "spotter": spot.de_call,