skip test for missing api key decorator

Author: esoteric-ephemera

mp_api/client/routes/materials/electronic_structure.py

@@ -2,6 +2,7 @@
 
 import warnings
 from collections import defaultdict
+from typing import TYPE_CHECKING
 
 from emmet.core.electronic_structure import (
     BSPathType,
@@ -15,6 +16,9 @@
 from mp_api.client.core import BaseRester, MPRestError
 from mp_api.client.core.utils import validate_ids
 
+if TYPE_CHECKING:
+    from pymatgen.electronic_structure.dos import CompleteDos
+
 
 class ElectronicStructureRester(BaseRester):
     suffix = "materials/electronic_structure"
@@ -142,9 +146,28 @@ def search(
         )
 
 
-class BandStructureRester(BaseRester):
+class BaseESPropertyRester(BaseRester):
+    _es_rester: ElectronicStructureRester | None = None
+    document_model = ElectronicStructureDoc
+
+    @property
+    def es_rester(self) -> ElectronicStructureRester:
+        if not self._es_rester:
+            self._es_rester = ElectronicStructureRester(
+                api_key=self.api_key,
+                endpoint=self.base_endpoint,
+                include_user_agent=self.include_user_agent,
+                session=self.session,
+                monty_decode=self.monty_decode,
+                use_document_model=self.use_document_model,
+                headers=self.headers,
+                mute_progress_bars=self.mute_progress_bars,
+            )
+        return self._es_rester
+
+
+class BandStructureRester(BaseESPropertyRester):
     suffix = "materials/electronic_structure/bandstructure"
-    document_model = ElectronicStructureDoc  # type: ignore
 
     def search_bandstructure_summary(self, *args, **kwargs):  # pragma: no cover
         """Deprecated."""
@@ -258,19 +281,8 @@ def get_bandstructure_from_material_id(
         Returns:
             bandstructure (Union[BandStructure, BandStructureSymmLine]): BandStructure or BandStructureSymmLine object
         """
-        es_rester = ElectronicStructureRester(
-            api_key=self.api_key,
-            endpoint=self.base_endpoint,
-            include_user_agent=self.include_user_agent,
-            session=self.session,
-            monty_decode=self.monty_decode,
-            use_document_model=self.use_document_model,
-            headers=self.headers,
-            mute_progress_bars=self.mute_progress_bars,
-        )
-
         if line_mode:
-            bs_doc = es_rester.search(
+            bs_doc = self.es_rester.search(
                 material_ids=material_id, fields=["bandstructure"]
             )
             if not bs_doc:
@@ -293,7 +305,9 @@ def get_bandstructure_from_material_id(
 
         else:
             if not (
-                bs_doc := es_rester.search(material_ids=material_id, fields=["dos"])
+                bs_doc := self.es_rester.search(
+                    material_ids=material_id, fields=["dos"]
+                )
             ):
                 raise MPRestError("No electronic structure data found.")
 
@@ -319,9 +333,8 @@ def get_bandstructure_from_material_id(
         raise MPRestError("No band structure object found.")
 
 
-class DosRester(BaseRester):
+class DosRester(BaseESPropertyRester):
     suffix = "materials/electronic_structure/dos"
-    document_model = ElectronicStructureDoc  # type: ignore
 
     def search_dos_summary(self, *args, **kwargs):  # pragma: no cover
         """Deprecated."""
@@ -403,7 +416,7 @@ def search(
             **query_params,
         )
 
-    def get_dos_from_task_id(self, task_id: str):
+    def get_dos_from_task_id(self, task_id: str) -> CompleteDos:
         """Get the density of states pymatgen object associated with a given calculation ID.
 
         Arguments:
@@ -431,18 +444,9 @@ def get_dos_from_material_id(self, material_id: str):
         Returns:
             dos (CompleteDos): CompleteDos object
         """
-        es_rester = ElectronicStructureRester(
-            api_key=self.api_key,
-            endpoint=self.base_endpoint,
-            include_user_agent=self.include_user_agent,
-            session=self.session,
-            monty_decode=self.monty_decode,
-            use_document_model=self.use_document_model,
-            headers=self.headers,
-            mute_progress_bars=self.mute_progress_bars,
-        )
-
-        if not (dos_doc := es_rester.search(material_ids=material_id, fields=["dos"])):
+        if not (
+            dos_doc := self.es_rester.search(material_ids=material_id, fields=["dos"])
+        ):
             return None
 
         if not (dos_data := dos_doc[0].get("dos")):

tests/materials/core_function.py tests/conftest.pytests/materials/core_function.py renamed to tests/conftest.py

@@ -1,5 +1,18 @@
 from __future__ import annotations
-from typing import Callable, Any
+
+import os
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+    from typing import Any
+
+requires_api_key = pytest.mark.skipif(
+    os.getenv("MP_API_KEY") is None,
+    reason="No API key found.",
+)
 
 
 def client_search_testing(

tests/materials/__init__.py

@@ -7,10 +7,10 @@
 from mp_api.client.core import MPRestError
 from mp_api.client.routes.materials.absorption import AbsorptionRester
 
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY") is None, reason="No API key found.")
+@requires_api_key
 def test_absorption_search():
     client_search_testing(
         search_method=AbsorptionRester().search,

tests/materials/test_absorption.py

@@ -4,10 +4,10 @@
 
 from mp_api.client.routes.materials.alloys import AlloysRester
 
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY") is None, reason="No API key found.")
+@requires_api_key
 def test_alloys_search():
     client_search_testing(
         search_method=AlloysRester().search,

tests/materials/test_alloys.py

@@ -1,5 +1,5 @@
 import os
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 import pytest
 from mp_api.client.routes.materials.bonds import BondsRester
 
@@ -35,7 +35,7 @@ def rester():
 }  # type: dict
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY", None) is None, reason="No API key found.")
+@requires_api_key
 def test_client(rester):
     search_method = rester.search
 

tests/materials/test_bonds.py

@@ -1,5 +1,5 @@
 import os
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 
 import pytest
 
@@ -44,7 +44,7 @@ def rester():
 }  # type: dict
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY", None) is None, reason="No API key found.")
+@requires_api_key
 def test_client(rester):
     search_method = rester.search
 

tests/materials/test_chemenv.py

@@ -1,5 +1,5 @@
 import os
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 
 import pytest
 
@@ -33,7 +33,7 @@ def rester():
 }  # type: dict
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY", None) is None, reason="No API key found.")
+@requires_api_key
 def test_client(rester):
     search_method = rester.search
 

tests/materials/test_dielectric.py

@@ -1,13 +1,9 @@
-import os
-
-import pytest
-
 from mp_api.client.routes.materials import DOIRester
 
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY") is None, reason="No API key found.")
+@requires_api_key
 def test_doi_search():
     client_search_testing(
         search_method=DOIRester().search,

tests/materials/test_doi.py

@@ -1,5 +1,5 @@
 import os
-from core_function import client_search_testing
+from ..conftest import client_search_testing, requires_api_key
 
 import pytest
 
@@ -38,7 +38,7 @@ def rester():
 custom_field_tests = {"material_ids": ["mp-149"]}  # type: dict
 
 
-@pytest.mark.skipif(os.getenv("MP_API_KEY", None) is None, reason="No API key found.")
+@requires_api_key
 def test_client(rester):
     search_method = rester.search