fix typing error in api.py

Author: Seppli11

src/pysonar_scanner/api.py

@@ -19,7 +19,7 @@
 #
 import typing
 from dataclasses import dataclass
-from typing import Any, Optional, TypedDict
+from typing import Any, Optional
 
 import requests
 import requests.auth
@@ -112,33 +112,35 @@ def from_dict(dict: dict) -> "JRE":
             raise MissingKeyException(f"Missing key in dictionary {dict}") from e
 
 
-ApiConfiguration = TypedDict(
-    "ApiConfiguration",
-    {SONAR_HOST_URL: str, SONAR_SCANNER_SONARCLOUD_URL: str, SONAR_SCANNER_API_BASE_URL: str, SONAR_REGION: str},
-)
+@dataclass(frozen=True)
+class ApiConfiguration:
+    sonar_host_url: str
+    sonar_scanner_sonarcloud_url: str
+    sonar_scanner_api_base_url: str
+    sonar_region: str
 
 
 def to_api_configuration(config_dict: dict[Key, Any]) -> ApiConfiguration:
-    return {
-        SONAR_HOST_URL: config_dict.get(SONAR_HOST_URL, ""),
-        SONAR_SCANNER_SONARCLOUD_URL: config_dict.get(SONAR_SCANNER_SONARCLOUD_URL, ""),
-        SONAR_SCANNER_API_BASE_URL: config_dict.get(SONAR_SCANNER_API_BASE_URL, ""),
-        SONAR_REGION: config_dict.get(SONAR_REGION, ""),
-    }
+    return ApiConfiguration(
+        sonar_host_url=config_dict.get(SONAR_HOST_URL, ""),
+        sonar_scanner_sonarcloud_url=config_dict.get(SONAR_SCANNER_SONARCLOUD_URL, ""),
+        sonar_scanner_api_base_url=config_dict.get(SONAR_SCANNER_API_BASE_URL, ""),
+        sonar_region=config_dict.get(SONAR_REGION, ""),
+    )
 
 
 def get_base_urls(config_dict: dict[Key, Any]) -> BaseUrls:
     def is_sq_cloud_url(api_config: ApiConfiguration, sonar_host_url: str) -> bool:
-        sq_cloud_url = api_config[SONAR_SCANNER_SONARCLOUD_URL] or GLOBAL_SONARCLOUD_URL
+        sq_cloud_url = api_config.sonar_scanner_sonarcloud_url or GLOBAL_SONARCLOUD_URL
         return remove_trailing_slash(sonar_host_url) in [remove_trailing_slash(sq_cloud_url), US_SONARCLOUD_URL]
 
     def is_blank(str) -> bool:
         return str.strip() == ""
 
     api_config: ApiConfiguration = to_api_configuration(config_dict)
 
-    sonar_host_url = remove_trailing_slash(api_config[SONAR_HOST_URL])
-    region = api_config[SONAR_REGION]
+    sonar_host_url = remove_trailing_slash(api_config.sonar_host_url)
+    region = api_config.sonar_region
     if region and region != "us":
         raise InconsistentConfiguration(
             f"Invalid region '{region}'. Valid regions are: 'us'. "
@@ -152,11 +154,11 @@ def is_blank(str) -> bool:
     if is_blank(sonar_host_url) or is_sq_cloud_url(api_config, sonar_host_url):
         default_url = US_SONARCLOUD_URL if region == "us" else GLOBAL_SONARCLOUD_URL
         default_api_base_url = "https://api.sonarqube.us" if region == "us" else "https://api.sonarcloud.io"
-        sonar_host_url = api_config[SONAR_SCANNER_SONARCLOUD_URL] or default_url
-        api_base_url = api_config[SONAR_SCANNER_API_BASE_URL] or default_api_base_url
+        sonar_host_url = api_config.sonar_scanner_sonarcloud_url or default_url
+        api_base_url = api_config.sonar_scanner_api_base_url or default_api_base_url
         return BaseUrls(base_url=sonar_host_url, api_base_url=api_base_url, is_sonar_qube_cloud=True)
     else:
-        api_base_url = api_config[SONAR_SCANNER_API_BASE_URL] or f"{sonar_host_url}/api/v2"
+        api_base_url = api_config.sonar_scanner_api_base_url or f"{sonar_host_url}/api/v2"
         return BaseUrls(base_url=sonar_host_url, api_base_url=api_base_url, is_sonar_qube_cloud=False)
 
 

tests/unit/test_api.py

@@ -30,7 +30,7 @@
     SONAR_SCANNER_API_BASE_URL,
     SONAR_SCANNER_SONARCLOUD_URL,
 )
-from pysonar_scanner.api import SQVersion
+from pysonar_scanner.api import SQVersion, ApiConfiguration
 from pysonar_scanner.exceptions import InconsistentConfiguration
 from tests.unit import sq_api_utils
 from tests.unit.sq_api_utils import sq_api_mocker
@@ -433,19 +433,25 @@ def test_download_analysis_jre(self):
 
     def test_to_api_configuration(self):
         with self.subTest("Missing keys"):
-            expected = {
-                SONAR_HOST_URL: "",
-                SONAR_SCANNER_SONARCLOUD_URL: "",
-                SONAR_SCANNER_API_BASE_URL: "",
-                SONAR_REGION: "",
-            }
+            expected = ApiConfiguration(
+                sonar_host_url="",
+                sonar_scanner_sonarcloud_url="",
+                sonar_scanner_api_base_url="",
+                sonar_region="",
+            )
             self.assertEqual(expected, api.to_api_configuration({}))
 
         with self.subTest("All keys"):
-            expected = {
+            input_config = {
                 SONAR_HOST_URL: "https://sonarcloud.io",
                 SONAR_SCANNER_SONARCLOUD_URL: "https://sonarcloud.io",
                 SONAR_SCANNER_API_BASE_URL: "https://api.sonarcloud.io",
                 SONAR_REGION: "us",
             }
-            self.assertEqual(expected, api.to_api_configuration(expected))
+            expected = ApiConfiguration(
+                sonar_host_url="https://sonarcloud.io",
+                sonar_scanner_sonarcloud_url="https://sonarcloud.io",
+                sonar_scanner_api_base_url="https://api.sonarcloud.io",
+                sonar_region="us",
+            )
+            self.assertEqual(expected, api.to_api_configuration(input_config))