Rename to avoid inmem confusion

Author: linsword13

lib/ramble/ramble/language/shared_language.py

@@ -105,7 +105,7 @@ def figure_of_merit(
     contexts=None,
     fom_type: FomType = FomType.UNDEFINED,
     when=None,
-    inmem_key=None,
+    fom_map_key=None,
     **kwargs,
 ):
     """Adds a figure of merit to track for this object
@@ -123,12 +123,12 @@ def figure_of_merit(
                                    should exist in.
       fom_type (ramble.util.foms.FomType): The type of figure of merit
       when (list | None): List of when conditions to apply to directive
-      inmem_key: If supplied, this is treated as an in-memory (as ooposed to file-based)
-                 figure of merit, and its value is extracted using this key
+      fom_map_key: If supplied, this is treated as an in-memory (as ooposed to file-based)
+                   figure of merit, and its value is extracted using this key
     """
 
     def _execute_figure_of_merit(obj):
-        if inmem_key is None:
+        if fom_map_key is None:
             if fom_regex is None or group_name is None:
                 raise ramble.language.language_base.DirectiveError(
                     "`fom_regex` and `group_name` are required for defining file-based FOM"
@@ -154,7 +154,7 @@ def _execute_figure_of_merit(obj):
             "fom_type": fom_type,
             "when": when_list,
             "origin_type": obj.origin_type if hasattr(obj, "origin_type") else "",
-            "inmem_key": inmem_key,
+            "fom_map_key": fom_map_key,
         }
 
     return _execute_figure_of_merit

lib/ramble/ramble/test/application_language.py

@@ -293,11 +293,11 @@ def test_figure_of_merit_directive_required_args():
     app_inst.figure_of_merit(
         "test_inmem_fom",
         units="s",
-        inmem_key="test_inmem_key",
+        fom_map_key="test_fom_map_key",
     )
     foms = list(list(app_inst.figures_of_merit.values())[0].values())[0]
     assert len(foms) == 1
-    assert foms["test_inmem_fom"]["inmem_key"] == "test_inmem_key"
+    assert foms["test_inmem_fom"]["fom_map_key"] == "test_fom_map_key"
 
 
 @pytest.mark.parametrize("app_class", app_types)

var/ramble/repos/builtin.mock/applications/expanded_foms/application.py

@@ -40,7 +40,7 @@ class ExpandedFoms(ExecutableApplication):
     figure_of_merit(
         "test_inmem_{my_var}",
         units="",
-        inmem_key="test_inmem",
+        fom_map_key="test_inmem",
     )
 
     success_criteria("Run", mode="string", match=r"Collect", file="{log_file}")

var/ramble/repos/builtin/base_classes/application-base/base_class.py

@@ -196,7 +196,8 @@ def __init__(self, file_path):
         self._input_lock = None
         self._software_lock = None
         self._experiment_graph = None
-        self._inmem_fom_values = {}
+        # A dict storing fom values, currently it only stores inmem FOMs
+        self._fom_map = {}
 
         # Ensure we always have the application name, and this is never empty
         self.license_names = self.license_names + [self.name]
@@ -2211,8 +2212,8 @@ def _extract_inmem_foms(self, inmem_fom_defs, fom_values):
                 fom_name = fom_conf["fom_name_expanded"]
                 # TODO: this can be extended to support derived FOMs,
                 # since the `fom_values` contains resolved file-based FOMs
-                inmem_key = fom_conf["inmem_key"]
-                fom_value = self._inmem_fom_values.get(inmem_key)
+                fom_map_key = fom_conf["fom_map_key"]
+                fom_value = self._fom_map.get(fom_map_key)
                 expanded_fom_value = self.expander.expand_var(fom_value)
                 fom_values[context][fom_name] = {
                     "value": expanded_fom_value,
@@ -2900,7 +2901,7 @@ def _preset_context_dict(dest_def_dict, context):
                                     }
 
                         for fom, source_def in source_foms.items():
-                            is_inmem = source_def["inmem_key"] is not None
+                            is_inmem = source_def["fom_map_key"] is not None
                             dest_def_dict = (
                                 inmem_fom_defs if is_inmem else file_fom_defs
                             )
@@ -2945,7 +2946,7 @@ def _try_expand_var_or_none(var: str, expander):
                                     )
                                 ),
                                 "fom_type": source_def["fom_type"].to_dict(),
-                                "inmem_key": source_def["inmem_key"],
+                                "fom_map_key": source_def["fom_map_key"],
                                 # If expansion works (i.e., it doesn't rely on the matched fom
                                 # groups), then cache it here to avoid repeated expansion later.
                                 "units_expanded": _try_expand_var_or_none(
@@ -2983,9 +2984,9 @@ def _try_expand_var_or_none(var: str, expander):
 
         return files, file_fom_defs, inmem_fom_defs
 
-    def add_inmem_fom_value(self, inmem_key, value):
+    def add_inmem_fom_value(self, fom_map_key, value):
         """Add value to an in-memory FOM"""
-        self._inmem_fom_values[inmem_key] = value
+        self._fom_map[fom_map_key] = value
 
     def read_status(self):
         """Read status from an experiment's status file, if possible.