Modified search to take in multiple strings

src/pybamm/util.py

@@ -102,38 +102,43 @@ def __getitem__(self, key):
                 f"'{key}' not found. Best matches are {best_matches}"
             ) from error
 
-    def search(self, key, print_values=False):
+    def search(self, keys, print_values=False):
         """
-        Search dictionary for keys containing 'key'. If print_values is True, then
-        both the keys and values will be printed. Otherwise just the values will
-        be printed. If no results are found, the best matches are printed.
+        Search dictionary for keys containing all terms in 'keys'.
+        If print_values is True, both the keys and values will be printed.
+        Otherwise, just the keys will be printed. If no results are found,
+        the best matches are printed.
         """
-        key_in = key
-        key = key_in.lower()
+        if isinstance(keys, str):
+            search_keys = [keys]
+        else:
+            search_keys = keys.copy()
+
+        search_keys = [k.lower() for k in search_keys]
 
-        # Sort the keys so results are stored in alphabetical order
-        keys = list(self.keys())
-        keys.sort()
+        known_keys = list(self.keys())
+        known_keys.sort()
         results = {}
 
-        # Check if any of the dict keys contain the key we are searching for
-        for k in keys:
-            if key in k.lower():
+        # Check if all search terms are present in each dictionary key
+        for k in known_keys:
+            k_lower = k.lower()
+            if all(term in k_lower for term in search_keys):
                 results[k] = self[k]
 
         if results == {}:
-            # If no results, return best matches
-            best_matches = self.get_best_matches(key)
+            # No results: Suggest best matches using the concatenated string
+            best_matches = self.get_best_matches(" ".join(search_keys))
             print(
-                f"No results for search using '{key_in}'. "
+                f"No results for search using '{keys}'. "
                 f"Best matches are {best_matches}"
             )
         elif print_values:
-            # Else print results, including dict items
+            # Print keys and values of matching results
             print("\n".join(f"{k}\t{v}" for k, v in results.items()))
         else:
-            # Just print keys
-            print("\n".join(f"{k}" for k in results.keys()))
+            # Print only keys of matching results
+            print("\n".join(results.keys()))
 
     def copy(self):
         return FuzzyDict(super().copy())

tests/unit/test_util.py

@@ -195,7 +195,19 @@ def test_url_gets_to_stdout(self, mocker):
                 "'Electrode potential']\n"
             )
             assert fake_out.getvalue() == out
+        # Test for multiple strings as input (default returns key)
+        with mocker.patch("sys.stdout", new=StringIO()) as fake_out:
+            model.variables.search(["Electrolyte", "Concentration"])
+            assert fake_out.getvalue() == "Electrolyte concentration\n"
 
+        # Test for multiple strings as input (default returns best matches)
+        with mocker.patch("sys.stdout", new=StringIO()) as fake_out:
+            model.variables.search(["Electrolyte", "Poten"])
+            out = (
+                "No results for search using '['Electrolyte', 'Poten']'. "
+                "Best matches are ['Electrode potential', 'Electrolyte concentration']\n"
+            )
+            assert fake_out.getvalue() == out
         # Test param search (default returns key, value)
         with mocker.patch("sys.stdout", new=StringIO()) as fake_out:
             param.search("test")