clean up exceptions defs

Author: esoteric-ephemera

mp_api/client/core/__init__.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
 
-from .client import BaseRester, MPRestError, MPRestWarning
+from .client import BaseRester
+from .exceptions import MPRestError, MPRestWarning
 from .settings import MAPIClientSettings

mp_api/client/core/client.py

@@ -30,6 +30,7 @@
 from tqdm.auto import tqdm
 from urllib3.util.retry import Retry
 
+from mp_api.client.core.exceptions import MPRestError
 from mp_api.client.core.settings import MAPIClientSettings
 from mp_api.client.core.utils import load_json, validate_ids
 
@@ -1350,11 +1351,3 @@ def __str__(self):  # pragma: no cover
             f"{self.__class__.__name__} connected to {self.endpoint}\n\n"
             f"Available fields: {', '.join(self.available_fields)}\n\n"
         )
-
-
-class MPRestError(Exception):
-    """Raised when the query has problems, e.g., bad query format."""
-
-
-class MPRestWarning(Warning):
-    """Raised when a query is malformed but interpretable."""

mp_api/client/core/exceptions.py

@@ -0,0 +1,10 @@
+"""Define custom exceptions and warnings for the client."""
+from __future__ import annotations
+
+
+class MPRestError(Exception):
+    """Raised when the query has problems, e.g., bad query format."""
+
+
+class MPRestWarning(Warning):
+    """Raised when a query is malformed but interpretable."""

mp_api/client/core/utils.py

@@ -9,6 +9,7 @@
 from monty.json import MontyDecoder
 from packaging.version import parse as parse_version
 
+from mp_api.client.core.exceptions import MPRestError
 from mp_api.client.core.settings import MAPIClientSettings
 
 if TYPE_CHECKING:
@@ -62,7 +63,7 @@ def validate_api_key(api_key: str | None = None) -> str:
 
     if not api_key or len(api_key) != 32:
         addendum = " Valid API keys are 32 characters." if api_key else ""
-        raise ValueError(
+        raise MPRestError(
             "Please obtain a valid API key from https://materialsproject.org/api "
             f"and export it as an environment variable `MP_API_KEY`.{addendum}"
         )
@@ -77,13 +78,13 @@ def validate_ids(id_list: list[str]) -> list[str]:
         id_list (List[str]): List of material or task IDs.
 
     Raises:
-        ValueError: If at least one ID is not formatted correctly.
+        MPRestError: If at least one ID is not formatted correctly.
 
     Returns:
         id_list: Returns original ID list if everything is formatted correctly.
     """
     if len(id_list) > MAPIClientSettings().MAX_LIST_LENGTH:
-        raise ValueError(
+        raise MPRestError(
             "List of material/molecule IDs provided is too long. Consider removing the ID filter to automatically pull"
             " data for all IDs and filter locally."
         )

mp_api/client/mprester.py

@@ -290,8 +290,6 @@ def __init__(
                     elif "molecules" in suffix_split:
                         _sub_rester_suffix_map["molecules"][attr] = cls
 
-        # TODO: Enable monty decoding when tasks and SNL schema is normalized
-        #
         # Allow lazy loading of nested resters under materials and molecules using custom __getattr__ methods
         def __core_custom_getattr(_self, _attr, _rester_map):
             if _attr in _rester_map:

tests/core/test_utils.py

@@ -3,6 +3,8 @@
 from packaging.version import parse as parse_version
 import pytest
 
+from mp_api.client.core.exceptions import MPRestError
+
 
 def test_emmet_core_version_checks(monkeypatch: pytest.MonkeyPatch):
     ref_ver = (1, 2, "3rc5")
@@ -32,7 +34,7 @@ def test_id_validation():
 
     max_num_idxs = MAPIClientSettings().MAX_LIST_LENGTH
 
-    with pytest.raises(ValueError, match="too long"):
+    with pytest.raises(MPRestError, match="too long"):
         _ = validate_ids([f"mp-{x}" for x in range(max_num_idxs + 1)])
 
     # For all legacy MPIDs, ensure these validate correctly
@@ -60,10 +62,10 @@ def test_api_key_validation(monkeypatch: pytest.MonkeyPatch):
     }
     monkeypatch.setattr(pymatgen.core, "SETTINGS", non_api_key_settings)
 
-    with pytest.raises(ValueError, match="32 characters"):
+    with pytest.raises(MPRestError, match="32 characters"):
         validate_api_key("invalid_key")
 
-    with pytest.raises(ValueError, match="Please obtain a valid"):
+    with pytest.raises(MPRestError, match="Please obtain a valid"):
         validate_api_key()
 
     junk_api_key = "a" * 32
@@ -80,5 +82,6 @@ def test_api_key_validation(monkeypatch: pytest.MonkeyPatch):
     # MP API environment variable takes precedence
     assert validate_api_key() == junk_api_key
 
+    # Check that pymatgen API key is used
     monkeypatch.setenv("MP_API_KEY", "")
     assert validate_api_key() == other_junk_api_key

tests/materials/test_electronic_structure.py

@@ -4,7 +4,7 @@
 import pytest
 from pymatgen.analysis.magnetism import Ordering
 
-from mp_api.client.core.client import MPRestError
+from mp_api.client.core.exceptions import MPRestError
 from mp_api.client.routes.materials.electronic_structure import (
     BandStructureRester,
     DosRester,

tests/materials/test_phonon.py

@@ -5,7 +5,7 @@
 
 from emmet.core.phonon import PhononBS, PhononDOS
 
-from mp_api.client.core import MPRestError
+from mp_api.client.core.exceptions import MPRestError
 from mp_api.client.routes.materials.phonon import PhononRester
 
 from ..conftest import client_search_testing, requires_api_key

tests/materials/test_summary.py

@@ -7,7 +7,7 @@
 from pymatgen.analysis.magnetism import Ordering
 
 from mp_api.client.routes.materials.summary import SummaryRester
-from mp_api.client.core.client import MPRestWarning, MPRestError
+from mp_api.client.core.exceptions import MPRestWarning, MPRestError
 
 excluded_params = [
     "include_gnome",

tests/test_mprester.py

@@ -33,7 +33,7 @@
 from pymatgen.io.vasp import Chgcar
 
 from mp_api.client import MPRester
-from mp_api.client.core.client import MPRestError
+from mp_api.client.core.exceptions import MPRestError
 from mp_api.client.core.settings import MAPIClientSettings
 
 from .conftest import requires_api_key
@@ -391,12 +391,12 @@ def test_get_default_api_key_endpoint(self, monkeypatch: pytest.MonkeyPatch):
         monkeypatch.delenv("MP_API_KEY", raising=False)
         monkeypatch.delenv("PMG_MAPI_KEY", raising=False)
         monkeypatch.setitem(SETTINGS, "PMG_MAPI_KEY", None)
-        with pytest.raises(MPRestError, match="No API key found in request"):
+        with pytest.raises(MPRestError, match="Please obtain a valid API key"):
             MPRester().get_structure_by_material_id("mp-149")
 
     def test_invalid_api_key(self, monkeypatch):
         monkeypatch.setenv("MP_API_KEY", "INVALID")
-        with pytest.raises(ValueError, match="Keys for the new API are 32 characters"):
+        with pytest.raises(MPRestError, match="Valid API keys are 32 characters"):
             MPRester().get_structure_by_material_id("mp-149")
 
     def test_get_cohesive_energy_per_atom_utility(self):