Pulled get steps out as utility function

Author: LowriJenkins

emuloop.py

@@ -6,6 +6,8 @@
 from genie_python import genie as g
 from genie_python.genie_script_generator import ScriptDefinition, cast_parameters_to
 
+from script_utilities import get_steps
+
 
 class SetDefinition(Enum):
     """
@@ -104,16 +106,7 @@ def inclusive_float_range_with_step_flip(start: float, stop: float, step: float)
       >>> inclusive_float_range_with_step_flip(0.5, 2, 0.5) == [0.5, 1, 1.5, 2]
       >>> inclusive_float_range_with_step_flip(2, 0.5, 0.5) == [2, 1.5, 1, 0.5]
     """
-    modulo = abs(stop - start) % abs(step)
-    if stop > start:
-        vstop = stop - modulo
-    else:
-        vstop = stop + modulo
-    for i in np.linspace(start, vstop, int(abs(vstop - start) / abs(step)) + 1):
-        if ((i >= start) and (i <= stop)) or (
-            (i >= stop) and (i <= start)
-        ):  # Check inserted here to ensure scan remains within defined range
-            yield i
+    yield from get_steps(start, step, stop)
 
 
 class DoRun(ScriptDefinition):

emulooptime.py

@@ -6,6 +6,8 @@
 from genie_python import genie as g
 from genie_python.genie_script_generator import ScriptDefinition, cast_parameters_to
 
+from script_utilities import get_steps
+
 
 class SetDefinition(Enum):
     """
@@ -104,16 +106,7 @@ def inclusive_float_range_with_step_flip(start: float, stop: float, step: float)
       >>> inclusive_float_range_with_step_flip(0.5, 2, 0.5) == [0.5, 1, 1.5, 2]
       >>> inclusive_float_range_with_step_flip(2, 0.5, 0.5) == [2, 1.5, 1, 0.5]
     """
-    modulo = abs(stop - start) % abs(step)
-    if stop > start:
-        vstop = stop - modulo
-    else:
-        vstop = stop + modulo
-    for i in np.linspace(start, vstop, int(abs(vstop - start) / abs(step)) + 1):
-        if ((i >= start) and (i <= stop)) or (
-            (i >= stop) and (i <= start)
-        ):  # Check inserted here to ensure scan remains within defined range
-            yield i
+    yield from get_steps(start, step, stop)
 
 
 class DoRun(ScriptDefinition):

example_loop.py

@@ -1,9 +1,10 @@
 from typing import Generator, Optional
 
-import numpy as np
 from genie_python import genie as g
 from genie_python.genie_script_generator import ScriptDefinition, cast_parameters_to
 
+from script_utilities import get_steps
+
 
 def inclusive_float_range_with_step_flip(start: float, stop: float, step: float) -> Generator:
     """
@@ -23,16 +24,7 @@ def inclusive_float_range_with_step_flip(start: float, stop: float, step: float)
       >>> inclusive_float_range_with_step_flip(2, 0.5, 0.5) == [2, 1.5, 1, 0.5]
     """
     # Get the modulo so we know to stop early like arrange if the steps don't fit evenly.
-    modulo = abs(stop - start) % abs(step)
-    if stop > start:
-        vstop = stop - modulo
-    else:
-        vstop = stop + modulo
-    for i in np.linspace(start, vstop, int(abs(vstop - start) / abs(step)) + 1):
-        if ((i >= start) and (i <= stop)) or (
-            (i >= stop) and (i <= start)
-        ):  # Check inserted here to ensure scan remains within defined range
-            yield i
+    yield from get_steps(start, step, stop)
 
 
 class DoRun(ScriptDefinition):

script_utilities.py

@@ -0,0 +1,16 @@
+from typing import Generator
+
+import numpy as np
+
+
+def get_steps(start: float, step: float, stop: float) -> Generator[float, None, None]:
+    modulo = abs(stop - start) % abs(step)
+    if stop > start:
+        vstop = stop - modulo
+    else:
+        vstop = stop + modulo
+    for i in np.linspace(start, vstop, int(abs(vstop - start) / abs(step)) + 1):
+        if ((i >= start) and (i <= stop)) or (
+            (i >= stop) and (i <= start)
+        ):  # Check inserted here to ensure scan remains within defined range
+            yield i

test_emu/test_casters.py

@@ -1,6 +1,5 @@
 import unittest
 
-import numpy as np
 from hamcrest import assert_that, calling, raises
 
 from emuloop import cast_custom_expression as cast_custom_expression_emuloop
@@ -10,6 +9,7 @@
 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 script_utilities import get_steps
 
 
 class TestMagnetCaster(unittest.TestCase):
@@ -82,7 +82,7 @@ def test_GIVEN_keep_different_cases_WHEN_cast_THEN_return_none(self):
         self.assertIsNone(float_or_keep_emuloop(keep.upper()))
 
     def test_GIVEN_string_convertable_to_float_WHEN_cast_THEN_return_casted_value(self):
-        for float_val in np.linspace(4.0, 5.0, int(abs(4.0 - 5.0) / 0.2) + 1):
+        for float_val in get_steps(4.0, 0.2, 5.0):
             self.assertEqual(float_or_keep_emu(str(float_val)), float_val)
             self.assertEqual(float_or_keep_emuloop(str(float_val)), float_val)