ruff format files

Author: LowriJenkins

emuloop.py

@@ -20,7 +20,7 @@ class SetDefinition(Enum):
     SCAN = 3
 
 
-def float_or_keep(temp_or_field: str)-> Optional[float]:
+def float_or_keep(temp_or_field: str) -> Optional[float]:
     """
     Convert the input to a float or None if the input is keep (to allow not changing of a
     temperature or field).
@@ -45,7 +45,7 @@ def float_or_keep(temp_or_field: str)-> Optional[float]:
 magnet_not_applicable = "N/A"
 
 
-def magnet_device_type(magnet_device: str)-> str:
+def magnet_device_type(magnet_device: str) -> str:
     """
     Take the shortened magnet selection input e.g. ZF, LF or TF and cast it to the
      required string i.e. Active ZF, Danfysik, T20 Coils.
@@ -69,7 +69,7 @@ def magnet_device_type(magnet_device: str)-> str:
     raise ValueError("Magnet device must be one of {} or N/A".format(list(magnet_devices.keys())))
 
 
-def cast_custom_expression(expression:str)-> str:
+def cast_custom_expression(expression: str) -> str:
     """
     Ensure a custom python expression is not empty (this will cause an error) by filling it with
     None (does nothing).
@@ -87,7 +87,7 @@ def cast_custom_expression(expression:str)-> str:
         return expression
 
 
-def inclusive_float_range_with_step_flip(start: float, stop:float, step:float) -> Generator:
+def inclusive_float_range_with_step_flip(start: float, stop: float, step: float) -> Generator:
     """
     If we are counting downwards from start to stop automatically flips step to be negative.
     Inclusive of stop. Only tested for float values.
@@ -120,9 +120,11 @@ class DoRun(ScriptDefinition):
     active_zf = "Active ZF"
     possible_magnet_devices = [active_zf, "Danfysik", "T20 Coils"]
 
-    def get_help(self)-> str:
-        return (f"Magnet device must be one of {list(magnet_devices.keys())} or if the field is "
-                f"KEEP then it can be N/A.\nIf the field is zero magnet device must be ZF.\n")
+    def get_help(self) -> str:
+        return (
+            f"Magnet device must be one of {list(magnet_devices.keys())} or if the field is "
+            f"KEEP then it can be N/A.\nIf the field is zero magnet device must be ZF.\n"
+        )
 
     @cast_parameters_to(
         start_temperature=float_or_keep,
@@ -144,9 +146,9 @@ def estimate_time(
         stop_field: Optional[float] = 1.0,
         step_field: float = 1.0,
         custom: str = "None",
-        mevents:float = 10,
+        mevents: float = 10,
         magnet_device: str = "N/A",
-    )-> int:
+    ) -> int:
         return 0
 
     # Loop through a set of temperatures or fields using a start, stop and step mechanism
@@ -163,22 +165,22 @@ def estimate_time(
     )
     def run(
         self,
-        start_temperature: Optional[float]= "keep", # type: ignore[reportArgumentType],
-        stop_temperature: Optional[float]= "keep", # type: ignore[reportArgumentType],
-        step_temperature: float =0,
-        start_field: Optional[float]= "keep", # type: ignore[reportArgumentType],
-        stop_field: Optional[float]= "keep", # type: ignore[reportArgumentType],
-        step_field:float=0,
-        custom:str="None",
-        mevents:float=10,
-        magnet_device:str="N/A",
-    )-> None:
+        start_temperature: Optional[float] = "keep",  # type: ignore[reportArgumentType],
+        stop_temperature: Optional[float] = "keep",  # type: ignore[reportArgumentType],
+        step_temperature: float = 0,
+        start_field: Optional[float] = "keep",  # type: ignore[reportArgumentType],
+        stop_field: Optional[float] = "keep",  # type: ignore[reportArgumentType],
+        step_field: float = 0,
+        custom: str = "None",
+        mevents: float = 10,
+        magnet_device: str = "N/A",
+    ) -> None:
         # Scan if start and stop are different, set once if they are equal or do not set if they are
         # None
         temp_set_definition = self.check_set_definition(start_temperature, stop_temperature)
         field_set_definition = self.check_set_definition(start_field, stop_field)
         # Use the instrument scripts to set the magnet device correctly
-        import inst # type:ignore
+        import inst  # type:ignore
 
         if field_set_definition != SetDefinition.UNDEFINED:
             self.set_magnet_device(magnet_device, inst)
