SCANPY-160 add mypy to the ci (#185)

Author: Seppli11

.cirrus.yml

@@ -165,7 +165,9 @@ analysis_linux_task:
   alias: analysis
   name: "NEXT Analysis"
   analysis_script:
+    - poetry install
     - poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests
+    - poetry run mypy src/ > mypy-report.txt || true # mypy exits with 1 if there are errors
     - uv venv
     - source .venv/bin/activate
     - uv pip install pysonar-scanner

poetry.lock

@@ -47,6 +47,7 @@ pytest-cov = '6.1.0'
 pytest-subtests = "^0.14.1"
 pytest-docker = "^3.2.0"
 debugpy = "^1.8.13"
+types-requests = "^2.32.0.20250328"
 
 [[tool.poetry.packages]]
 from = 'src'

pyproject.toml

@@ -3,6 +3,7 @@ sonar.projectName=Python Scanner
 sonar.projectVersion=1.0.0
 sonar.python.version=3.9,3.10,3.11,3.12,3.13
 sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.mypy.reportPaths=mypy-report.txt
 sonar.analysisCache.enabled=true
 sonar.sources=src
 sonar.tests=tests

sonar-project.properties

@@ -19,6 +19,7 @@
 #
 
 import logging
+from typing import Any
 from pysonar_scanner import app_logging
 from pysonar_scanner import cache
 from pysonar_scanner import exceptions
@@ -71,7 +72,7 @@ def set_logging_options(config):
     app_logging.configure_logging_level(verbose=config.get(SONAR_VERBOSE, False))
 
 
-def build_api(config: dict[str, any]) -> SonarQubeApi:
+def build_api(config: dict[str, Any]) -> SonarQubeApi:
     token = configuration_loader.get_token(config)
     base_urls = get_base_urls(config)
     return SonarQubeApi(base_urls, token)
@@ -109,7 +110,7 @@ def create_scanner_engine(api, cache_manager, config):
     return scanner
 
 
-def create_jre(api, cache, config: dict[str, any]) -> JREResolvedPath:
+def create_jre(api, cache, config: dict[str, Any]) -> JREResolvedPath:
     jre_provisioner = JREProvisioner(api, cache, config[SONAR_SCANNER_OS], config[SONAR_SCANNER_ARCH])
     jre_resolver = JREResolver(JREResolverConfiguration.from_dict(config), jre_provisioner)
     return jre_resolver.resolve_jre()

src/pysonar_scanner/__main__.py

@@ -19,7 +19,7 @@
 #
 import typing
 from dataclasses import dataclass
-from typing import NoReturn, Optional, TypedDict
+from typing import Any, NoReturn, Optional
 
 import requests
 import requests.auth
@@ -118,33 +118,35 @@ def from_dict(dict: dict) -> "JRE":
         )
 
 
-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, ""),
-    }
+def to_api_configuration(config_dict: dict[Key, Any]) -> ApiConfiguration:
+    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 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'. "
@@ -158,11 +160,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)
 
 

src/pysonar_scanner/api.py

@@ -18,6 +18,7 @@
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 import argparse
+from typing import Any
 
 from pysonar_scanner.configuration import properties
 from pysonar_scanner.exceptions import UnexpectedCliArgument
@@ -26,7 +27,7 @@
 class CliConfigurationLoader:
 
     @classmethod
-    def load(cls) -> dict[str, any]:
+    def load(cls) -> dict[str, Any]:
         args, unknown_args = cls.__parse_cli_args()
         config = {}
         for prop in properties.PROPERTIES:

src/pysonar_scanner/configuration/cli.py

@@ -19,6 +19,7 @@
 #
 import logging
 from pathlib import Path
+from typing import Any
 
 from pysonar_scanner.configuration.cli import CliConfigurationLoader
 from pysonar_scanner.configuration.pyproject_toml import TomlConfigurationLoader
@@ -29,13 +30,13 @@
 from pysonar_scanner.exceptions import MissingProperty, MissingPropertyException
 
 
-def get_static_default_properties() -> dict[Key, any]:
+def get_static_default_properties() -> dict[Key, Any]:
     return {prop.name: prop.default_value for prop in PROPERTIES if prop.default_value is not None}
 
 
 class ConfigurationLoader:
     @staticmethod
-    def load() -> dict[Key, any]:
+    def load() -> dict[Key, Any]:
         logging.debug("Loading configuration properties...")
 
         # each property loader is required to return NO default values.
@@ -60,7 +61,7 @@ def load() -> dict[Key, any]:
         return resolved_properties
 
     @staticmethod
-    def check_configuration(config: dict[Key, any]) -> None:
+    def check_configuration(config: dict[Key, Any]) -> None:
         missing_keys = []
         if SONAR_TOKEN not in config:
             missing_keys.append(MissingProperty(SONAR_TOKEN, "--token"))
@@ -72,7 +73,7 @@ def check_configuration(config: dict[Key, any]) -> None:
             raise MissingPropertyException.from_missing_keys(*missing_keys)
 
 
-def get_token(config: dict[Key, any]) -> str:
+def get_token(config: dict[Key, Any]) -> str:
     if SONAR_TOKEN not in config:
         raise MissingPropertyException(f'Missing property "{SONAR_TOKEN}"')
     return config[SONAR_TOKEN]

src/pysonar_scanner/configuration/configuration_loader.py

@@ -18,13 +18,13 @@
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 import os
-from typing import Dict
+from typing import Any, Dict
 
 from pysonar_scanner.configuration.properties import Key, SONAR_SCANNER_OS, SONAR_SCANNER_ARCH, SONAR_PROJECT_BASE_DIR
 from pysonar_scanner import utils
 
 
-def load() -> Dict[Key, any]:
+def load() -> Dict[Key, Any]:
     """
     Load dynamically computed default properties
     """

src/pysonar_scanner/configuration/dynamic_defaults_loader.py

@@ -20,7 +20,7 @@
 import time
 import argparse
 from dataclasses import dataclass
-from typing import Callable, Optional
+from typing import Any, Callable, Optional
 
 Key = str
 
@@ -106,10 +106,10 @@ class Property:
     name: Key
     """name in the format of `sonar.scanner.appVersion`"""
 
-    default_value: Optional[any]
+    default_value: Optional[Any]
     """default value for the property; if None, no default value is set"""
 
-    cli_getter: Optional[Callable[[argparse.Namespace], any]] = None
+    cli_getter: Optional[Callable[[argparse.Namespace], Any]] = None
     """function to get the value from the CLI arguments namespace. If None, the property is not settable via CLI"""
 
     def python_name(self) -> str: