Update ID lookup with type checking (#1707)

* add i09 look up table praiser

* move get_poly to lookuptable

* extracted EnergyMotorLookup base class from i10EnergyMotorLookup

* added new make_phase_tables function

* add test for correct table output

* remove_i09

* add docstring

* add test for helper functions

* add test for skipping

* spacing fix

* Refactor Lookuptable class documentation

Removed outdated docstring from Lookuptable class and updated initialization docstring for I10EnergyMotorLookup class.

* change lookup table schema to snake case

* replace dictionary with basemodel

* add tying

* add gap and phase

* fat finger correction

* Update ID lookup logic to use type checking

* Fix some tests

* Improve models to not use shared defaults

* undo syntax error

* Fixed test to check for success on loading i10 lut

* Simplified lut logic

* Added back generate_lookup_table function

* Fixed all tests but polarisation

* Updated doc strings

* Moved generic test from i10 to test_lookup_table_apple2

* Renamed lut_column_config to lut_config

* Updated more doc strings

* Fix default phase_file name and thus tests

* Use Pol in LookupTable rather than string

* Updated test_convert_csv_to_lookup_overwrite_name_convert_default to use Pol

* Update tests to use Pol rather str value

* Improve EnergyCoverageEntry to have a poly serializer and EnergyCoverage to use float as key

* Add type checking to i10Apple2 phase

* Removed commente out code

* Fixed poly test

* Fixed test_make_phase_tables_multiple_entries

* Added test_lookup_table_is_serialisable

* Update src/dodal/devices/util/lookup_tables_apple2.py

Co-authored-by: Raymond Fan <[email protected]>

---------

Co-authored-by: Relm-Arrowny <[email protected]>

Author: oliwenmandiamond

src/dodal/beamlines/i10_optics.py

@@ -34,6 +34,10 @@
 from dodal.devices.i10.i10_setting_data import I10Grating
 from dodal.devices.pgm import PlaneGratingMonochromator
 from dodal.devices.synchrotron import Synchrotron
+from dodal.devices.util.lookup_tables_apple2 import (
+    LookupPath,
+    LookupTableConfig,
+)
 from dodal.log import set_beamline as set_log_beamline
 from dodal.utils import BeamlinePrefix, get_beamline_name
 
@@ -117,9 +121,10 @@ def idd_controller() -> I10Apple2Controller:
     """I10 downstream insertion device controller."""
     return I10Apple2Controller(
         apple2=idd(),
-        lookuptable_dir=LOOK_UPTABLE_DIR,
-        source=("Source", "idd"),
         config_client=I10_CONF_CLIENT,
+        lut_config=LookupTableConfig(
+            source=("Source", "idd"), path=LookupPath.create(LOOK_UPTABLE_DIR)
+        ),
     )
 
 
@@ -181,9 +186,10 @@ def idu_controller() -> I10Apple2Controller:
     """I10 upstream insertion device controller."""
     return I10Apple2Controller(
         apple2=idu(),
-        lookuptable_dir=LOOK_UPTABLE_DIR,
-        source=("Source", "idu"),
         config_client=I10_CONF_CLIENT,
+        lut_config=LookupTableConfig(
+            source=("Source", "idu"), path=LookupPath.create(LOOK_UPTABLE_DIR)
+        ),
     )
 
 

src/dodal/devices/apple2_undulator.py

@@ -217,10 +217,7 @@ def __init__(self, prefix: str, infix: str, name: str = ""):
 
 
 class UndulatorLockedPhaseAxes(SafeUndulatorMover[Apple2PhaseValType]):
-    """
-    Two phase Motor to make up the locked id phase motion.
-
-    """
+    """Two phase Motor to make up the locked id phase motion."""
 
     def __init__(
         self,

src/dodal/devices/i10/i10_apple2.py

@@ -24,8 +24,8 @@
     UndulatorPhaseAxes,
 )
 from dodal.devices.util.lookup_tables_apple2 import (
-    EnergyMotorLookup,
-    Lookuptable,
+    BaseEnergyMotorLookup,
+    LookupTableConfig,
     convert_csv_to_lookup,
 )
 from dodal.log import LOGGER
@@ -37,80 +37,38 @@
 ALPHA_OFFSET = 180
 
 
-class I10EnergyMotorLookup(EnergyMotorLookup):
+class I10EnergyMotorLookup(BaseEnergyMotorLookup):
     """
     Handles lookup tables for I10 Apple2 ID, converting energy and polarisation to gap
-     and phase. Fetches and parses lookup tables from a config server, supports dynamic
-     updates, and validates input.
+    and phase. Fetches and parses lookup tables from a config server, supports dynamic
+    updates, and validates input.
     """
 
-    def __init__(
-        self,
-        lookuptable_dir: str,
-        source: tuple[str, str],
-        config_client: ConfigServer,
-        mode: str = "Mode",
-        min_energy: str = "MinEnergy",
-        max_energy: str = "MaxEnergy",
-        gap_file_name: str = "IDEnergy2GapCalibrations.csv",
-        phase_file_name: str = "IDEnergy2PhaseCalibrations.csv",
-        poly_deg: list | None = None,
-    ):
-        """Initialise the I10EnergyMotorLookup class with lookup table headers provided.
-
-        Parameters
-        ----------
-        look_up_table_dir:
-            The path to look up table.
-        source:
-            The column name and the name of the source in look up table. e.g. ( "source", "idu")
-        config_client:
-            The config server client to fetch the look up table.
-        mode:
-            The column name of the mode in look up table.
-        min_energy:
-            The column name that contain the maximum energy in look up table.
-        max_energy:
-            The column name that contain the maximum energy in look up table.
-        poly_deg:
-            The column names for the parameters for the energy conversion polynomial, starting with the least significant.
-
-        """
-        super().__init__(
-            lookuptable_dir=lookuptable_dir,
-            config_client=config_client,
-            mode=mode,
-            source=source,
-            min_energy=min_energy,
-            max_energy=max_energy,
-            gap_file_name=gap_file_name,
-            phase_file_name=phase_file_name,
-            poly_deg=poly_deg,
-        )
-
     def update_lookuptable(self):
         """
         Update lookup tables from files and validate their format.
         """
-        LOGGER.info("Updating lookup dictionary from file.")
-        for key, path in self.lookup_table_config.path.__dict__.items():
-            csv_file = self.config_client.get_file_contents(
-                path, reset_cached_result=True
-            )
-            self.lookup_tables[key] = convert_csv_to_lookup(
-                file=csv_file,
-                source=self.lookup_table_config.source,
-                mode=self.lookup_table_config.mode,
-                min_energy=self.lookup_table_config.min_energy,
-                max_energy=self.lookup_table_config.max_energy,
-                poly_deg=self.lookup_table_config.poly_deg,
-            )
-            Lookuptable.model_validate(self.lookup_tables[key])
+        LOGGER.info("Updating lookup dictionary from file for gap.")
+        gap_csv_file = self.config_client.get_file_contents(
+            self.lut_config.path.gap, reset_cached_result=True
+        )
+        self.lookup_tables.gap = convert_csv_to_lookup(
+            file_contents=gap_csv_file, lut_config=self.lut_config
+        )
+        self.available_pol = list(self.lookup_tables.gap.root.keys())
+
+        LOGGER.info("Updating lookup dictionary from file for phase.")
+        phase_csv_file = self.config_client.get_file_contents(
+            self.lut_config.path.phase, reset_cached_result=True
+        )
+        self.lookup_tables.phase = convert_csv_to_lookup(
+            file_contents=phase_csv_file, lut_config=self.lut_config
+        )
 
-        self.available_pol = list(self.lookup_tables["gap"].keys())
 
+class I10Apple2(Apple2[UndulatorPhaseAxes]):
+    """I10Apple2 device is an apple2 with extra jaw phase motor."""
 
-class I10Apple2(Apple2):
     def __init__(
         self,
         id_gap: UndulatorGap,
@@ -119,11 +77,8 @@ def __init__(
         name: str = "",
     ) -> None:
         """
-        I10Apple2 device is an apple2 with extra jaw phase motor.
-
-        Parameters
-        ----------
-
+        Parameters:
+        ------------
         id_gap : UndulatorJawPhase
             The gap motor of the undulator.
         id_phase : UndulatorJawPhase
@@ -147,26 +102,22 @@ class I10Apple2Controller(Apple2Controller[I10Apple2]):
     def __init__(
         self,
         apple2: I10Apple2,
-        lookuptable_dir: str,
-        source: tuple[str, str],
         config_client: ConfigServer,
+        lut_config: LookupTableConfig,
         jaw_phase_limit: float = 12.0,
         jaw_phase_poly_param: list[float] = DEFAULT_JAW_PHASE_POLY_PARAMS,
         angle_threshold_deg=30.0,
         name: str = "",
     ) -> None:
         """
-
-        parameters
-        ----------
+        Parameters:
+        -----------
         apple2 : I10Apple2
             An I10Apple2 device.
-        lookuptable_dir : str
-            The path to look up table.
-        source : tuple[str, str]
-            The column name and the name of the source in look up table. e.g. ( "source", "idu")
         config_client : ConfigServer
             The config server client to fetch the look up table.
+        lut_config:
+            Configuration that defines where the lookup table is and how to read it.
         jaw_phase_limit : float, optional
             The maximum allowed jaw_phase movement., by default 12.0
         jaw_phase_poly_param : list[float], optional
@@ -178,8 +129,7 @@ def __init__(
         """
 
         self.lookup_table_client = I10EnergyMotorLookup(
-            lookuptable_dir=lookuptable_dir,
-            source=source,
+            lut_config=lut_config,
             config_client=config_client,
         )
         super().__init__(