Clean up type hints for HTTP APIs

Author: timopollmeier

gvm/http/core/connector.py

@@ -7,7 +7,7 @@
 """
 
 import urllib.parse
-from typing import Any, Dict, Optional, Tuple
+from typing import Any, Dict, Optional, Tuple, Union
 
 from requests import Session
 
@@ -44,7 +44,7 @@ def __init__(
         base_url: str,
         *,
         server_ca_path: Optional[str] = None,
-        client_cert_paths: Optional[str | Tuple[str]] = None,
+        client_cert_paths: Optional[Union[str, Tuple[str]]] = None,
     ):
         """
         Create a new HTTP API Connector.

gvm/http/core/headers.py

@@ -7,8 +7,7 @@
 """
 
 from dataclasses import dataclass
-from typing import Dict, Optional, TypeVar
-
+from typing import Dict, Optional, TypeVar, Type, Union
 
 Self = TypeVar("Self", bound="ContentType")
 
@@ -22,18 +21,18 @@ class ContentType:
     media_type: str
     'The MIME media type, e.g. "application/json"'
 
-    params: Dict[str, str]
+    params: Dict[str, Union[bool, str]]
     "Dictionary of parameters in the content type header"
 
     charset: Optional[str]
     "The charset parameter in the content type header if it is set"
 
     @classmethod
     def from_string(
-        cls,
-        header_string: str,
-        fallback_media_type: Optional[str] = "application/octet-stream",
-    ) -> Self:
+        cls: Type[Self],
+        header_string: Optional[str],
+        fallback_media_type: str = "application/octet-stream",
+    ) -> "ContentType":
         """
         Parse the content of content type header into a ContentType object.
 
@@ -42,12 +41,13 @@ def from_string(
             fallback_media_type: The media type to use if the `header_string` is `None` or empty.
         """
         media_type = fallback_media_type
-        params = {}
+        params: Dict[str, Union[bool, str]] = {}
         charset = None
 
         if header_string:
             parts = header_string.split(";")
-            media_type = parts[0].strip()
+            if len(parts) > 0:
+                media_type = parts[0].strip()
             for part in parts[1:]:
                 param = part.strip()
                 if "=" in param:

gvm/http/core/response.py

@@ -7,9 +7,10 @@
 """
 
 from dataclasses import dataclass
-from typing import Any, Dict, Optional, TypeVar
+from typing import Any, Dict, Optional, TypeVar, Type, Union
 
 from requests import Response
+from requests.structures import CaseInsensitiveDict
 
 from gvm.http.core.headers import ContentType
 
@@ -29,14 +30,14 @@ class HttpResponse:
     status: int
     "HTTP status code of the response"
 
-    headers: Dict[str, str]
+    headers: Union[Dict[str, str], CaseInsensitiveDict[str]]
     "Dict containing the headers of the response"
 
     content_type: Optional[ContentType]
     "The content type of the response if it was included in the headers"
 
     @classmethod
-    def from_requests_lib(cls, r: Response) -> Self:
+    def from_requests_lib(cls: Type[Self], r: Response) -> "HttpResponse":
         """
         Creates a new HTTP response object from a Request object created by the "Requests" library.
 

gvm/http/openvasd/openvasd1.py

@@ -7,7 +7,7 @@
 """
 
 import urllib.parse
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 from gvm.errors import InvalidArgumentType
 from gvm.http.core._api import GvmHttpApi
@@ -150,7 +150,7 @@ def get_scan_preferences(
     def create_scan(
         self,
         target: dict[str, Any],
-        vt_selection: dict[str, Any],
+        vt_selection: list[dict[str, Any]],
         scanner_params: Optional[dict[str, Any]] = None,
         *,
         raise_for_status: bool = False,
@@ -288,7 +288,7 @@ def get_scan_results(
     def get_scan_result(
         self,
         scan_id: str,
-        result_id: str | int,
+        result_id: Union[str, int],
         *,
         raise_for_status: bool = False,
     ) -> HttpResponse:

poetry.lock

@@ -33,6 +33,7 @@ python = "^3.9.2"
 paramiko = ">=2.7.1"
 lxml = ">=4.5.0"
 requests = "^2.32.3"
+types-requests = "^2.32.0.20250328"
 
 [tool.poetry.group.dev.dependencies]
 coverage = ">=7.2"

pyproject.toml

@@ -20,7 +20,7 @@ def new_mock_empty_response(
     if status is None:
         status = int(HTTPStatus.NO_CONTENT)
     if headers is None:
-        headers = []
+        headers = {}
     content_type = ContentType.from_string(None)
     return HttpResponse(
         body=None, status=status, headers=headers, content_type=content_type
@@ -126,7 +126,7 @@ def test_create_scan(self, mock_connector: Mock):
         # minimal scan
         response = api.create_scan(
             {"hosts": "somehost"},
-            ["some_vt", "another_vt"],
+            [{"oid": "some_vt"}, {"oid": "another_vt"}],
         )
         mock_connector.post_json.assert_called_once_with(
             "/scans",
@@ -142,7 +142,7 @@ def test_create_scan(self, mock_connector: Mock):
         mock_connector.post_json.reset_mock()
         response = api.create_scan(
             {"hosts": "somehost"},
-            ["some_vt", "another_vt"],
+            [{"oid": "some_vt"}, {"oid": "another_vt"}],
             {"my_scanner_param": "abc"},
         )
         mock_connector.post_json.assert_called_once_with(