add utils tests and remove legacy id validation

Author: esoteric-ephemera

mp_api/client/core/utils.py

@@ -44,27 +44,7 @@ def load_json(json_like: str | bytes, deser: bool = False, encoding: str = "utf-
     return MontyDecoder().process_decoded(data) if deser else data
 
 
-def _legacy_id_validation(id_list: list[str]) -> list[str]:
-    """Legacy utility to validate IDs, pre-AlphaID transition.
-
-    This function is temporarily maintained to allow for
-    backwards compatibility with older versions of emmet, and will
-    not be preserved.
-    """
-    pattern = "(mp|mvc|mol|mpcule)-.*"
-    if malformed_ids := {
-        entry for entry in id_list if re.match(pattern, entry) is None
-    }:
-        raise ValueError(
-            f"{'Entry' if len(malformed_ids) == 1 else 'Entries'}"
-            f" {', '.join(malformed_ids)}"
-            f"{'is' if len(malformed_ids) == 1 else 'are'} not formatted correctly!"
-        )
-
-    return id_list
-
-
-def validate_ids(id_list: list[str]):
+def validate_ids(id_list: list[str]) -> list[str]:
     """Function to validate material and task IDs.
 
     Args:
@@ -85,6 +65,4 @@ def validate_ids(id_list: list[str]):
     # TODO: after the transition to AlphaID in the document models,
     # The following line should be changed to
     # return [validate_identifier(idx,serialize=True) for idx in id_list]
-    if validate_identifier:
-        return [str(validate_identifier(idx)) for idx in id_list]
-    return _legacy_id_validation(id_list)
+    return [validate_identifier(idx).string for idx in id_list]

tests/core/test_utils.py

@@ -0,0 +1,33 @@
+"""Test client core utilities."""
+
+import pytest
+
+from emmet.core.mpid import MPID, AlphaID
+
+from mp_api.client.core.utils import validate_ids
+from mp_api.client.core.settings import MAPIClientSettings
+
+def test_id_validation():
+    max_num_idxs = MAPIClientSettings().MAX_LIST_LENGTH
+
+
+    with pytest.raises(ValueError,match="too long"):
+        _ = validate_ids(
+            [f"mp-{x}" for x in range(max_num_idxs + 1)]
+        )
+
+    # For all legacy MPIDs, ensure these validate correctly
+    assert all(
+        isinstance(x,str) and MPID(x).string == x
+        for x in validate_ids(
+            [f"mp-{y}" for y in range(max_num_idxs)]
+        )
+    )
+
+    # For all new AlphaIDs, ensure these validate correctly
+    assert all(
+        isinstance(x,str) and AlphaID(x).string == x
+        for x in validate_ids(
+            [y + AlphaID._cut_point for y in range(max_num_idxs)]
+        )
+    )