From 2782c57917eb20b0af65c274b68c0c6b74c5cf94 Mon Sep 17 00:00:00 2001
From: Jules Dejaeghere <dej.j@live.be>
Date: Mon, 5 May 2025 19:30:26 +0200
Subject: [PATCH] Breaking: make pollen names an enum

---
 irm_kmi_api/const.py  |  2 --
 irm_kmi_api/data.py   | 11 +++++++++++
 irm_kmi_api/pollen.py | 11 ++++++-----
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/irm_kmi_api/const.py b/irm_kmi_api/const.py
index b4e7277..ef30ef0 100644
--- a/irm_kmi_api/const.py
+++ b/irm_kmi_api/const.py
@@ -2,8 +2,6 @@ from typing import Final
 
 from irm_kmi_api.data import IrmKmiConditionEvol, IrmKmiRadarStyle
 
-# TODO enum as well for those three values?
-POLLEN_NAMES: Final = {'Alder', 'Ash', 'Birch', 'Grasses', 'Hazel', 'Mugwort', 'Oak'}
 POLLEN_LEVEL_TO_COLOR = {'null': 'green', 'low': 'yellow', 'moderate': 'orange', 'high': 'red', 'very high': 'purple',
                          'active': 'active'}
 WEEKDAYS = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
diff --git a/irm_kmi_api/data.py b/irm_kmi_api/data.py
index c03c02d..9116602 100644
--- a/irm_kmi_api/data.py
+++ b/irm_kmi_api/data.py
@@ -49,6 +49,17 @@ class IrmKmiRadarStyle(Enum):
     OPTION_STYLE_YELLOW_RED = 'yellow_red_style'
     OPTION_STYLE_SATELLITE = 'satellite_style'
 
+class IrmKmiPollenNames(Enum):
+    """Pollens names from the API"""
+
+    ALDER = 'Alder'
+    ASH = 'Ash'
+    BIRCH = 'Birch'
+    GRASSES = 'Grasses'
+    HAZEL = 'Hazel'
+    MUGWORT = 'Mugwort'
+    OAK = 'Oak'
+
 class IrmKmiForecast(Forecast, total=False):
     """Forecast class with additional attributes for IRM KMI"""
 
diff --git a/irm_kmi_api/pollen.py b/irm_kmi_api/pollen.py
index ad43c87..f736342 100644
--- a/irm_kmi_api/pollen.py
+++ b/irm_kmi_api/pollen.py
@@ -3,7 +3,8 @@ import logging
 import xml.etree.ElementTree as ET
 from typing import List
 
-from .const import POLLEN_LEVEL_TO_COLOR, POLLEN_NAMES
+from .const import POLLEN_LEVEL_TO_COLOR
+from .data import IrmKmiPollenNames
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -39,10 +40,10 @@ class PollenParser:
         elements: List[ET.Element] = self._extract_elements(root)
 
         pollens = {e.attrib.get('x', None): self._get_elem_text(e).lower()
-                   for e in elements if 'tspan' in e.tag and self._get_elem_text(e) in POLLEN_NAMES}
+                   for e in elements if 'tspan' in e.tag and self._get_elem_text(e) in IrmKmiPollenNames}
 
         pollen_levels = {e.attrib.get('x', None): POLLEN_LEVEL_TO_COLOR[self._get_elem_text(e)]
-                         for e in elements if 'tspan' in e.tag and self._get_elem_text(e) in POLLEN_LEVEL_TO_COLOR}
+                         for e in elements if 'tspan' in e.tag and self._get_elem_text(e) in IrmKmiPollenNames}
 
         level_dots = {e.attrib.get('cx', None) for e in elements if 'circle' in e.tag}
 
@@ -84,12 +85,12 @@ class PollenParser:
     @staticmethod
     def get_default_data() -> dict:
         """Return all the known pollen with 'none' value"""
-        return {k.lower(): 'none' for k in POLLEN_NAMES}
+        return {k.value.lower(): 'none' for k in IrmKmiPollenNames}
 
     @staticmethod
     def get_unavailable_data() -> dict:
         """Return all the known pollen with None value"""
-        return {k.lower(): None for k in POLLEN_NAMES}
+        return {k.value.lower(): None for k in IrmKmiPollenNames}
 
     @staticmethod
     def get_option_values() -> List[str]: