Add mypy type checking to CI workflow

Fix mypy errors: add types-requests stubs, fix variable type
reassignment in query serialization, and add cast for HostResult.
Add make typecheck step to both CI jobs.

Closes #42

Author: dannywillems

.github/workflows/actions.yml

@@ -26,6 +26,8 @@ jobs:
         run: make check-format
       - name: Run linter
         run: make lint
+      - name: Type check
+        run: make typecheck
       - name: Security audit
         run: make audit
 
@@ -49,5 +51,7 @@ jobs:
         run: make check-format
       - name: Run linter
         run: make lint
+      - name: Type check
+        run: make typecheck
       - name: Security audit
         run: make audit

leakix/client.py

@@ -2,7 +2,7 @@
 import json
 from enum import Enum
 from importlib.metadata import version
-from typing import Any
+from typing import Any, cast
 
 import requests
 from l9format import l9format
@@ -99,9 +99,7 @@ def get(
         if queries is None or len(queries) == 0:
             serialized_query = EmptyQuery().serialize()
         else:
-            serialized_query = [q.serialize() for q in queries]
-            serialized_query = " ".join(serialized_query)
-            serialized_query = f"{serialized_query}"
+            serialized_query = " ".join(q.serialize() for q in queries)
         url = f"{self.base_url}/search"
         r = self.__get(
             url=url,
@@ -149,7 +147,7 @@ def get_host(self, ipv4: str) -> AbstractResponse:
         r = self.__get(url, params=None)
         if r.is_success():
             response_json = r.json()
-            formatted_result = HostResult.from_dict(response_json)
+            formatted_result = cast(HostResult, HostResult.from_dict(response_json))
             response_json = {
                 "services": formatted_result.Services,
                 "leaks": formatted_result.Leaks,
@@ -190,9 +188,7 @@ def bulk_export(self, queries: list[Query] | None = None) -> AbstractResponse:
         if queries is None or len(queries) == 0:
             serialized_query = EmptyQuery().serialize()
         else:
-            serialized_query = [q.serialize() for q in queries]
-            serialized_query = " ".join(serialized_query)
-            serialized_query = f"{serialized_query}"
+            serialized_query = " ".join(q.serialize() for q in queries)
         params = {"q": serialized_query}
         r = requests.get(url, params=params, headers=self.headers, stream=True)
         if r.status_code == 200:
@@ -228,9 +224,7 @@ def bulk_service(self, queries: list[Query] | None = None) -> AbstractResponse:
         if queries is None or len(queries) == 0:
             serialized_query = EmptyQuery().serialize()
         else:
-            serialized_query = [q.serialize() for q in queries]
-            serialized_query = " ".join(serialized_query)
-            serialized_query = f"{serialized_query}"
+            serialized_query = " ".join(q.serialize() for q in queries)
         params = {"q": serialized_query}
         r = requests.get(url, params=params, headers=self.headers, stream=True)
         if r.status_code == 200:

pyproject.toml

@@ -16,6 +16,7 @@ dev = [
     "pytest",
     "pytest-cov",
     "mypy",
+    "types-requests",
     "requests-mock",
     "ruff",
     "pip-audit",