Add mypy and typing

Author: dunderrrrrr

blocket_api/blocket.py

@@ -76,7 +76,7 @@ class APIError(Exception): ...
 class LimitError(Exception): ...
 
 
-def _make_request(*, url, token: str, raise_for_status: bool = True) -> Response:
+def _make_request(*, url: str, token: str, raise_for_status: bool = True) -> Response:
     try:
         response = httpx.get(
             url,
@@ -170,7 +170,7 @@ def motor_search(
         modelYear: Optional[Tuple[int, int]] = None,
         milage: Optional[Tuple[int, int]] = None,
         gearbox: Optional[GEARBOX_OPTIONS] = None,
-    ):
+    ) -> dict:
         """
         Search specifically in the car section of Blocket
         with set optional parameters for filtering.

poetry.lock

@@ -12,6 +12,7 @@ pre-commit = "^3.7.1"
 ruff = "^0.5.2"
 pytest = "^8.2.2"
 respx = "^0.21.1"
+mypy = "^1.15.0"
 
 [project.urls]
 Homepage = "https://github.com/dunderrrrrr/blocket_api"

pyproject.toml

@@ -4,17 +4,19 @@
 api = BlocketAPI("token")
 
 
-def test_limit_errors():
+def test_limit_errors() -> None:
     with pytest.raises(LimitError):
         api.get_listings(limit=100)
 
     with pytest.raises(LimitError):
         api.custom_search("saab", limit=100)
 
 
-def test_typeerrors():
+def test_typeerrors() -> None:
     with pytest.raises(TypeError):
-        api.custom_search()  # missing search query
+        # missing search query
+        api.custom_search()  # type: ignore[call-arg]
 
     with pytest.raises(TypeError):
-        BlocketAPI()
+        # missing token
+        BlocketAPI()  # type: ignore[call-arg]

tests/assertions.py

@@ -6,12 +6,12 @@
 api = BlocketAPI("token")
 
 
-def test_make_request_no_raise():
+def test_make_request_no_raise() -> None:
     _make_request(url=f"{BASE_URL}/not_found", token="token", raise_for_status=False)
 
 
 @respx.mock
-def test_make_request_raise_404():
+def test_make_request_raise_404() -> None:
     respx.get(f"{BASE_URL}/not_found").mock(
         return_value=Response(status_code=404),
     )
@@ -20,7 +20,7 @@ def test_make_request_raise_404():
 
 
 @respx.mock
-def test_make_request_raise_401():
+def test_make_request_raise_401() -> None:
     respx.get(f"{BASE_URL}/unauthorized").mock(
         return_value=Response(status_code=401),
     )

tests/requests.py

@@ -6,7 +6,7 @@
 
 
 @respx.mock
-def test_saved_searches():
+def test_saved_searches() -> None:
     """
     Make sure mobility saved searches are merged with v2/searches.
     """
@@ -35,15 +35,15 @@ def test_saved_searches():
 
 
 @respx.mock
-def test_for_search_id():
+def test_for_search_id() -> None:
     respx.get(f"{BASE_URL}/saved/v2/searches_content/123?lim=99").mock(
         return_value=Response(status_code=200, json={"data": "listings-data"}),
     )
     assert api.get_listings(search_id=123) == {"data": "listings-data"}
 
 
 @respx.mock
-def test_for_search_id_mobility():
+def test_for_search_id_mobility() -> None:
     respx.get(f"{BASE_URL}/saved/v2/searches_content/123?lim=99").mock(
         return_value=Response(status_code=404),
     )
@@ -54,7 +54,7 @@ def test_for_search_id_mobility():
 
 
 @respx.mock
-def test_custom_search():
+def test_custom_search() -> None:
     respx.get(
         f"{BASE_URL}/search_bff/v2/content?lim=99&q=saab&r=20&status=active"
     ).mock(
@@ -67,7 +67,7 @@ def test_custom_search():
 
 class Test_MotorSearchURLs:
     @respx.mock
-    def test_make_filter(self):
+    def test_make_filter(self) -> None:
         expected_url_filter = '?filter={"key": "make", "values": ["Audi", "Toyota"]}'
         respx.get(
             f"{BASE_URL}/motor-search-service/v4/search/car"
@@ -79,7 +79,7 @@ def test_make_filter(self):
         assert api.motor_search(page=1, make=["Audi", "Toyota"]) == {"data": "ok"}
 
     @respx.mock
-    def test_range_filters(self):
+    def test_range_filters(self) -> None:
         expected_url_filter = (
             '?filter={"key": "make", "values": ["Ford"]}'
             '&filter={"key": "price", "range": {"start": "1000", "end": "2000"}}'