Start converting some enum-like strings to proper enums

core/constants.py

@@ -17,7 +17,7 @@ SIGS = [
         description="Parks on the Air",
         ref_regex=r"[A-Z]{2}\-\d{4,5}|K\-TEST",
         icon="fa-tree",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="SOTA",
@@ -25,7 +25,7 @@ SIGS = [
         description="Summits on the Air",
         ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}",
         icon="fa-mountain-sun",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="WWFF",
@@ -33,7 +33,7 @@ SIGS = [
         description="World Wide Flora & Fauna",
         ref_regex=r"[A-Z0-9]{1,3}FF\-\d{4}",
         icon="fa-seedling",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="GMA",
@@ -41,7 +41,7 @@ SIGS = [
         description="Global Mountain Activity",
         ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}",
         icon="fa-person-hiking",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="WWBOTA",
@@ -49,7 +49,7 @@ SIGS = [
         description="Worldwide Bunkers on the Air",
         ref_regex=r"B\/[A-Z0-9]{1,3}\-\d{3,4}",
         icon="fa-radiation",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="HEMA",
@@ -57,7 +57,7 @@ SIGS = [
         description="HuMPs Excluding Marilyns Award",
         ref_regex=r"[A-Z0-9]{1,3}\/[A-Z]{3}\-\d{3}",
         icon="fa-mound",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="IOTA",
@@ -65,7 +65,7 @@ SIGS = [
         description="Islands on the Air",
         ref_regex=r"[A-Z]{2}\-\d{3}",
         icon="fa-book-atlas",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="GMA Islands",
@@ -73,7 +73,7 @@ SIGS = [
         description="Global Mountain Activity - Islands",
         ref_regex=r"(([A-Z]{2}\-\d{3})|([A-Z0-9]{1,3}\/[A-Z]{2}\-\d{3}))",
         icon="fa-person-hiking",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="ARLHS",
@@ -81,7 +81,7 @@ SIGS = [
         description="Amateur Radio Lighthouse Society",
         ref_regex=r"[A-Z]{3}[\- ]\d{3,4}",
         icon="fa-house-flood-water",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="ILLW",
@@ -89,7 +89,7 @@ SIGS = [
         description="International Lighthouse & Lightship Weekend",
         ref_regex=r"[A-Z]{2}\d{4}",
         icon="fa-house-flood-water",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="MOTA",
@@ -97,7 +97,7 @@ SIGS = [
         description="Mills on the Air",
         ref_regex=r"X\d{4,6}",
         icon="fa-fan",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="SIOTA",
@@ -105,7 +105,7 @@ SIGS = [
         description="Silos on the Air",
         ref_regex=r"[A-Z]{2}\-[A-Z]{3}\d",
         icon="fa-wheat-awn",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="WCA",
@@ -113,7 +113,7 @@ SIGS = [
         description="World Castles Award",
         ref_regex=r"[A-Z0-9]{1,3}\-\d{5}",
         icon="fa-chess-rook",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="ZLOTA",
@@ -122,7 +122,7 @@ SIGS = [
         ref_regex=r"ZL[A-Z]/[A-Z]{2}\-\d{3,4}",
         icon="fa-kiwi-bird",
         region_flag="🇳🇿",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="WOTA",
@@ -131,20 +131,16 @@ SIGS = [
         ref_regex=r"[A-Z]{3}-[0-9]{2}",
         icon="fa-w",
         region_flag="🇬🇧",
-        refs_globally_unique=False
-    ),
-    SIG(name="BOTA",
-        comment_names=[],
-        description="Beaches on the Air",
-        icon="fa-umbrella-beach"
+        refs_globally_unique=False,
     ),
+    SIG(name="BOTA", comment_names=[], description="Beaches on the Air", icon="fa-umbrella-beach"),
     SIG(
         name="KRMNPA",
         comment_names=["KRMNPA"],
         description="Keith Roget Memorial National Parks Award",
         ref_regex=r"VKFF\-\d{4}",
         icon="fa-earth-oceania",
-        region_flag="🇦🇺"
+        region_flag="🇦🇺",
     ),
     SIG(
         name="SANPCPA",
@@ -152,7 +148,7 @@ SIGS = [
         description="South Australian National Parks and Conservation Parks Award",
         ref_regex=r"VKFF\-\d{4}",
         icon="fa-earth-oceania",
-        region_flag="🇦🇺"
+        region_flag="🇦🇺",
     ),
     SIG(
         name="LLOTA",
@@ -160,7 +156,7 @@ SIGS = [
         description="Lagos y Lagunas on the Air",
         ref_regex=r"LL[A-Z]{2}\-\d{4}",
         icon="fa-water",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="Towers",
@@ -168,7 +164,7 @@ SIGS = [
         description="Towers on the Air",
         ref_regex=r"[A-Z]{2,3}R\-\d{4}",
         icon="fa-tower-observation",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="Tiles",
@@ -176,7 +172,7 @@ SIGS = [
         description="Tiles on the Air",
         ref_regex=r"[A-Za-z]{2}[0-9]{2}[A-Za-z]{2}",
         icon="fa-square",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="WAB",
@@ -185,7 +181,7 @@ SIGS = [
         ref_regex=r"[A-Z]{1,2}[0-9]{2}",
         icon="fa-table-cells-large",
         region_flag="🇬🇧",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="WAI",
@@ -194,7 +190,7 @@ SIGS = [
         ref_regex=r"[A-Z][0-9]{2}",
         icon="fa-table-cells-large",
         region_flag="🇮🇪",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="DME",
@@ -203,7 +199,7 @@ SIGS = [
         ref_regex=r"\d{4,5}",
         icon="fa-building",
         region_flag="🇪🇸",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="FEA",
@@ -215,7 +211,7 @@ SIGS = [
         ref_regex=r"([DE]|FEA)[\- ]\d{4}(\.\d)?",
         icon="fa-house-flood-water",
         region_flag="🇪🇸",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="DTMBA",
@@ -224,14 +220,14 @@ SIGS = [
         ref_regex=r"I-?[0-9]{3,4}\s?[A-Z]{2}",
         icon="fa-masks-theater",
         region_flag="🇮🇹",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
     SIG(
         name="BIWOTA",
         comment_names=["BIWOTA"],
         description="British Inland Waterways on the Air",
         icon="fa-ship",
-        region_flag="🇬🇧"
+        region_flag="🇬🇧",
     ),
     SIG(
         name="COTA",
@@ -240,7 +236,7 @@ SIGS = [
         ref_regex=r"[A-Z]{3}\-[0-9]{3,5}",
         icon="fa-chess-rook",
         region_flag="🇩🇪",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="PGA",
@@ -249,7 +245,7 @@ SIGS = [
         ref_regex=r"[A-Z]{2}[0-9]{2}",
         icon="fa-g",
         region_flag="🇵🇱",
-        refs_globally_unique=False
+        refs_globally_unique=False,
     ),
     SIG(
         name="Toilets",
@@ -258,19 +254,13 @@ SIGS = [
         ref_regex=r"T\-[0-9]{2}",
         icon="fa-toilet",
         region_flag="🏴‍☠️",
-        refs_globally_unique=True
+        refs_globally_unique=True,
     ),
 ]
 
 # Modes. Note "DIGI" and "DIGITAL" are also supported but are normalised into "DATA".
 CW_MODES = ["CW"]
-PHONE_MODES = [
-    "PHONE",
-    "SSB",
-    "AM",
-    "FM",
-    "DV"
-]
+PHONE_MODES = ["PHONE", "SSB", "AM", "FM", "DV"]
 DATA_MODES = [
     "DATA",
     "FT8",
@@ -341,9 +331,6 @@ BANDS = [
 ]
 UNKNOWN_BAND = Band(name="Unknown", start_freq=0, end_freq=0)
 
-# Continents
-CONTINENTS = ["EU", "NA", "SA", "AS", "AF", "OC", "AN"]
-
 # 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 = {

core/enums.py

@@ -0,0 +1,39 @@
+from enum import Enum
+
+
+class Continent(str, Enum):
+    EU = "EU"
+    NA = "NA"
+    SA = "SA"
+    AS = "AS"
+    AF = "AF"
+    OC = "OC"
+    AN = "AN"
+
+
+class ModeSource(str, Enum):
+    """Where the mode data came from in a spot."""
+
+    SPOT = "SPOT"
+    COMMENT = "COMMENT"
+    BANDPLAN = "BANDPLAN"
+    NONE = "NONE"
+
+
+class LocationSourceForSpot(str, Enum):
+    """Where the location data came from in a spot."""
+
+    SPOT = "SPOT"
+    SIG_REF_LOOKUP = "SIG REF LOOKUP"
+    GRID = "GRID"
+    HOME_QTH = "HOME QTH"
+    DXCC = "DXCC"
+    NONE = "NONE"
+
+
+class LocationSourceForCallsign(str, Enum):
+    """Where the location data came from in a callsign data object."""
+
+    HOME_QTH = "HOME QTH"
+    DXCC = "DXCC"
+    NONE = "NONE"

core/utils.py

@@ -15,7 +15,8 @@ from core.constants import (
     UNKNOWN_BAND,
 )
 from core.data_store import DATA_STORE
-from data.callsign import Callsign
+from core.enums import Continent
+from data.callsign import Callsign, LocationSourceForCallsign
 
 logger = logging.getLogger(__name__)
 
@@ -116,7 +117,7 @@ def get_callsign_object_from_pyhamtools_callinfo(callsign, callinfo):
 
         country = data.get("country", None)
         dxcc_id = data.get("adif", None)
-        continent = data.get("continent", None)
+        continent = Continent(data.get("continent", None))
         cq_zone = data.get("cqz", None)
         itu_zone = data.get("ituz", None)
         lat = float(data["latitude"]) if "latitude" in data else None
@@ -136,7 +137,7 @@ def get_callsign_object_from_pyhamtools_callinfo(callsign, callinfo):
             latitude=lat,
             longitude=lon,
             grid=grid,
-            location_source="DXCC",
+            location_source=LocationSourceForCallsign.DXCC,
         )
 
     except (KeyError, ValueError):