diff --git a/mpds_client/retrieve_MPDS.py b/mpds_client/retrieve_MPDS.py index 5cdf34c..f0683a2 100755 --- a/mpds_client/retrieve_MPDS.py +++ b/mpds_client/retrieve_MPDS.py @@ -134,7 +134,33 @@ def __init__( self.verbose = verbose if verbose is not None else self.verbose self.debug = debug or self.debug - def _request(self, query, phases=None, page=0, pagesize=None): + def _normalize_query(self, query): + """Ensure 'elements' and 'classes' are joined strings, not lists. + + The MPDS API expects: + - elements: dash-separated string e.g. "Sr-Ti-O" + - classes: comma-separated string e.g. "perovskite,conductor" + + Passing raw lists causes unsupported-symbol errors. + """ + out = dict(query) + + if el := out.get('elements'): + if isinstance(el, (list, tuple)): + out['elements'] = '-'.join(el) + elif el is not None: + raise ValueError("'elements' must not be empty") + + if cl := out.get('classes'): + if isinstance(cl, (list, tuple)): + out['classes'] = ','.join(cl) + elif cl is not None: + raise ValueError("'classes' must not be empty") + + return out + + def _request(self, raw_query, phases=None, page=0, pagesize=None): + query = self._normalize_query(raw_query) phases = ",".join([str(int(x)) for x in phases]) if phases else "" uri = ( diff --git a/mpds_client/test_retrieve_MPDS.py b/mpds_client/test_retrieve_MPDS.py index 9319a83..71bd510 100755 --- a/mpds_client/test_retrieve_MPDS.py +++ b/mpds_client/test_retrieve_MPDS.py @@ -13,6 +13,47 @@ class MPDSDataRetrievalTest(unittest.TestCase): + def test_normalize_query_elements_list(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + result = client._normalize_query({"elements": ["Sr", "Ti", "O"], "props": "band gap"}) + self.assertEqual(result["elements"], "Sr-Ti-O") + self.assertEqual(result["props"], "band gap") + + def test_normalize_query_elements_tuple(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + result = client._normalize_query({"elements": ("Ti", "O"), "props": "atomic structure"}) + self.assertEqual(result["elements"], "Ti-O") + + def test_normalize_query_classes_list(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + result = client._normalize_query({"elements": "Ti-O", "classes": ["perovskite", "conductor"]}) + self.assertEqual(result["classes"], "perovskite,conductor") + + def test_normalize_query_no_list(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + query = {"elements": "K-Ag", "classes": "iodide", "props": "heat capacity"} + result = client._normalize_query(query) + self.assertEqual(result, query) + + def test_normalize_query_does_not_mutate_original(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + original = {"elements": ["Sr", "Ti", "O"]} + result = client._normalize_query(original) + self.assertIsInstance(original["elements"], list) + self.assertEqual(result["elements"], "Sr-Ti-O") + + def test_normalize_query_elements_list_is_empty(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + original = {"elements": []} + with self.assertRaises(ValueError): + client._normalize_query(original) + + def test_normalize_query_classes_list_is_empty(self): + client = MPDSDataRetrieval.__new__(MPDSDataRetrieval) + original = {"classes": []} + with self.assertRaises(ValueError): + client._normalize_query(original) + @classmethod def setUpClass(cls): # warnings.filterwarnings("ignore", category=ResourceWarning, message="unclosed.*")