backwards + forwards compat

Author: esoteric-ephemera

mp_api/client/core/JANAF_O2_data.json

@@ -1,17 +1,47 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+import re
+from typing import TYPE_CHECKING, Literal
 
 import orjson
-from emmet.core.mpid_ext import validate_identifier
+from emmet.core import __version__ as _EMMET_CORE_VER
 from monty.json import MontyDecoder
+from packaging.version import parse as parse_version
 
 from mp_api.client.core.settings import MAPIClientSettings
 
 if TYPE_CHECKING:
     from monty.json import MSONable
 
 
+def _compare_emmet_ver(
+    ref_version: str, op: Literal["==", ">", ">=", "<", "<="]
+) -> bool:
+    """Compare the current emmet-core version to a reference for version guarding.
+
+    Example:
+        _compare_emmet_ver("0.84.0rc0","<") returns
+        emmet.core.__version__ < "0.84.0rc0"
+
+    Parameters
+    -----------
+    ref_version : str
+        A reference version of emmet-core
+    op : A mathematical operator
+    """
+    op_to_op = {"==": "eq", ">": "gt", ">=": "ge", "<": "lt", "<=": "le"}
+    return getattr(
+        parse_version(_EMMET_CORE_VER),
+        f"__{op_to_op.get(op,op)}__",
+    )(parse_version(ref_version))
+
+
+if _compare_emmet_ver("0.85.0", ">="):
+    from emmet.core.mpid_ext import validate_identifier
+else:
+    validate_identifier = None
+
+
 def load_json(json_like: str | bytes, deser: bool = False, encoding: str = "utf-8"):
     """Utility to load json in consistent manner."""
     data = orjson.loads(
@@ -20,6 +50,26 @@ 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'}\n"
+            f"    {', '.join(malformed_ids)}\n"
+            f"{'is' if len(malformed_ids) == 1 else 'are'} not formatted correctly!"
+        )
+
+    return id_list
+
+
 def validate_ids(id_list: list[str]):
     """Function to validate material and task IDs.
 
@@ -41,7 +91,9 @@ 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]
-    return [str(validate_identifier(idx)) for idx in id_list]
+    if validate_identifier:
+        return [str(validate_identifier(idx)) for idx in id_list]
+    return _legacy_id_validation(id_list)
 
 
 def allow_msonable_dict(monty_cls: type[MSONable]):

mp_api/client/core/utils.py

@@ -10,7 +10,6 @@
 from emmet.core.mpid import MPID, AlphaID
 from emmet.core.settings import EmmetSettings
 from emmet.core.tasks import TaskDoc
-from emmet.core.types.enums import ThermoType
 from emmet.core.vasp.calc_types import CalcType
 from packaging import version
 from pymatgen.analysis.phase_diagram import PhaseDiagram
@@ -24,7 +23,7 @@
 
 from mp_api.client.core import BaseRester, MPRestError
 from mp_api.client.core.settings import MAPIClientSettings
-from mp_api.client.core.utils import load_json, validate_ids
+from mp_api.client.core.utils import _compare_emmet_ver, load_json, validate_ids
 from mp_api.client.routes import GeneralStoreRester, MessagesRester, UserSettingsRester
 from mp_api.client.routes.materials import (
     AbsorptionRester,
@@ -59,6 +58,11 @@
 from mp_api.client.routes.materials.materials import MaterialsRester
 from mp_api.client.routes.molecules import MoleculeRester
 
+if _compare_emmet_ver("0.85.0", ">="):
+    from emmet.core.types.enums import ThermoType
+else:
+    from emmet.core.thermo import ThermoType
+
 if TYPE_CHECKING:
     from typing import Any, Literal
 

mp_api/client/mprester.py

@@ -4,12 +4,16 @@
 
 import numpy as np
 from emmet.core.thermo import ThermoDoc
-from emmet.core.types.enums import ThermoType
 from pymatgen.analysis.phase_diagram import PhaseDiagram
 from pymatgen.core import Element
 
 from mp_api.client.core import BaseRester
-from mp_api.client.core.utils import load_json, validate_ids
+from mp_api.client.core.utils import _compare_emmet_ver, load_json, validate_ids
+
+if _compare_emmet_ver("0.85.0", ">="):
+    from emmet.core.types.enums import ThermoType
+else:
+    from emmet.core.thermo import ThermoType
 
 
 class ThermoRester(BaseRester[ThermoDoc]):

mp_api/client/routes/materials/thermo.py

@@ -9,7 +9,17 @@
 from mp_api.client.core.utils import validate_ids
 
 if TYPE_CHECKING:
-    from emmet.core.types.enums import XasEdge, XasType
+    from mp_api.client.core.utils import _compare_emmet_ver
+
+    if _compare_emmet_ver("0.85.0", ">="):
+        from emmet.core.types.enums import XasEdge, XasType
+    else:
+        from emmet.core.xas import (
+            Edge as XasEdge,
+        )
+        from emmet.core.xas import (
+            Type as XasType,
+        )
 
 
 class XASRester(BaseRester[XASDoc]):

mp_api/client/routes/materials/xas.py

@@ -2,10 +2,15 @@
 from core_function import client_search_testing
 
 import pytest
-from emmet.core.types.enums import ThermoType
 from pymatgen.analysis.phase_diagram import PhaseDiagram
 
 from mp_api.client.routes.materials.thermo import ThermoRester
+from mp_api.client.core.utils import _compare_emmet_ver
+
+if _compare_emmet_ver("0.85.0", ">="):
+    from emmet.core.types.enums import ThermoType
+else:
+    from emmet.core.thermo import ThermoType
 
 
 @pytest.fixture

tests/materials/test_thermo.py

@@ -2,10 +2,18 @@
 from core_function import client_search_testing
 
 import pytest
-from emmet.core.types.enums import XasEdge, XasType
 from pymatgen.core.periodic_table import Element
 
 from mp_api.client.routes.materials.xas import XASRester
+from mp_api.client.core.utils import _compare_emmet_ver
+
+if _compare_emmet_ver("0.85.0", ">="):
+    from emmet.core.types.enums import XasEdge, XasType
+else:
+    from emmet.core.xas import (
+        Type as XasType,
+        Edge as XasEdge,
+    )
 
 
 @pytest.fixture

tests/materials/test_xas.py

@@ -6,7 +6,6 @@
 import numpy as np
 import pytest
 from emmet.core.tasks import TaskDoc
-from emmet.core.types.enums import ThermoType
 from emmet.core.vasp.calc_types import CalcType
 from pymatgen.analysis.phase_diagram import PhaseDiagram
 from pymatgen.analysis.pourbaix_diagram import IonEntry, PourbaixDiagram, PourbaixEntry
@@ -32,6 +31,12 @@
 from mp_api.client import MPRester
 from mp_api.client.core.client import MPRestError
 from mp_api.client.core.settings import MAPIClientSettings
+from mp_api.client.core.utils import _compare_emmet_ver
+
+if _compare_emmet_ver("0.85.0", ">="):
+    from emmet.core.types.enums import ThermoType
+else:
+    from emmet.core.thermo import ThermoType
 
 
 @pytest.fixture()