migrate legacy type annos

esoteric-ephemera · esoteric-ephemera · commit a33db152db86 · 2026-01-21T11:18:21.000-08:00
diff --git a/mp_api/client/core/client.py b/mp_api/client/core/client.py
@@ -672,7 +672,7 @@ def _submit_requests(  # noqa
             new_limits = [chunk_size]
 
         total_num_docs = 0
-        total_data = {"data": []}  # type: dict
+        total_data: dict[str, list[Any]] = {"data": []}
 
         # Obtain first page of results and get pagination information.
         # Individual total document limits (subtotal) will potentially
diff --git a/mp_api/client/routes/materials/absorption.py b/mp_api/client/routes/materials/absorption.py
@@ -57,7 +57,7 @@ def search(
         Returns:
             ([AbsorptionDoc], [dict]) List of optical absorption documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         aliased = {
             "num_sites": "nsites",
diff --git a/mp_api/client/routes/materials/alloys.py b/mp_api/client/routes/materials/alloys.py
@@ -40,7 +40,7 @@ def search(
         Returns:
             ([AlloyPairDoc], [dict]) List of alloy pair documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         query_params = {
             entry: query_params[entry]
diff --git a/mp_api/client/routes/materials/bonds.py b/mp_api/client/routes/materials/bonds.py
@@ -48,7 +48,7 @@ def search(
         Returns:
             ([BondingDoc], [dict]) List of bonding documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/chemenv.py b/mp_api/client/routes/materials/chemenv.py
@@ -75,7 +75,7 @@ def search(
         Returns:
             ([ChemEnvDoc], [dict]) List of chemenv documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if csm:
             query_params.update({"csm_min": csm[0], "csm_max": csm[1]})
diff --git a/mp_api/client/routes/materials/dielectric.py b/mp_api/client/routes/materials/dielectric.py
@@ -43,7 +43,7 @@ def search(
         Returns:
             ([DielectricDoc], [dict]) List of dielectric documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/doi.py b/mp_api/client/routes/materials/doi.py
@@ -33,7 +33,7 @@ def search(
         Returns:
             ([DOIDoc], [dict]) List of DOIDoc documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/elasticity.py b/mp_api/client/routes/materials/elasticity.py
@@ -59,7 +59,7 @@ def search(
         Returns:
             ([ElasticityDoc], [dict]) List of elasticity documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/electrodes.py b/mp_api/client/routes/materials/electrodes.py
@@ -80,7 +80,7 @@ def search(  # pragma: ignore
         Returns:
             ([InsertionElectrodeDoc or ConversionElectrodeDoc], [dict]) List of insertion/conversion electrode documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if battery_ids:
             if isinstance(battery_ids, str):
diff --git a/mp_api/client/routes/materials/electronic_structure.py b/mp_api/client/routes/materials/electronic_structure.py
@@ -81,7 +81,7 @@ def search(
         Returns:
             ([ElectronicStructureDoc]) List of electronic structure documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
@@ -210,7 +210,7 @@ def search(
         Returns:
             ([ElectronicStructureDoc]) List of electronic structure documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         query_params["path_type"] = (
             BSPathType[path_type] if isinstance(path_type, str) else path_type
@@ -385,7 +385,7 @@ def search(
         Returns:
             ([ElectronicStructureDoc]) List of electronic structure documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         query_params["projection_type"] = (
             DOSProjectionType[projection_type]
diff --git a/mp_api/client/routes/materials/eos.py b/mp_api/client/routes/materials/eos.py
@@ -38,7 +38,7 @@ def search(
         Returns:
             ([EOSDoc], [dict]) List of equations of state docs or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/grain_boundaries.py b/mp_api/client/routes/materials/grain_boundaries.py
@@ -56,7 +56,7 @@ def search(
         Returns:
              ([GrainBoundaryDoc], [dict]) List of grain boundary documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/magnetism.py b/mp_api/client/routes/materials/magnetism.py
@@ -50,7 +50,7 @@ def search(
         Returns:
             ([MagnetismDoc], [dict]) List of magnetism documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/materials.py b/mp_api/client/routes/materials/materials.py
@@ -99,7 +99,7 @@ def search(
         Returns:
             ([MaterialsDoc], [dict]) List of material documents or dictionaries.
         """
-        query_params = {"deprecated": deprecated}  # type: dict
+        query_params: dict = {"deprecated": deprecated}
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/oxidation_states.py b/mp_api/client/routes/materials/oxidation_states.py
@@ -44,7 +44,7 @@ def search(
         Returns:
             ([OxidationStateDoc], [dict]) List of oxidation state documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/phonon.py b/mp_api/client/routes/materials/phonon.py
@@ -44,7 +44,7 @@ def search(
         Returns:
             ([PhononBSDOSDoc], [dict]) List of phonon documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/piezo.py b/mp_api/client/routes/materials/piezo.py
@@ -38,7 +38,7 @@ def search(
         Returns:
             ([PiezoDoc], [dict]) List of piezoelectric documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/provenance.py b/mp_api/client/routes/materials/provenance.py
@@ -35,7 +35,7 @@ def search(
         Returns:
             ([ProvenanceDoc], [dict]) List of provenance documents or dictionaries.
         """
-        query_params = {"deprecated": deprecated}  # type: dict
+        query_params: dict = {"deprecated": deprecated}
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/robocrys.py b/mp_api/client/routes/materials/robocrys.py
@@ -64,7 +64,7 @@ def search_docs(
         Returns:
             ([RobocrystallogapherDoc], [dict]) List of robocrystallographer documents or dictionaries.
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/similarity.py b/mp_api/client/routes/materials/similarity.py
@@ -57,7 +57,7 @@ def search(
         Returns:
             ([SimilarityDoc], [dict]) List of similarity documents or dictionaries.
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/substrates.py b/mp_api/client/routes/materials/substrates.py
@@ -46,7 +46,7 @@ def search(
         Returns:
             ([SubstratesDoc], [dict]) List of substrate documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if film_id:
             query_params.update({"film_id": film_id})
diff --git a/mp_api/client/routes/materials/summary.py b/mp_api/client/routes/materials/summary.py
@@ -154,7 +154,7 @@ def search(  # noqa: D417
         Returns:
             ([SummaryDoc], [dict]) List of SummaryDoc documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         not_aliased_kwargs = [
             "energy_above_hull",
diff --git a/mp_api/client/routes/materials/surface_properties.py b/mp_api/client/routes/materials/surface_properties.py
@@ -47,7 +47,7 @@ def search(
         Returns:
             ([SurfacePropDoc], [dict]) List of surface properties documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if material_ids:
             if isinstance(material_ids, str):
diff --git a/mp_api/client/routes/materials/tasks.py b/mp_api/client/routes/materials/tasks.py
@@ -75,7 +75,7 @@ def search(
         Returns:
             ([CoreTaskDoc], [dict]) List of task documents or dictionaries.
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if task_ids:
             if isinstance(task_ids, str):
diff --git a/mp_api/client/routes/materials/thermo.py b/mp_api/client/routes/materials/thermo.py
@@ -68,7 +68,7 @@ def search(
         Returns:
             ([ThermoDoc], [dict]) List of thermo documents or dictionaries.
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if formula:
             if isinstance(formula, str):
diff --git a/mp_api/client/routes/molecules/bonds.py b/mp_api/client/routes/molecules/bonds.py
@@ -66,7 +66,7 @@ def search(
         Returns:
             ([MoleculeBondingDoc]) List of bonding documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if molecule_ids:
             if isinstance(molecule_ids, str):
diff --git a/mp_api/client/routes/molecules/jcesr.py b/mp_api/client/routes/molecules/jcesr.py
@@ -60,7 +60,7 @@ def search(
         Returns:
             ([MoleculesDoc]) List of molecule documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         if task_ids:
             if isinstance(task_ids, str):
diff --git a/mp_api/client/routes/molecules/molecules.py b/mp_api/client/routes/molecules/molecules.py
@@ -137,7 +137,7 @@ def search(
         Returns:
             ([MoleculeDoc]) List of molecules documents
         """
-        query_params = {"deprecated": deprecated}  # type: dict
+        query_params: dict = {"deprecated": deprecated}
 
         if molecule_ids:
             if isinstance(molecule_ids, str):
diff --git a/mp_api/client/routes/molecules/orbitals.py b/mp_api/client/routes/molecules/orbitals.py
@@ -144,7 +144,7 @@ def search(
         Returns:
             ([RedoxDoc]) List of molecule redox documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         min_max = [
             "core_electrons",
diff --git a/mp_api/client/routes/molecules/partial_charges.py b/mp_api/client/routes/molecules/partial_charges.py
@@ -60,7 +60,7 @@ def search(
         Returns:
             ([PartialChargesDoc]) List of partial charges documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if molecule_ids:
             if isinstance(molecule_ids, str):
diff --git a/mp_api/client/routes/molecules/partial_spins.py b/mp_api/client/routes/molecules/partial_spins.py
@@ -60,7 +60,7 @@ def search(
         Returns:
             ([PartialSpinsDoc]) List of partial charges documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if molecule_ids:
             if isinstance(molecule_ids, str):
diff --git a/mp_api/client/routes/molecules/redox.py b/mp_api/client/routes/molecules/redox.py
@@ -80,7 +80,7 @@ def search(
         Returns:
             ([RedoxDoc]) List of molecule redox documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         min_max = [
             "electron_affinity",
diff --git a/mp_api/client/routes/molecules/summary.py b/mp_api/client/routes/molecules/summary.py
@@ -68,7 +68,7 @@ def search(
         Returns:
             ([MoleculeSummaryDoc]) List of molecules summary documents
         """
-        query_params = defaultdict(dict)  # type: dict
+        query_params: dict = defaultdict(dict)
 
         min_max = [
             "nelements",
diff --git a/mp_api/client/routes/molecules/tasks.py b/mp_api/client/routes/molecules/tasks.py
@@ -43,7 +43,7 @@ def search(
         Returns:
             ([TaskDocument]) List of task documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if task_ids:
             query_params.update({"task_ids": ",".join(validate_ids(task_ids))})
diff --git a/mp_api/client/routes/molecules/thermo.py b/mp_api/client/routes/molecules/thermo.py
@@ -90,7 +90,7 @@ def search(
         Returns:
             ([MoleculeThermoDoc]) List of molecule thermo documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         min_max = [
             "electronic_energy",
diff --git a/mp_api/client/routes/molecules/vibrations.py b/mp_api/client/routes/molecules/vibrations.py
@@ -75,7 +75,7 @@ def search(
         Returns:
             ([VibrationDoc]) List of molecule vibration documents
         """
-        query_params = {}  # type: dict
+        query_params: dict = {}
 
         if molecule_ids:
             if isinstance(molecule_ids, str):
diff --git a/tests/client/materials/test_bonds.py b/tests/client/materials/test_bonds.py
@@ -19,20 +19,20 @@ def rester():
     "fields",
 ]
 
-sub_doc_fields = []  # type: list
+sub_doc_fields: list = []
 
-alt_name_dict = {
+alt_name_dict: dict = {
     "material_ids": "material_id",
     "max_bond_length": "bond_length_stats",
     "min_bond_length": "bond_length_stats",
     "mean_bond_length": "bond_length_stats",
-}  # type: dict
+}
 
-custom_field_tests = {
+custom_field_tests: dict = {
     "material_ids": ["mp-149"],
     "coordination_envs": ["Mo-S(6)"],
     "coordination_envs_anonymous": ["A-B(6)"],
-}  # type: dict
+}
 
 
 @requires_api_key
diff --git a/tests/client/materials/test_chemenv.py b/tests/client/materials/test_chemenv.py
@@ -23,16 +23,16 @@ def rester():
     "csm",  # temp until timeout fix
 ]
 
-sub_doc_fields = []  # type: list
+sub_doc_fields: list = []
 
-alt_name_dict = {
+alt_name_dict: dict = {
     "material_ids": "material_id",
     "exclude_elements": "material_id",
     "num_elements": "nelements",
     "num_sites": "nsites",
-}  # type: dict
+}
 
-custom_field_tests = {
+custom_field_tests: dict = {
     "material_ids": ["mp-22526"],
     "elements": ["Si", "O"],
     "exclude_elements": ["Si", "O"],
@@ -41,7 +41,7 @@ def rester():
     "chemenv_iucr": ["[2l]"],
     "chemenv_name": ["Octahedron"],
     "species": ["Cu2+"],
-}  # type: dict
+}
 
 
 @requires_api_key
diff --git a/tests/client/materials/test_dielectric.py b/tests/client/materials/test_dielectric.py
diff --git a/tests/client/materials/test_elasticity.py b/tests/client/materials/test_elasticity.py
diff --git a/tests/client/materials/test_electrodes.py b/tests/client/materials/test_electrodes.py
diff --git a/tests/client/materials/test_electronic_structure.py b/tests/client/materials/test_electronic_structure.py
diff --git a/tests/client/materials/test_eos.py b/tests/client/materials/test_eos.py
diff --git a/tests/client/materials/test_grain_boundary.py b/tests/client/materials/test_grain_boundary.py
diff --git a/tests/client/materials/test_magnetism.py b/tests/client/materials/test_magnetism.py
diff --git a/tests/client/materials/test_materials.py b/tests/client/materials/test_materials.py
diff --git a/tests/client/materials/test_oxidation_states.py b/tests/client/materials/test_oxidation_states.py
diff --git a/tests/client/materials/test_piezo.py b/tests/client/materials/test_piezo.py
diff --git a/tests/client/materials/test_provenance.py b/tests/client/materials/test_provenance.py
diff --git a/tests/client/materials/test_substrates.py b/tests/client/materials/test_substrates.py
diff --git a/tests/client/materials/test_summary.py b/tests/client/materials/test_summary.py
diff --git a/tests/client/materials/test_surface_properties.py b/tests/client/materials/test_surface_properties.py
diff --git a/tests/client/materials/test_tasks.py b/tests/client/materials/test_tasks.py
diff --git a/tests/client/materials/test_thermo.py b/tests/client/materials/test_thermo.py
diff --git a/tests/client/materials/test_xas.py b/tests/client/materials/test_xas.py
diff --git a/tests/client/molecules/test_jcesr.py b/tests/client/molecules/test_jcesr.py
diff --git a/tests/client/molecules/test_summary.py b/tests/client/molecules/test_summary.py
