clean up top-level rester init

Author: esoteric-ephemera

mp_api/client/core/utils.py

@@ -65,6 +65,9 @@ def validate_api_key(api_key: str | None = None) -> str | None:
         api_key = PMG_SETTINGS.get("PMG_MAPI_KEY")
 
     if not api_key:
+        # The web server requires the client to initialize without an API key.
+        # Only warn the user if the API key cannot be identified to permit
+        # the web server to run.
         warnings.warn(
             "No API key found, please set explicitly or in "
             "the `MP_API_KEY` environment variable.",

mp_api/client/mprester.py

@@ -59,6 +59,15 @@
     **GENERIC_RESTERS,
 }
 
+TOP_LEVEL_RESTERS = [
+    "molecules/core",
+    "materials/core",
+    "_general_store",
+    "_messages",
+    "_user_settings",
+    "doi",
+]
+
 
 class MPRester:
     """Access the new Materials Project API."""
@@ -181,44 +190,23 @@ def __init__(
         # Nested rested are then setup to be loaded dynamically with custom __getattr__ functions.
         self._all_resters = list(RESTER_LAYOUT.values())
 
-        # Instantiate top level molecules and materials resters and set them as attributes
-        core_suffix = ["molecules/core", "materials/core"]
-
-        core_resters = {
-            rest_name.split("/")[0]: lazy_rester(
-                api_key=self.api_key,
-                endpoint=self.endpoint,
-                include_user_agent=self._include_user_agent,
-                session=self.session,
-                use_document_model=self.use_document_model,
-                headers=self.headers,
-                mute_progress_bars=self.mute_progress_bars,
-            )
-            for rest_name, lazy_rester in RESTER_LAYOUT.items()
-            if rest_name in core_suffix
-        }
-
-        # Set remaining top level resters, or get an attribute-class name mapping
-
-        for attr, rester in core_resters.items():
-            setattr(self, attr, rester)
-
-        # set generics TODO!: refactor
-        generic_resters = {
-            rest_name: lazy_rester(
-                api_key=self.api_key,
-                endpoint=self.endpoint,
-                include_user_agent=self._include_user_agent,
-                session=self.session,
-                use_document_model=self.use_document_model,
-                headers=self.headers,
-                mute_progress_bars=self.mute_progress_bars,
-            )
-            for rest_name, lazy_rester in GENERIC_RESTERS.items()
-        }
-
-        for attr, rester in generic_resters.items():
-            setattr(self, attr, rester)
+        # Instantiate top level core molecules, materials, and DOI resters, as well
+        # as the sunder resters to allow the web server to work.
+        for rest_name, lazy_rester in (RESTER_LAYOUT | GENERIC_RESTERS).items():
+            if rest_name in TOP_LEVEL_RESTERS:
+                setattr(
+                    self,
+                    rest_name.split("/")[0],
+                    lazy_rester(
+                        api_key=self.api_key,
+                        endpoint=self.endpoint,
+                        include_user_agent=self._include_user_agent,
+                        session=self.session,
+                        use_document_model=self.use_document_model,
+                        headers=self.headers,
+                        mute_progress_bars=self.mute_progress_bars,
+                    ),
+                )
 
     @property
     def contribs(self):
@@ -268,7 +256,11 @@ def __getattr__(self, attr):
             )
 
     def __dir__(self):
-        return dir(MPRester) + self._deprecated_attributes + ["materials", "molecules"]
+        return (
+            dir(MPRester)
+            + self._deprecated_attributes
+            + [r.split("/", 1)[0] for r in TOP_LEVEL_RESTERS if not r.startswith("_")]
+        )
 
     def get_task_ids_associated_with_material_id(
         self, material_id: str, calc_types: list[CalcType] | None = None

tests/client/core/test_utils.py

@@ -1,9 +1,8 @@
 """Test client core utilities."""
 
-from packaging.version import parse as parse_version
 import pytest
 
-from mp_api.client.core.exceptions import MPRestError
+from mp_api.client.core.exceptions import MPRestError, MPRestWarning
 from mp_api.client.core.utils import LazyImport
 
 
@@ -145,7 +144,7 @@ def test_api_key_validation(monkeypatch: pytest.MonkeyPatch):
     with pytest.raises(MPRestError, match="32 characters"):
         validate_api_key("invalid_key")
 
-    with pytest.raises(MPRestError, match="Please obtain a valid"):
+    with pytest.warns(MPRestWarning, match="No API key found"):
         validate_api_key()
 
     junk_api_key = "a" * 32