ElectronAnalyser no longer depends directly on sequence file path to work with BlueAPI (#1923)

* ElectronAnalyser no longer depends directly on sequence file path to work with BlueAPI

* Improve type checking

* Move PsuMode to B07 shared, improve type checking

* Moved some pytest fixtures to where they are used

* make self.driver on impl rather than base.

Author: oliwenmandiamond

src/dodal/beamlines/b07.py

@@ -5,8 +5,8 @@
     B07SampleManipulator52B,
     Grating,
     LensMode,
-    PsuMode,
 )
+from dodal.devices.beamlines.b07_shared import PsuMode
 from dodal.devices.electron_analyser.base import EnergySource
 from dodal.devices.electron_analyser.specs import SpecsDetector
 from dodal.devices.motors import XYZPolarStage

src/dodal/beamlines/b07_1.py

@@ -1,12 +1,12 @@
 from dodal.beamlines.b07_shared import devices as b07_shared_devices
 from dodal.common.beamlines.beamline_utils import set_beamline as set_utils_beamline
 from dodal.device_manager import DeviceManager
-from dodal.devices.beamlines.b07 import PsuMode
 from dodal.devices.beamlines.b07_1 import (
     ChannelCutMonochromator,
     Grating,
     LensMode,
 )
+from dodal.devices.beamlines.b07_shared import PsuMode
 from dodal.devices.electron_analyser.base import EnergySource
 from dodal.devices.electron_analyser.specs import SpecsDetector
 from dodal.devices.motors import XYZPolarAzimuthStage

src/dodal/devices/beamlines/b07/__init__.py

@@ -1,4 +1,4 @@
 from .b07_motors import B07SampleManipulator52B
-from .enums import Grating, LensMode, PsuMode
+from .enums import Grating, LensMode
 
-__all__ = ["B07SampleManipulator52B", "Grating", "LensMode", "PsuMode"]
+__all__ = ["B07SampleManipulator52B", "Grating", "LensMode"]

src/dodal/devices/beamlines/b07/enums.py

@@ -25,15 +25,3 @@ class LensMode(SupersetEnum):
     # option if disconnected. Once it is connected, "Not connected" is replaced with the
     # options above. This is also why this must be a SupersetEnum.
     NOT_CONNECTED = "Not connected"
-
-
-class PsuMode(SupersetEnum):
-    V3500 = "3.5kV"
-    V1500 = "1.5kV"
-    V400 = "400V"
-    V100 = "100V"
-    V10 = "10V"
-    # This is connected to the device separately and will only have "Not connected" as
-    # option if disconnected. Once it is connected, "Not connected" is replaced with the
-    # options above. This is also why this must be a SupersetEnum.
-    NOT_CONNECTED = "Not connected"

src/dodal/devices/beamlines/b07_shared/__init__.py

@@ -0,0 +1,3 @@
+from .enums import PsuMode
+
+__all__ = ["PsuMode"]

src/dodal/devices/beamlines/b07_shared/enums.py

@@ -0,0 +1,13 @@
+from ophyd_async.core import SupersetEnum
+
+
+class PsuMode(SupersetEnum):
+    V3500 = "3.5kV"
+    V1500 = "1.5kV"
+    V400 = "400V"
+    V100 = "100V"
+    V10 = "10V"
+    # This is connected to the device separately and will only have "Not connected" as
+    # option if disconnected. Once it is connected, "Not connected" is replaced with the
+    # options above. This is also why this must be a SupersetEnum.
+    NOT_CONNECTED = "Not connected"

src/dodal/devices/electron_analyser/base/base_detector.py

@@ -10,7 +10,6 @@
     TriggerInfo,
 )
 
-from dodal.common.data_util import load_json_file_to_class
 from dodal.devices.electron_analyser.base.base_controller import (
     ElectronAnalyserController,
 )
@@ -20,9 +19,7 @@
 )
 from dodal.devices.electron_analyser.base.base_region import (
     GenericRegion,
-    GenericSequence,
     TAbstractBaseRegion,
-    TAbstractBaseSequence,
 )
 
 
@@ -111,6 +108,9 @@ async def trigger(self) -> None:
         await super().trigger()
 
 
+# Used in sm-bluesky, but will hopefully be removed along with
+# ElectronAnalyserRegionDetector in future. Blocked by:
+# https://github.com/bluesky/bluesky/pull/1978
 GenericElectronAnalyserRegionDetector = ElectronAnalyserRegionDetector[
     GenericAnalyserDriverIO, GenericRegion
 ]
@@ -123,24 +123,13 @@ async def trigger(self) -> None:
 class ElectronAnalyserDetector(
     BaseElectronAnalyserDetector[TAbstractAnalyserDriverIO, TAbstractBaseRegion],
     Stageable,
-    Generic[TAbstractBaseSequence, TAbstractAnalyserDriverIO, TAbstractBaseRegion],
+    Generic[TAbstractAnalyserDriverIO, TAbstractBaseRegion],
 ):
     """Electron analyser detector with the additional functionality to load a sequence
     file and create a list of temporary ElectronAnalyserRegionDetector objects. These
     will setup configured region settings before data acquisition.
     """
 
