Merge main

Author: Jason Munro

mp_api/client/core/client.py

@@ -73,6 +73,7 @@ def api_sanitize(
         model_fields_to_leave = {f[1] for f in fields_tuples if model.__name__ == f[0]}
         for name in model.model_fields:
             field = model.model_fields[name]
+            field_json_extra = field.json_schema_extra
             field_type = field.annotation
 
             if field_type is not None and allow_dict_msonable:
@@ -87,6 +88,7 @@ def api_sanitize(
                 new_field = FieldInfo.from_annotated_attribute(
                     Optional[field_type], None
                 )
+                new_field.json_schema_extra = field_json_extra or {}
                 model.model_fields[name] = new_field
 
         model.model_rebuild(force=True)

mp_api/client/core/utils.py

@@ -89,4 +89,6 @@ def get_user_settings(self, consumer_id, fields):  # pragma: no cover
         Raises:
             MPRestError.
         """
-        return self.get_data_by_id(consumer_id, fields)
+        return self._query_resource(
+            suburl=f"{consumer_id}", fields=fields, num_chunks=1, chunk_size=1
+        ).get("data")

mp_api/client/mprester.py

@@ -13,8 +13,7 @@
     ElectronicStructureRester,
 )
 from .eos import EOSRester
-from .fermi import FermiRester
-from .grain_boundary import GrainBoundaryRester
+from .grain_boundaries import GrainBoundaryRester
 from .magnetism import MagnetismRester
 from .oxidation_states import OxidationStatesRester
 from .phonon import PhononRester

mp_api/client/routes/_user_settings.py

@@ -24,7 +24,7 @@ def search(
         chunk_size: int = 1000,
         all_fields: bool = True,
         fields: list[str] | None = None,
-    ) -> list[AbsorptionDoc]:
+    ) -> list[AbsorptionDoc] | list[dict]:
         """Query for optical absorption spectra data.
 
         Arguments:
@@ -42,7 +42,7 @@ def search(
             fields (List[str]): List of fields in AbsorptionDoc to return data for.
 
         Returns:
-            ([AbsorptionDoc]) List of optical absorption documents.
+            ([AbsorptionDoc], [dict]) List of optical absorption documents or dictionaries.
         """
         query_params = defaultdict(dict)  # type: dict
 

mp_api/client/routes/materials/__init__.py

@@ -21,7 +21,7 @@ def search(
         chunk_size: int = 1000,
         all_fields: bool = True,
         fields: list[str] | None = None,
-    ) -> list[AlloyPairDoc]:
+    ) -> list[AlloyPairDoc] | list[dict]:
         """Query for hypothetical alloys formed between two commensurate
         crystal structures, following the methodology in
         https://doi.org/10.48550/arXiv.2206.10715.
@@ -38,7 +38,7 @@ def search(
             fields (List[str]): List of fields in AlloyPairDoc to return data for.
 
         Returns:
-            ([AlloyPairDoc]) List of alloy pair documents.
+            ([AlloyPairDoc], [dict]) List of alloy pair documents or dictionaries.
         """
         query_params = defaultdict(dict)  # type: dict
 

mp_api/client/routes/materials/absorption.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import warnings
 from collections import defaultdict
 
 from emmet.core.bonds import BondingDoc
@@ -14,16 +13,6 @@ class BondsRester(BaseRester[BondingDoc]):
     document_model = BondingDoc  # type: ignore
     primary_key = "material_id"
 
-    def search_bonds_docs(self, *args, **kwargs):  # pragma: no cover
-        """Deprecated."""
-        warnings.warn(
-            "MPRester.bonds.search_bonds_docs is deprecated. Please use MPRester.bonds.search instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
-        return self.search(*args, **kwargs)
-
     def search(
         self,
         material_ids: str | list[str] | None = None,
@@ -36,7 +25,7 @@ def search(
         chunk_size: int = 1000,
         all_fields: bool = True,
         fields: list[str] | None = None,
-    ):
+    ) -> list[BondingDoc] | list[dict]:
         """Query bonding docs using a variety of search criteria.
 
         Arguments:
@@ -57,7 +46,7 @@ def search(
                 Default is material_id and last_updated if all_fields is False.
 
         Returns:
-            ([BondingDoc]) List of bonding documents.
+            ([BondingDoc], [dict]) List of bonding documents or dictionaries.
         """
         query_params = defaultdict(dict)  # type: dict
 

mp_api/client/routes/materials/alloys.py

@@ -46,7 +46,7 @@ def search(
         chunk_size: int = 1000,
         all_fields: bool = True,
         fields: list[str] | None = None,
-    ):
+    ) -> list[ChemEnvDoc] | list[dict]:
         """Query for chemical environment data.
 
         Arguments:
@@ -73,7 +73,7 @@ def search(
             fields (List[str]): List of fields in ChemEnvDoc to return data for.
 
         Returns:
-            ([ChemEnvDoc]) List of chemenv documents.
+            ([ChemEnvDoc], [dict]) List of chemenv documents or dictionaries.
         """
         query_params = defaultdict(dict)  # type: dict