Change names with key_value to metadata

Author: cschwan

pineappl/src/fk_table.rs

@@ -7,6 +7,7 @@ use super::grid::Grid;
 use super::pids::OptRules;
 use super::subgrid::{self, EmptySubgridV1, Subgrid};
 use ndarray::{s, ArrayD};
+use std::collections::BTreeMap;
 use std::fmt::{self, Display, Formatter};
 use std::iter;
 use std::str::FromStr;
@@ -215,11 +216,9 @@ impl FkTable {
         }
     }
 
-    /// Set a metadata key-value pair for this FK table.
-    pub fn set_key_value(&mut self, key: &str, value: &str) {
-        self.grid
-            .metadata_mut()
-            .insert(key.to_owned(), value.to_owned());
+    /// Return the metadata of this FK-table.
+    pub fn metadata_mut(&mut self) -> &mut BTreeMap<String, String> {
+        self.grid.metadata_mut()
     }
 
     /// Returns the x grid that all subgrids for all hadronic initial states share.

pineappl_py/src/fk_table.rs

@@ -248,8 +248,10 @@ impl PyFkTable {
     ///     key
     /// value : str
     ///     value
-    pub fn set_key_value(&mut self, key: &str, value: &str) {
-        self.fk_table.set_key_value(key, value);
+    pub fn set_metadata(&mut self, key: &str, value: &str) {
+        self.fk_table
+            .metadata_mut()
+            .insert(key.to_owned(), value.to_owned());
     }
 
     /// Get metadata values stored in the grid.
@@ -261,7 +263,7 @@ impl PyFkTable {
     ///     key, value map
     #[getter]
     #[must_use]
-    pub fn key_values(&self) -> BTreeMap<String, String> {
+    pub fn metadata(&self) -> BTreeMap<String, String> {
         self.fk_table.grid().metadata().clone()
     }
 

pineappl_py/src/grid.rs

@@ -332,7 +332,7 @@ impl PyGrid {
     ///     key
     /// value : str
     ///     value
-    pub fn set_key_value(&mut self, key: &str, value: &str) {
+    pub fn set_metadata(&mut self, key: &str, value: &str) {
         self.grid
             .metadata_mut()
             .insert(key.to_owned(), value.to_owned());
@@ -347,7 +347,7 @@ impl PyGrid {
     ///     key, value map
     #[getter]
     #[must_use]
-    pub fn key_values(&self) -> BTreeMap<String, String> {
+    pub fn metadata(&self) -> BTreeMap<String, String> {
         self.grid.metadata().clone()
     }
 

pineappl_py/tests/test_fk_table.py

@@ -88,13 +88,13 @@ def test_fktable(
         np.testing.assert_allclose(bin_limits[:, 0, 0], [0.0])
         np.testing.assert_allclose(bin_limits[:, 0, 1], [1.0])
 
-        # Check setting key values
-        fk.set_key_value("bla", "blub")
-        fk.set_key_value('"', "'")
-        fk.set_key_value("äöü", "ß\\")
-        assert fk.key_values["bla"] == "blub"
-        assert fk.key_values['"'] == "'"
-        assert fk.key_values["äöü"] == "ß\\"
+        # Check setting metadata
+        fk.set_metadata("bla", "blub")
+        fk.set_metadata('"', "'")
+        fk.set_metadata("äöü", "ß\\")
+        assert fk.metadata["bla"] == "blub"
+        assert fk.metadata['"'] == "'"
+        assert fk.metadata["äöü"] == "ß\\"
 
         # Check the various aspects of the Channels
         channels = fk.channels()

pineappl_py/tests/test_grid.py

@@ -609,20 +609,20 @@ def test_io(self, tmp_path, fake_grids):
         assert isinstance(gg, Grid)
         _ = Grid.read(str(p))
 
-    def test_key_values(self, fake_grids):
+    def test_metadata(self, fake_grids):
         g = fake_grids.grid_with_generic_convolution(
             nb_convolutions=2,
             channels=CHANNELS,
             orders=ORDERS,
             convolutions=[CONVOBJECT, CONVOBJECT],
         )
-        g.set_key_value("bla", "blub")
-        g.set_key_value('"', "'")
-        g.set_key_value("äöü", "ß\\")
+        g.set_metadata("bla", "blub")
+        g.set_metadata('"', "'")
+        g.set_metadata("äöü", "ß\\")
 
-        assert g.key_values["bla"] == "blub"
-        assert g.key_values['"'] == "'"
-        assert g.key_values["äöü"] == "ß\\"
+        assert g.metadata["bla"] == "blub"
+        assert g.metadata['"'] == "'"
+        assert g.metadata["äöü"] == "ß\\"
 
     def test_pid_basis(self, fake_grids):
         g = fake_grids.grid_with_generic_convolution(