move configure_sim_modes from static method to simulation module

Author: wxtim

cylc/flow/config.py

@@ -80,12 +80,7 @@
     is_relative_to,
 )
 from cylc.flow.print_tree import print_tree
-from cylc.flow.simulation import (
-    parse_fail_cycle_points,
-    get_simulated_run_len,
-    build_simulation_script,
-    disable_platforms,
-)
+from cylc.flow.simulation import configure_sim_modes
 from cylc.flow.subprocctx import SubFuncContext
 from cylc.flow.task_events_mgr import (
     EventData,
@@ -526,7 +521,7 @@ def __init__(
         self.process_runahead_limit()
 
         if self.run_mode('simulation', 'dummy'):
-            self.configure_sim_modes(
+            configure_sim_modes(
                 self.taskdefs.values(), self.run_mode())
 
         self.configure_workflow_state_polling_tasks()
@@ -1346,47 +1341,6 @@ def configure_workflow_state_polling_tasks(self):
             script = "echo " + comstr + "\n" + comstr
             rtc['script'] = script
 
-    @staticmethod
-    def configure_sim_modes(taskdefs, sim_mode):
-        """Adjust task defs for simulation and dummy mode.
-
-        """
-        dummy_mode = bool(sim_mode == 'dummy')
-
-        for tdef in taskdefs:
-            # Compute simulated run time by scaling the execution limit.
-            rtc = tdef.rtconfig
-            sleep_sec = get_simulated_run_len(rtc)
-
-            rtc['execution time limit'] = (
-                sleep_sec + DurationParser().parse(str(
-                    rtc['simulation']['time limit buffer'])).get_seconds()
-            )
-
-            rtc['simulation']['simulated run length'] = sleep_sec
-            rtc['submission retry delays'] = [1]
-
-            # Generate dummy scripting.
-            rtc['init-script'] = ""
-            rtc['env-script'] = ""
-            rtc['pre-script'] = ""
-            rtc['post-script'] = ""
-            rtc['script'] = build_simulation_script(
-                rtc, sleep_sec) if dummy_mode else ""
-
-            disable_platforms(rtc)
-
-            rtc['platform'] = 'localhost'
-
-            # Disable environment, in case it depends on env-script.
-            rtc['environment'] = {}
-
-            rtc["simulation"][
-                "fail cycle points"
-            ] = parse_fail_cycle_points(
-                rtc["simulation"]["fail cycle points"]
-            )
-
     def get_parent_lists(self):
         return self.runtime['parents']
 

cylc/flow/simulation.py

@@ -35,6 +35,47 @@
 from metomi.isodatetime.parsers import DurationParser
 
 
+def configure_sim_modes(taskdefs, sim_mode):
+    """Adjust task defs for simulation and dummy mode.
+
+    """
+    dummy_mode = bool(sim_mode == 'dummy')
+
+    for tdef in taskdefs:
+        # Compute simulated run time by scaling the execution limit.
+        rtc = tdef.rtconfig
+        sleep_sec = get_simulated_run_len(rtc)
+
+        rtc['execution time limit'] = (
+            sleep_sec + DurationParser().parse(str(
+                rtc['simulation']['time limit buffer'])).get_seconds()
+        )
+
+        rtc['simulation']['simulated run length'] = sleep_sec
+        rtc['submission retry delays'] = [1]
+
+        # Generate dummy scripting.
+        rtc['init-script'] = ""
+        rtc['env-script'] = ""
+        rtc['pre-script'] = ""
+        rtc['post-script'] = ""
+        rtc['script'] = build_simulation_script(
+            rtc, sleep_sec) if dummy_mode else ""
+
+        disable_platforms(rtc)
+
+        rtc['platform'] = 'localhost'
+
+        # Disable environment, in case it depends on env-script.
+        rtc['environment'] = {}
+
+        rtc["simulation"][
+            "fail cycle points"
+        ] = parse_fail_cycle_points(
+            rtc["simulation"]["fail cycle points"]
+        )
+
+
 def get_simulated_run_len(rtc: Dict[str, Any]) -> int:
     """Get simulated run time.
 

tests/integration/test_modes.py

@@ -113,4 +113,4 @@ async def test_mode_task_basic(
     assert (
         pytest.approx(timers['sped_up_etl'], rel=0.2)
         == sim_times['sped_up_etl']
-    )
+    )

tests/unit/test_config.py

@@ -39,12 +39,13 @@
 from cylc.flow.parsec.exceptions import Jinja2Error, EmPyError
 from cylc.flow.scheduler_cli import RunOptions
 from cylc.flow.scripts.validate import ValidateOptions
+from cylc.flow.simulation import configure_sim_modes
 from cylc.flow.workflow_files import WorkflowFiles
 from cylc.flow.wallclock import get_utc_mode, set_utc_mode
 from cylc.flow.xtrigger_mgr import XtriggerManager
 from cylc.flow.task_outputs import (
     TASK_OUTPUT_SUBMITTED,
-    TASK_OUTPUT_SUCCEEDED
+    TASK_OUTPUT_SUCCEEDED,
 )
 
 from cylc.flow.cycling.iso8601 import ISO8601Point
@@ -1767,7 +1768,7 @@ def test_configure_sim_mode(caplog):
         SimpleNamespace(rtconfig=rtconfig_1),
         SimpleNamespace(rtconfig=rtconfig_2),
     ]
-    WorkflowConfig.configure_sim_modes(taskdefs, 'simulation')
+    configure_sim_modes(taskdefs, 'simulation')
     results = [
         i.rtconfig['simulation']['simulated run length'] for i in taskdefs]
     assert results == [10.0, 2.0]