Merge pull request #7048 from MetRonnie/icp-nonsense

Fix icp = now changing on reload

Author: MetRonnie

changes.d/7048.fix.md

@@ -0,0 +1 @@
+Stopped the evaluated value of `initial cycle point = now` changing on reload/restart.

cylc/flow/commands.py

@@ -568,6 +568,10 @@ async def reload_workflow(schd: 'Scheduler', reload_global: bool = False):
         schd.reload_pending = 'loading the workflow definition'
         schd.update_data_store()  # update workflow status msg
         schd._update_workflow_state()
+        # Things that can't change on workflow reload:
+        schd._set_workflow_params(
+            schd.workflow_db_mgr.pri_dao.select_workflow_params()
+        )
         LOG.info("Reloading the workflow definition.")
         config = schd.load_flow_file(is_reload=True)
     except (ParsecError, CylcConfigError) as exc:
@@ -589,10 +593,7 @@ async def reload_workflow(schd: 'Scheduler', reload_global: bool = False):
     else:
         schd.reload_pending = 'applying the new config'
         old_tasks = set(schd.config.get_task_name_list())
-        # Things that can't change on workflow reload:
-        schd._set_workflow_params(
-            schd.workflow_db_mgr.pri_dao.select_workflow_params()
-        )
+
         schd.apply_new_config(config, is_reload=True)
         schd.broadcast_mgr.linearized_ancestors = (
             schd.config.get_linearized_ancestors()

cylc/flow/config.py

@@ -379,7 +379,8 @@ def __init__(
             raise WorkflowConfigError("missing [scheduling][[graph]] section.")
         # (The check that 'graph' is defined is below).
 
-        # Override the workflow defn with an initial point from the CLI.
+        # Override the workflow defn with an initial point from the CLI
+        # or from reload/restart:
         icp_str = getattr(self.options, 'icp', None)
         if icp_str is not None:
             self.cfg['scheduling']['initial cycle point'] = icp_str
@@ -564,7 +565,7 @@ def __init__(
         self._upg_wflow_event_names()
 
         self.mem_log("config.py: before load_graph()")
-        self.load_graph()
+        self._load_graph()
         self.mem_log("config.py: after load_graph()")
 
         self._set_completion_expressions()
@@ -684,10 +685,10 @@ def prelim_process_graph(self) -> None:
             all(item in ['graph', '1', 'R1'] for item in graphdict)
         ):
             # Pure acyclic graph, assume integer cycling mode with '1' cycle
-            self.cfg['scheduling']['cycling mode'] = INTEGER_CYCLING_TYPE
             for key in ('initial cycle point', 'final cycle point'):
                 if key not in self.cfg['scheduling']:
                     self.cfg['scheduling'][key] = '1'
+            self.cfg['scheduling']['cycling mode'] = INTEGER_CYCLING_TYPE
 
     def process_utc_mode(self):
         """Set UTC mode from config or from stored value on restart.
@@ -761,7 +762,6 @@ def process_initial_cycle_point(self) -> None:
         Sets:
             self.initial_point
             self.cfg['scheduling']['initial cycle point']
-            self.evaluated_icp
         Raises:
             WorkflowConfigError - if it fails to validate
         """
@@ -775,11 +775,6 @@ def process_initial_cycle_point(self) -> None:
                 raise WorkflowConfigError(
                     "This workflow requires an initial cycle point.")
             icp = _parse_iso_cycle_point(orig_icp)
-        self.evaluated_icp = None
-        if icp != orig_icp:
-            # now/next()/previous() was used, need to store
-            # evaluated point in DB
-            self.evaluated_icp = icp
         self.initial_point = get_point(icp).standardise()
         self.cfg['scheduling']['initial cycle point'] = str(self.initial_point)
 
@@ -2312,7 +2307,7 @@ def _close_families(l_id, r_id, clf_map):
 
         return lret, rret
 
-    def load_graph(self):
+    def _load_graph(self):
         """Parse and load dependency graph."""
         LOG.debug("Parsing the dependency graph")
 
@@ -2336,18 +2331,14 @@ def load_graph(self):
             section = get_sequence_cls().get_async_expr()
             graphdict[section] = graphdict.pop('graph')
 
-        icp = self.cfg['scheduling']['initial cycle point']
+        icp = str(self.initial_point)
         fcp = self.cfg['scheduling']['final cycle point']
 
         # Make a stack of sections and graphs [(sec1, graph1), ...]
         sections = []
         for section, value in self.cfg['scheduling']['graph'].items():
             # Substitute initial and final cycle points.
-            if icp:
-                section = section.replace("^", icp)
-            elif "^" in section:
-                raise WorkflowConfigError("Initial cycle point referenced"
-                                          " (^) but not defined.")
+            section = section.replace("^", icp)
             if fcp:
                 section = section.replace("$", fcp)
             elif "$" in section:

cylc/flow/cycling/integer.py

@@ -594,7 +594,7 @@ def init_from_cfg(_):
     pass
 
 
-def get_dump_format(cycling_type=None):
+def get_dump_format() -> None:
     """Return cycle point string dump format."""
     # Not used for integer cycling.
     return None

cylc/flow/cycling/iso8601.py

@@ -649,6 +649,9 @@ def __lt__(self, other):
     def __str__(self):
         return self.value
 
+    def __repr__(self) -> str:
+        return f"<{type(self).__name__} {self.value}>"
+
     def __hash__(self) -> int:
         return hash(self.value)
 
@@ -902,7 +905,7 @@ def init(num_expanded_year_digits=0, custom_dump_format=None, time_zone=None,
     return WorkflowSpecifics
 
 
-def get_dump_format():
+def get_dump_format() -> str:
     """Return cycle point string dump format."""
     return WorkflowSpecifics.DUMP_FORMAT
 

cylc/flow/cycling/loader.py

@@ -19,11 +19,21 @@
 Each task may have multiple sequences, e.g. 12-hourly and 6-hourly.
 """
 
-from typing import Optional, Type, overload
+from typing import (
+    Literal,
+    Optional,
+    Type,
+    overload,
+)
 
-from cylc.flow.cycling import PointBase, integer, iso8601
 from metomi.isodatetime.data import Calendar
 
+from cylc.flow.cycling import (
+    PointBase,
+    integer,
+    iso8601,
+)
+
 
 ISO8601_CYCLING_TYPE = iso8601.CYCLER_TYPE_ISO8601
 INTEGER_CYCLING_TYPE = integer.CYCLER_TYPE_INTEGER
@@ -88,8 +98,18 @@ def get_point_cls(cycling_type: Optional[str] = None) -> Type[PointBase]:
     return POINTS[cycling_type]
 
 
-def get_dump_format(cycling_type=None):
-    """Return cycle point dump format, or None."""
+@overload
+def get_dump_format(cycling_type: Literal["integer"]) -> None:
+    ...
+
+
+@overload
+def get_dump_format(cycling_type: Literal["iso8601"]) -> str:
+    ...
+
+
+def get_dump_format(cycling_type: Literal["integer", "iso8601"]) -> str | None:
+    """Return cycle point dump format (None for integer mode)."""
     return DUMP_FORMAT_GETTERS[cycling_type]()
 
 

cylc/flow/scheduler.py

@@ -1228,7 +1228,7 @@ def apply_new_config(self, config, is_reload=False):
         })
 
     def _set_workflow_params(
-        self, params: Iterable[Tuple[str, Optional[str]]]
+        self, params: Iterable[tuple[str, str | None]]
     ) -> None:
         """Set workflow params on restart/reload.
 
@@ -1240,20 +1240,20 @@ def _set_workflow_params(
         * A flag to indicate if the workflow should be paused or not.
         * Original workflow run time zone.
         """
-        LOG.info('LOADING workflow parameters')
+        LOG.info("LOADING saved workflow parameters")
         for key, value in params:
             if key == self.workflow_db_mgr.KEY_RUN_MODE:
                 self.options.run_mode = value or RunMode.LIVE.value
                 LOG.info(f"+ run mode = {value}")
             if value is None:
                 continue
-            if key in self.workflow_db_mgr.KEY_INITIAL_CYCLE_POINT_COMPATS:
+            if key == self.workflow_db_mgr.KEY_INITIAL_CYCLE_POINT:
                 self.options.icp = value
                 LOG.info(f"+ initial point = {value}")
-            elif key in self.workflow_db_mgr.KEY_START_CYCLE_POINT_COMPATS:
+            elif key == self.workflow_db_mgr.KEY_START_CYCLE_POINT:
                 self.options.startcp = value
                 LOG.info(f"+ start point = {value}")
-            elif key in self.workflow_db_mgr.KEY_FINAL_CYCLE_POINT_COMPATS:
+            elif key == self.workflow_db_mgr.KEY_FINAL_CYCLE_POINT:
                 if self.is_restart and self.options.fcp == 'reload':
                     LOG.debug(f"- final point = {value} (ignored)")
                 elif self.options.fcp is None:

cylc/flow/workflow_db_mgr.py

@@ -95,13 +95,8 @@ class WorkflowDatabaseManager:
     """Manage the workflow runtime private and public databases."""
 
     KEY_INITIAL_CYCLE_POINT = 'icp'
-    KEY_INITIAL_CYCLE_POINT_COMPATS = (
-        KEY_INITIAL_CYCLE_POINT, 'initial_point')
     KEY_START_CYCLE_POINT = 'startcp'
-    KEY_START_CYCLE_POINT_COMPATS = (
-        KEY_START_CYCLE_POINT, 'start_point')
     KEY_FINAL_CYCLE_POINT = 'fcp'
-    KEY_FINAL_CYCLE_POINT_COMPATS = (KEY_FINAL_CYCLE_POINT, 'final_point')
     KEY_STOP_CYCLE_POINT = 'stopcp'
     KEY_UUID_STR = 'uuid_str'
     KEY_CYLC_VERSION = 'cylc_version'
@@ -337,7 +332,7 @@ def put_workflow_params(self, schd: 'Scheduler') -> None:
         This method queues the relevant insert statements.
 
         Arguments:
-            schd (cylc.flow.scheduler.Scheduler): scheduler object.
+            schd: scheduler object.
         """
         self.db_deletes_map[self.TABLE_WORKFLOW_PARAMS].append({})
         self.db_inserts_map[self.TABLE_WORKFLOW_PARAMS].extend([
@@ -353,11 +348,8 @@ def put_workflow_params(self, schd: 'Scheduler') -> None:
         ])
 
         # Store raw initial cycle point in the DB.
-        value = schd.config.evaluated_icp
-        value = None if value == 'reload' else value
         self.put_workflow_params_1(
-            self.KEY_INITIAL_CYCLE_POINT,
-            value or str(schd.config.initial_point)
+            self.KEY_INITIAL_CYCLE_POINT, str(schd.config.initial_point)
         )
 
         for key in (

tests/functional/cylc-combination-scripts/09-vr-icp-now.t

@@ -16,7 +16,8 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #------------------------------------------------------------------------------
-# Ensure that validate step of Cylc VR cannot change the options object.
+# Ensure that validate step of `cylc vr` does not set the --icp option for the
+# restart step, as this would cause an InputError.
 # See https://github.com/cylc/cylc-flow/issues/6262
 
 . "$(dirname "$0")/test_header"
@@ -26,14 +27,13 @@ WORKFLOW_ID=$(workflow_id)
 
 cp -r "${TEST_SOURCE_DIR}/${TEST_NAME_BASE}/flow.cylc" .
 
-run_ok "${TEST_NAME_BASE}-vip" \
-    cylc vip . \
-        --workflow-name "${WORKFLOW_ID}" \
-        --no-detach \
-        --no-run-name
+run_ok "${TEST_NAME_BASE}-vip" cylc vip . \
+    --workflow-name "${WORKFLOW_ID}" \
+    --no-detach \
+    --no-run-name \
+    --mode simulation
 
 echo "# Some Comment" >> flow.cylc
 
 run_ok "${TEST_NAME_BASE}-vr" \
-    cylc vr "${WORKFLOW_ID}" \
-        --stop-cycle-point 2020-01-01T00:02Z
+    cylc vr "${WORKFLOW_ID}" --no-detach --mode simulation

tests/functional/cylc-combination-scripts/09-vr-icp-now/flow.cylc

@@ -1,8 +1,11 @@
+[scheduler]
+    [[events]]
+        restart timeout = PT0S
 [scheduling]
     initial cycle point = 2020
-    stop after cycle point = 2020-01-01T00:01Z
+    final cycle point = 2020
     [[graph]]
-        PT1M = foo
+        P1Y = foo
 [runtime]
     [[foo]]
         [[[simulation]]]