add configurable default return fields for sort test

- some collections don't have material_id, deprecated, etc.

Author: tsmathis

mp_api/_test_utils.py

@@ -114,13 +114,15 @@ def client_sort(
     search_method: Callable,
     sort_fields: str | Sequence[str],
     aux_query: dict[str, Any] | None = None,
+    default_fields: tuple[str, ...] = ("deprecated", "material_id"),
 ):
     """Test sorting on an endpoint.
 
     Args:
     search_method (Callable) : Client search method to use
     sort_fields (str or Sequence of str) : fields to sort on
     aux_query (dict) : auxiliary query needed to filter documents
+    default_fields (list): default fields to return
 
     Raises:
     AssertionError if sorting in ascending or descending order does not work.
@@ -142,7 +144,7 @@ def _normalize(doc, field: str):
             _page=1,
             _sort_fields=sort_field,
             chunk_size=NUM_DOCS,
-            fields=[sort_field, "deprecated", "material_id"],
+            fields=[sort_field, *default_fields],
             **user_query,
         )
         desc = search_method(

tests/client/materials/test_electrodes.py

@@ -99,4 +99,4 @@ def test_pagination():
 @pytest.mark.parametrize("sort_field", ["stability_charge", "average_voltage"])
 def test_sort(sort_field):
     with ElectrodeRester() as rester:
-        client_sort(rester.search, sort_field)
+        client_sort(rester.search, sort_field, default_fields=())

tests/client/materials/test_xas.py

@@ -82,4 +82,4 @@ def test_pagination():
 )
 def test_sort(sort_field):
     with XASRester() as rester:
-        client_sort(rester.search, sort_field)
+        client_sort(rester.search, sort_field, default_fields=())

tests/client/molecules/test_jcesr.py

@@ -1,14 +1,14 @@
 import os
+
+import pytest
+from pymatgen.core.periodic_table import Element
+
 from mp_api._test_utils import (
-    client_search_testing,
     client_pagination,
+    client_search_testing,
     client_sort,
     requires_api_key,
 )
-
-import pytest
-from pymatgen.core.periodic_table import Element
-
 from mp_api.client.core.exceptions import MPRestWarning
 from mp_api.client.routes.molecules.jcesr import JcesrMoleculesRester
 
@@ -77,4 +77,4 @@ def test_pagination():
 )
 def test_sort(sort_field):
     with JcesrMoleculesRester() as rester:
-        client_sort(rester.search, sort_field)
+        client_sort(rester.search, sort_field, default_fields=())

tests/client/molecules/test_summary.py

@@ -5,8 +5,8 @@
 from emmet.core.mpid import MPculeID
 
 from mp_api._test_utils import (
-    client_search_testing,
     client_pagination,
+    client_search_testing,
     client_sort,
     requires_api_key,
 )
@@ -70,4 +70,4 @@ def test_pagination():
 @pytest.mark.parametrize("sort_field", ["charge", "spin_multiplicity"])
 def test_sort(sort_field):
     with MoleculesSummaryRester() as rester:
-        client_sort(rester.search, sort_field)
+        client_sort(rester.search, sort_field, default_fields=())