PYSCAN-18: Setup type checker (#3)

Author: joke1196

README.md

@@ -37,12 +37,22 @@ Run `python3 -m twine upload --repository testpypi dist/*`
 `--repository testpypi` can be removed to push to the prod PyPI instance.
 Also `dist/*` can be a bit more precise to upload a specific version of the binaries
 
-## Before push
+# Tooling 
+## Formatting 
 
-Please check if all files have a license header.
+Run `hatch run tool:format` to run the formatter on all files.
+
+## Type checking
+
+Run `hatch run tool:type_check` to execute the type checking on all files.
+
+## License header
+
+Before pushing, please check if all files have a license header.
 If not all files have a license header please execute: `hatch run tool:license`.
 
-## License
+
+# License
 
 Copyright 2011-2023 SonarSource.
 

pyproject.toml

@@ -58,12 +58,14 @@ python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
 [tool.hatch.envs.tool]
 dependencies = [
   "licenseheaders",
-  "black"
+  "black",
+  "mypy"
 ] 
 
 [tool.hatch.envs.tool.scripts]
 license = 'python -m licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py' 
 format = 'python -m black src/ tests/ --check'
+type_check = "python -m mypy src/ tests/ --ignore-missing-imports"
 
 [tool.pytest.ini_options]
 pythonpath = [

src/py_sonar_scanner/configuration.py

@@ -80,7 +80,7 @@ def _read_jvm_args(self) -> list[str]:
         return scan_arguments
 
     def _read_toml_args(self) -> list[str]:
-        scan_arguments = []
+        scan_arguments: list[str] = []
         try:
             if os.path.isfile('pyproject.toml'):
                 with open('pyproject.toml', 'r') as file:

src/py_sonar_scanner/scanner.py

@@ -54,7 +54,7 @@ def execute_command(self) -> Popen:
         cmd = self.compute_command()
         return Popen(cmd, stdout=PIPE, stderr=PIPE)
 
-    def _print_output(self, stream: list[str]):
+    def _print_output(self, stream: list[bytes]):
         for line in stream:
             decoded_line = line.decode('utf-8')
             print(decoded_line, end='', flush=True)