-    def __init__(
-        self,
-        sequence_class: type[TAbstractBaseSequence],
-        controller: ElectronAnalyserController[
-            TAbstractAnalyserDriverIO, TAbstractBaseRegion
-        ],
-        name: str = "",
-    ):
-        self._sequence_class = sequence_class
-        super().__init__(controller, name)
-
     @AsyncStatus.wrap
     async def stage(self) -> None:
         """Prepare the detector for use by ensuring it is idle and ready.
@@ -160,38 +149,24 @@ async def unstage(self) -> None:
         """Disarm the detector."""
         await self._controller.disarm()
 
-    def load_sequence(self, filename: str) -> TAbstractBaseSequence:
-        """Load the sequence data from a provided json file into a sequence class.
-
-        Args:
-            filename (str): Path to the sequence file containing the region data.
-
-        Returns:
-            Pydantic model representing the sequence file.
-        """
-        return load_json_file_to_class(self._sequence_class, filename)
-
     def create_region_detector_list(
-        self, filename: str, enabled_only=True
+        self, regions: list[TAbstractBaseRegion]
     ) -> list[
         ElectronAnalyserRegionDetector[TAbstractAnalyserDriverIO, TAbstractBaseRegion]
     ]:
-        """Create a list of detectors equal to the number of regions in a sequence file.
-        Each detector is responsible for setting up a specific region.
+        """This method can hopefully be dropped when this is merged and released.
+        https://github.com/bluesky/bluesky/pull/1978.
+
+        Create a list of detectors equal to the number of regions. Each detector is
+        responsible for setting up a specific region.
 
         Args:
-            filename (str): Path to the sequence file containing the region data.
-            enabled_only (bool, optional): If true, only include the region if enabled
-                is True.
+            regions: The list of regions to give to each region detector.
 
         Returns:
             List of ElectronAnalyserRegionDetector, equal to the number of regions in
-                the sequence file.
+            the sequence file.
         """
-        seq = self.load_sequence(filename)
-        regions: list[TAbstractBaseRegion] = (
-            seq.get_enabled_regions() if enabled_only else seq.regions
-        )
         return [
             ElectronAnalyserRegionDetector[
                 TAbstractAnalyserDriverIO, TAbstractBaseRegion
@@ -201,7 +176,7 @@ def create_region_detector_list(
 
 
 GenericElectronAnalyserDetector = ElectronAnalyserDetector[
-    GenericSequence, GenericAnalyserDriverIO, GenericRegion
+    GenericAnalyserDriverIO, GenericRegion
 ]
 TElectronAnalyserDetector = TypeVar(
     "TElectronAnalyserDetector",

src/dodal/devices/electron_analyser/specs/specs_detector.py

@@ -7,17 +7,13 @@
 from dodal.devices.electron_analyser.base.base_region import TLensMode, TPsuMode
 from dodal.devices.electron_analyser.base.energy_sources import AbstractEnergySource
 from dodal.devices.electron_analyser.specs.specs_driver_io import SpecsAnalyserDriverIO
-from dodal.devices.electron_analyser.specs.specs_region import (
-    SpecsRegion,
-    SpecsSequence,
-)
+from dodal.devices.electron_analyser.specs.specs_region import SpecsRegion
 from dodal.devices.fast_shutter import FastShutter
 from dodal.devices.selectable_source import SourceSelector
 
 
 class SpecsDetector(
     ElectronAnalyserDetector[
-        SpecsSequence[TLensMode, TPsuMode],
         SpecsAnalyserDriverIO[TLensMode, TPsuMode],
         SpecsRegion[TLensMode, TPsuMode],
     ],
@@ -33,15 +29,12 @@ def __init__(
         source_selector: SourceSelector | None = None,
         name: str = "",
     ):
-        # Save to class so takes part with connect()
+        # Make attribute of class so connect applies to driver and populates parent.
         self.driver = SpecsAnalyserDriverIO[TLensMode, TPsuMode](
             prefix, lens_mode_type, psu_mode_type
         )
-
         controller = ElectronAnalyserController[
             SpecsAnalyserDriverIO[TLensMode, TPsuMode], SpecsRegion[TLensMode, TPsuMode]
         ](self.driver, energy_source, shutter, source_selector)
 
-        sequence_class = SpecsSequence[lens_mode_type, psu_mode_type]
-
-        super().__init__(sequence_class, controller, name)
+        super().__init__(controller, name)

src/dodal/devices/electron_analyser/vgscienta/vgscienta_detector.py

@@ -12,15 +12,13 @@
 from dodal.devices.electron_analyser.vgscienta.vgscienta_region import (
     TPassEnergyEnum,
     VGScientaRegion,
-    VGScientaSequence,
 )
 from dodal.devices.fast_shutter import FastShutter
 from dodal.devices.selectable_source import SourceSelector
 
 
 class VGScientaDetector(
     ElectronAnalyserDetector[
-        VGScientaSequence[TLensMode, TPsuMode, TPassEnergyEnum],
         VGScientaAnalyserDriverIO[TLensMode, TPsuMode, TPassEnergyEnum],
         VGScientaRegion[TLensMode, TPassEnergyEnum],
     ],
@@ -37,17 +35,13 @@ def __init__(
         source_selector: SourceSelector | None = None,
         name: str = "",
     ):
-        # Save to class so takes part with connect()
+        # Make attribute of class so connect applies to driver and populates parent.
         self.driver = VGScientaAnalyserDriverIO[TLensMode, TPsuMode, TPassEnergyEnum](
             prefix, lens_mode_type, psu_mode_type, pass_energy_type
         )
-
         controller = ElectronAnalyserController[
             VGScientaAnalyserDriverIO[TLensMode, TPsuMode, TPassEnergyEnum],
             VGScientaRegion[TLensMode, TPassEnergyEnum],
         ](self.driver, energy_source, shutter, source_selector)
 
-        sequence_class = VGScientaSequence[
-            lens_mode_type, psu_mode_type, pass_energy_type
-        ]
-        super().__init__(sequence_class, controller, name)
+        super().__init__(controller, name)