update grouping default to new lockfile mechanism

validphys2/src/validphys/config.py

@@ -1312,52 +1312,22 @@ def parse_metadata_group(self, group: str):
         return group
 
     @record_from_defaults
-    def parse_data_grouping(self, key):
-        """a key which indicates which default grouping to use. Mainly for
-        internal use. It allows the default grouping of experiment to be applied
-        to runcards which don't specify `metadata_group` without there being
-        a namespace conflict in the lockfile
-
-        """
-        return key
-
-    def load_default_data_grouping(self, spec):
-        """Load the default grouping of data"""
-        # slightly superfluous, only one default at present but perhaps
-        # somebody will want to add to this at some point e.g for th. uncertainties
-        allowed = {
-            "standard_report": "experiment",
-        }
-        return allowed[spec]
-
-    def produce_processed_data_grouping(
-        self, data_grouping=None, data_grouping_recorded_spec_=None
-    ):
-        """Process the data_grouping key from the runcard, or lockfile. If
-        `data_grouping_recorded_spec_` is present then its value is taken, and
-        the runcard is assumed to be a lockfile.
-
-        If data_grouping is None, then fall back to old behaviour of grouping
-        by experiment.
-
-        Else, the user can specfiy their own grouping, for example metadata_process.
+    def produce_metadata_group_default(self):
+        """Default dataset grouping to use if ``metadata_group`` is not
+        specified by the user.
         """
-        if data_grouping is None:
-            # fallback to old default behaviour, but still record to lockfile
-            data_grouping = self.parse_data_grouping("standard_report")
-        if data_grouping_recorded_spec_ is not None:
-            return data_grouping_recorded_spec_[data_grouping]
-        return self.load_default_data_grouping(data_grouping)
+        return "experiment"
 
     def produce_processed_metadata_group(
-        self, processed_data_grouping, metadata_group=None
+        self, metadata_group_default, metadata_group=None
     ):
         """Expose the final data grouping result. Either metadata_group is
-        specified by user, in which case uses `processed_data_grouping` which
-        is experiment by default.
+        specified by user or take the default grouping from
+        ``metadata_group_default``
+
         """
         if metadata_group is None:
-            return processed_data_grouping
+            return metadata_group_default
         return metadata_group
 
 

validphys2/src/validphys/tests/test_metaexps.py → validphys2/src/validphys/tests/test_metagroups.py

@@ -1,8 +1,8 @@
 """
-test_metaexps
+test_metagroups
 
-Test that the experiments key defined in the commondata meta data, which is
-subsequently used for grouping makes sense.
+Test the grouping mechanism which uses the commondata meta data to group
+datasets.
 
 """
 from validphys.api import API
@@ -29,3 +29,24 @@ def test_no_systematic_overlaps():
     assert isinstance(
         res, str
     ), f"Overlap found between metadata experiments {res[0]} {res[1]}"
+
+def test_grouping_defaults():
+    """Check that the fallback default for metadata group is working properly.
+    ``metadata_group`` should take precedence, followed by lockfile key
+    ``metadata_group_default_recorded_spec_`` finally the current default
+    produced by ``metadata_group_default``
+
+    """
+    # check current default
+    assert API.processed_metadata_group() == "experiment"
+
+    # check explicit key takes precedence
+    assert API.processed_metadata_group(metadata_group="foo") == "foo"
+
+    # check lockkey
+    assert API.processed_metadata_group(
+        metadata_group_default_recorded_spec_="bar") == "bar"
+
+    # check explicit key still takes precedence
+    assert API.processed_metadata_group(
+        metadata_group_default_recorded_spec_="bar", metadata_group="foo") == "foo"