@@ -210,7 +212,11 @@ def run(
             assert start_temperature is not None
             assert stop_temperature is not None
             self.run_scans(
-                start_temperature, stop_temperature, step_temperature, mevents, inst.settemp
+                start_temperature,
+                stop_temperature,
+                step_temperature,
+                mevents,
+                inst.settemp,
             )
         elif field_set_definition == SetDefinition.SCAN:  # Run scans for the field
             assert start_field is not None
@@ -240,11 +246,17 @@ def set_magnet_device(self, magnet_device: str, inst: ModuleType) -> None:
           magnet_device (str): The string representation of the magnet device to select.
           inst (module): The instrument scripts module to set the magnet device with.
         """
-        magnet_to_function_map = {"Active ZF": inst.f0, "Danfysik": inst.lf0, "T20 Coils": inst.tf0}
+        magnet_to_function_map = {
+            "Active ZF": inst.f0,
+            "Danfysik": inst.lf0,
+            "T20 Coils": inst.tf0,
+        }
         if g.cget("a_selected_magnet")["value"] != magnet_device:
             magnet_to_function_map[magnet_device]()
 
-    def check_set_definition(self, start_temp_or_field: Optional[float], stop_temp_or_field: Optional[float]) -> Enum:
+    def check_set_definition(
+        self, start_temp_or_field: Optional[float], stop_temp_or_field: Optional[float]
+    ) -> Enum:
         """
         Check if we are running a scan, doing one set (a point) or not setting at all.
 
@@ -297,7 +309,12 @@ def run_temp_and_field_scans(
             self.run_scans(start_field, stop_field, step_field, mevents, inst.setmag)
 
     def run_scans(
-        self, start: float, stop: float, step: float, mevents: float, set_parameter_func: Callable
+        self,
+        start: float,
+        stop: float,
+        step: float,
+        mevents: float,
+        set_parameter_func: Callable,
     ) -> None:
         """
         Run a scan for the given set_parameter_func
@@ -358,7 +375,9 @@ def parameters_valid(
         else:
             return None
 
-    def check_start_and_stop_valid(self, start: Optional[float], stop: Optional[float], variable_name: str) -> str:
+    def check_start_and_stop_valid(
+        self, start: Optional[float], stop: Optional[float], variable_name: str
+    ) -> str:
         """
         Check that start and stop are either both None or both values.
 
@@ -399,7 +418,11 @@ def check_if_start_or_stop_field_are_keep_then_magnet_is_na(
             return ""
 
     def check_step_set_correctly(
-        self, start: Optional[float], stop: Optional[float], step: float, variable_name: str
+        self,
+        start: Optional[float],
+        stop: Optional[float],
+        step: float,
+        variable_name: str,
     ) -> str:
         """
         If we are scanning check that the step is positive and not zero.
@@ -426,7 +449,10 @@ def check_step_set_correctly(
         return reason
 
     def check_magnet_selected_correctly(
-        self, start_field: Optional[float], stop_field: Optional[float], magnet_device: str
+        self,
+        start_field: Optional[float],
+        stop_field: Optional[float],
+        magnet_device: str,
     ) -> str:
         """
         If we are setting a field check:

emulooptime.py

@@ -141,11 +141,11 @@ def get_help(self) -> str:
     )
     def estimate_time(
         self,
-        start_temperature: Optional[float] = "keep", # type: ignore[reportArgumentType]
-        stop_temperature: Optional[float] = "keep", # type: ignore[reportArgumentType]
+        start_temperature: Optional[float] = "keep",  # type: ignore[reportArgumentType]
+        stop_temperature: Optional[float] = "keep",  # type: ignore[reportArgumentType]
         step_temperature: float = 0,
-        start_field: Optional[float] = "keep", # type: ignore[reportArgumentType]
-        stop_field: Optional[float] = "keep", # type: ignore[reportArgumentType]
+        start_field: Optional[float] = "keep",  # type: ignore[reportArgumentType]
+        stop_field: Optional[float] = "keep",  # type: ignore[reportArgumentType]
         step_field: float = 0,
         custom: str = "None",
         mevents: float = 10,
@@ -189,11 +189,11 @@ def estimate_time(
     )
     def run(
         self,
-        start_temperature: Optional[float] = "keep", # type: ignore[reportArgumentType]
-        stop_temperature: Optional[float] = "keep", # type: ignore[reportArgumentType]
+        start_temperature: Optional[float] = "keep",  # type: ignore[reportArgumentType]
+        stop_temperature: Optional[float] = "keep",  # type: ignore[reportArgumentType]
         step_temperature: float = 0,
-        start_field: Optional[float] = "keep", # type: ignore[reportArgumentType]
-        stop_field: Optional[float] = "keep", # type: ignore[reportArgumentType]
+        start_field: Optional[float] = "keep",  # type: ignore[reportArgumentType]
+        stop_field: Optional[float] = "keep",  # type: ignore[reportArgumentType]
         step_field: float = 0,
         custom: str = "None",
         mevents: float = 10,
@@ -204,7 +204,7 @@ def run(
         temp_set_definition = self.check_set_definition(start_temperature, stop_temperature)
         field_set_definition = self.check_set_definition(start_field, stop_field)
         # Use the instrument scripts to set the magnet device correctly
-        import inst # type:ignore
+        import inst  # type:ignore
 
         if field_set_definition != SetDefinition.UNDEFINED:
             self.set_magnet_device(magnet_device, inst)
@@ -236,7 +236,11 @@ def run(
             assert start_temperature is not None
             assert stop_temperature is not None
             self.run_scans(
-                start_temperature, stop_temperature, step_temperature, mevents, inst.settemp
+                start_temperature,
+                stop_temperature,
+                step_temperature,
+                mevents,
+                inst.settemp,
             )
         elif field_set_definition == SetDefinition.SCAN:  # Run scans for the field
             assert start_field is not None
@@ -266,11 +270,17 @@ def set_magnet_device(self, magnet_device: str, inst: ModuleType) -> None:
           magnet_device (str): The string representation of the magnet device to select.
           inst (module): The instrument scripts module to set the magnet device with.
         """
-        magnet_to_function_map = {"Active ZF": inst.f0, "Danfysik": inst.lf0, "T20 Coils": inst.tf0}
+        magnet_to_function_map = {
+            "Active ZF": inst.f0,
+            "Danfysik": inst.lf0,
+            "T20 Coils": inst.tf0,
+        }
         if g.cget("a_selected_magnet")["value"] != magnet_device:
             magnet_to_function_map[magnet_device]()
 
-    def check_set_definition(self, start_temp_or_field: Optional[float], stop_temp_or_field: Optional[float]) -> Enum:
+    def check_set_definition(
+        self, start_temp_or_field: Optional[float], stop_temp_or_field: Optional[float]
+    ) -> Enum:
         """
         Check if we are running a scan, doing one set (a point) or not setting at all.
 
@@ -323,7 +333,12 @@ def run_temp_and_field_scans(
             self.run_scans(start_field, stop_field, step_field, mevents, inst.setmag)
 
     def run_scans(
-        self, start: float, stop: float, step: float, mevents: float, set_parameter_func: Callable
+        self,
+        start: float,
+        stop: float,
+        step: float,
+        mevents: float,
+        set_parameter_func: Callable,
     ) -> None:
         """
         Run a scan for the given set_parameter_func
@@ -384,8 +399,9 @@ def parameters_valid(
         else:
             return None
 
-    def check_start_and_stop_valid(self, start: Optional[float], stop: Optional[float],
-                                   variable_name: str) -> str:
+    def check_start_and_stop_valid(
+        self, start: Optional[float], stop: Optional[float], variable_name: str
+    ) -> str:
         """
         Check that start and stop are either both None or both values.
 
@@ -426,7 +442,11 @@ def check_if_start_or_stop_field_are_keep_then_magnet_is_na(
             return ""
 
     def check_step_set_correctly(
-        self, start: Optional[float], stop: Optional[float], step: float, variable_name: str
+        self,
+        start: Optional[float],
+        stop: Optional[float],
+        step: float,
+        variable_name: str,
     ) -> str:
         """
         If we are scanning check that the step is positive and not zero.
@@ -453,7 +473,10 @@ def check_step_set_correctly(
         return reason
 
     def check_magnet_selected_correctly(
-        self, start_field: Optional[float], stop_field: Optional[float], magnet_device: str
+        self,
+        start_field: Optional[float],
+        stop_field: Optional[float],
+        magnet_device: str,
     ) -> str:
         """
         If we are setting a field check:

example_loop.py

@@ -5,7 +5,7 @@
 from genie_python.genie_script_generator import ScriptDefinition, cast_parameters_to
 
 
-def inclusive_float_range_with_step_flip(start: float, stop: float, step: float)-> Generator:
+def inclusive_float_range_with_step_flip(start: float, stop: float, step: float) -> Generator:
     """
     If we are counting downwards from start to stop automatically flips step to be negative.
     Inclusive of stop. Only tested for float values.

test_emu/test_casters.py

@@ -1,14 +1,15 @@
 import unittest
 
 import numpy as np
+from hamcrest import assert_that, calling, raises
+
 from emuloop import cast_custom_expression as cast_custom_expression_emuloop
 from emuloop import float_or_keep as float_or_keep_emuloop
 from emuloop import magnet_device_type as magnet_device_type_emuloop
 from emuloop import magnet_devices as magnet_devices_emuloop
 from emulooptime import float_or_keep as float_or_keep_emu
 from emulooptime import magnet_device_type as magnet_device_type_emu
 from emulooptime import magnet_devices as magnet_devices_emu
-from hamcrest import assert_that, calling, raises
 
 
 class TestMagnetCaster(unittest.TestCase):

test_emu/test_emuloop_param_validation.py

@@ -1,8 +1,9 @@
 import unittest
 
-from emuloop import DoRun, magnet_devices
 from parameterized import parameterized
 
+from emuloop import DoRun, magnet_devices
+
 start_stop_must_both_be_keep_error_message = (
     "If start {0} or stop {0} is keep, the other must also be keep\n"
 )

test_emu/test_emuloop_run.py

@@ -35,9 +35,7 @@ def test_GIVEN_both_temp_field_scans_WHEN_run_THEN_scans_run_once_for_each_set(
         inst.lf0.assert_called_once()
         self.assertEqual(inst.settemp.call_count, 10)
         self.assertEqual(inst.setmag.call_count, 10 * 10)
-        self.assertEqual(
-            self.check_mevents_mock.call_count, 10 * 10
-        )
+        self.assertEqual(self.check_mevents_mock.call_count, 10 * 10)
 
     @patch.dict("sys.modules", inst=inst)
     @patch("six.moves.builtins.eval")
@@ -60,9 +58,7 @@ def test_GIVEN_temp_scan_field_point_WHEN_run_THEN_setmag_called_once_AND_scan_r
         inst.lf0.assert_called_once()
         self.assertEqual(inst.settemp.call_count, 10)
         inst.setmag.assert_called_once()
-        self.assertEqual(
-            self.check_mevents_mock.call_count, 10
-        )
+        self.assertEqual(self.check_mevents_mock.call_count, 10)
 
     @patch.dict("sys.modules", inst=inst)
     @patch("six.moves.builtins.eval")
@@ -85,9 +81,7 @@ def test_GIVEN_field_scan_temp_point_WHEN_run_THEN_settemp_called_once_AND_scan_
         inst.tf0.assert_called_once()
         inst.settemp.assert_called_once()
         self.assertEqual(inst.setmag.call_count, 10)
-        self.assertEqual(
-            self.check_mevents_mock.call_count, 10
-        )
+        self.assertEqual(self.check_mevents_mock.call_count, 10)
 
     @patch.dict("sys.modules", inst=inst)
     @patch("six.moves.builtins.eval")
@@ -133,9 +127,7 @@ def test_GIVEN_one_of_start_stop_field_is_keep_AND_temp_scan_WHEN_run_THEN_setma
         inst.tf0.assert_not_called()
         self.assertEqual(inst.settemp.call_count, 10)
         inst.setmag.assert_not_called()
-        self.assertEqual(
-            self.check_mevents_mock.call_count, 10
-        )
+        self.assertEqual(self.check_mevents_mock.call_count, 10)
 
     @patch.dict("sys.modules", inst=inst)
     @patch("six.moves.builtins.eval")
@@ -181,9 +173,7 @@ def test_GIVEN_one_of_start_stop_temp_is_keep_AND_field_scan_WHEN_run_THEN_sette
         inst.tf0.assert_called_once()
         self.assertEqual(inst.setmag.call_count, 10)
         inst.settemp.assert_not_called()
-        self.assertEqual(
-            self.check_mevents_mock.call_count, 10
-        )
+        self.assertEqual(self.check_mevents_mock.call_count, 10)
 
     @patch.dict("sys.modules", inst=inst)
     @patch("six.moves.builtins.eval")