#256: Fixed type hints

doc/changes/changes_1.1.0.md

@@ -14,3 +14,4 @@ t.b.d.
 
  - #254: Replaced `set-output` GH command and updated Python Toolbox and ITDE
  - #257: Updated formating rules
+ - #256: Fixed type hints

exasol/slc/api/run_db_tests.py

@@ -37,7 +37,7 @@ def run_db_test(
     generic_language_test: Tuple[str, ...] = tuple(),
     test_folder: Tuple[str, ...] = tuple(),
     test_file: Tuple[str, ...] = tuple(),
-    test_language: Tuple[str, ...] = (None,),  # type: ignore
+    test_language: Tuple[Optional[str], ...] = (None,),
     test: Tuple[str, ...] = tuple(),
     environment_type: str = "docker_db",
     max_start_attempts: int = 2,

exasol/slc/internal/tasks/build/docker_build.py

@@ -1,48 +1,65 @@
+# pylint: disable=not-an-iterable
+from typing import Dict, Generator, Optional, Set, Tuple
+
 import luigi
+from exasol_integration_test_docker_environment.lib.base.abstract_task_future import (
+    AbstractTaskFuture,
+)
+from exasol_integration_test_docker_environment.lib.base.base_task import BaseTask
 from exasol_integration_test_docker_environment.lib.base.flavor_task import (
     FlavorsBaseTask,
 )
-from exasol_integration_test_docker_environment.lib.base.json_pickle_target import (
-    JsonPickleTarget,
-)
-from exasol_integration_test_docker_environment.lib.base.pickle_target import (
-    PickleTarget,
+from exasol_integration_test_docker_environment.lib.docker.images.image_info import (
+    ImageInfo,
 )
 from luigi import Config
-from luigi.format import Nop
 
 from exasol.slc.internal.tasks.build.docker_flavor_build_base import (
     DockerFlavorBuildBase,
 )
 
 
 class DockerBuildParameter(Config):
-    goals = luigi.ListParameter()
-    shortcut_build = luigi.BoolParameter(True)
+    goals: Tuple[str, ...] = luigi.ListParameter()  # type: ignore
+    shortcut_build: bool = luigi.BoolParameter(True)  # type: ignore
 
 
 class DockerBuild(FlavorsBaseTask, DockerBuildParameter):
 
-    def __init__(self, *args, **kwargs):
-        self._images_futures = None
+    def __init__(self, *args, **kwargs) -> None:
+        self._images_futures: Optional[AbstractTaskFuture] = None
         super().__init__(*args, **kwargs)
 
-    def register_required(self):
+    def register_required(self) -> None:
         tasks = self.create_tasks_for_flavors_with_common_params(DockerFlavorBuild)
         self._images_futures = self.register_dependencies(tasks)
 
-    def run_task(self):
-        image_info = self.get_values_from_futures(self._images_futures)
-        self.return_object(image_info)
+    def run_task(self) -> None:
+        image_infos: Dict[str, Dict[str, ImageInfo]] = self.get_values_from_futures(
+            self._images_futures
+        )
+        assert isinstance(image_infos, dict)
+        assert all(isinstance(x, str) for x in image_infos.keys())
+        assert all(isinstance(x, dict) for x in image_infos.values())
+        assert all(isinstance(y, str) for x in image_infos.values() for y in x.keys())
+        assert all(
+            isinstance(y, ImageInfo) for x in image_infos.values() for y in x.values()
+        )
+        self.return_object(image_infos)
 
 
 class DockerFlavorBuild(DockerFlavorBuildBase, DockerBuildParameter):
 
-    def get_goals(self):
-        return self.goals
+    def get_goals(self) -> Set[str]:
+        return set(self.goals)
 
-    def run_task(self):
+    def run_task(self) -> Generator[BaseTask, None, None]:
         build_tasks = self.create_build_tasks(self.shortcut_build)
         image_info_futures = yield from self.run_dependencies(build_tasks)
-        image_infos = self.get_values_from_futures(image_info_futures)
+        image_infos: Dict[str, ImageInfo] = self.get_values_from_futures(
+            image_info_futures
+        )
+        assert isinstance(image_infos, dict)
+        assert all(isinstance(x, str) for x in image_infos.keys())
+        assert all(isinstance(x, ImageInfo) for x in image_infos.values())
         self.return_object(image_infos)

exasol/slc/internal/tasks/build/docker_flavor_image_task.py

@@ -26,7 +26,7 @@ class DockerFlavorAnalyzeImageTask(DockerAnalyzeImageTask, FlavorBaseTask):
     #  In this case DockerPullOrBuildFlavorImageTask could create a DockerPullOrBuildImageTask
     #  if this would have parameters instead of abstract methods
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         self.build_step = (  # pylint: disable=assignment-from-no-return
             self.get_build_step()
         )
@@ -42,7 +42,7 @@ def is_rebuild_requested(self) -> bool:
             or len(config.force_rebuild_from) == 0
         )
 
-    def get_build_step(self) -> str:  # type: ignore
+    def get_build_step(self) -> Optional[str]:
         """
         Called by the constructor to get the name of build step.
         Sub classes need to implement this method.
@@ -83,15 +83,15 @@ def get_source_repository_name(self) -> str:
     def get_target_repository_name(self) -> str:
         return target_docker_repository_config().repository_name  # type: ignore
 
-    def get_source_image_tag(self):
+    def get_source_image_tag(self) -> str:
         if source_docker_repository_config().tag_prefix != "":
             return (
                 f"{source_docker_repository_config().tag_prefix}_{self.get_image_tag()}"
             )
         else:
             return f"{self.get_image_tag()}"
 
-    def get_target_image_tag(self):
+    def get_target_image_tag(self) -> str:
         if target_docker_repository_config().tag_prefix != "":
             return (
                 f"{target_docker_repository_config().tag_prefix}_{self.get_image_tag()}"
@@ -105,7 +105,8 @@ def get_image_tag(self) -> str:
 
     def get_mapping_of_build_files_and_directories(self) -> Dict[str, str]:
         build_step_path = self.get_build_step_path()
-        result = {self.build_step: str(build_step_path)}
+        assert self.build_step is not None
+        result: Dict[str, str] = {self.build_step: str(build_step_path)}
         result.update(self.additional_build_directories_mapping)
         if language_definition := self.get_language_definition():
             lang_def_path = self.get_path_in_flavor_path() / language_definition
@@ -120,13 +121,17 @@ def get_mapping_of_build_files_and_directories(self) -> Dict[str, str]:
         return result
 
     def get_build_step_path(self) -> Path:
-        return self.get_path_in_flavor_path() / self.get_build_step()
+        if build_step_path := self.get_build_step():
+            return self.get_path_in_flavor_path() / build_step_path
+        else:
+            return self.get_path_in_flavor_path()
 
     def get_path_in_flavor_path(self) -> Path:
+        flavor_path: str = self.flavor_path  # type: ignore
         if path_in_flavor := self.get_path_in_flavor():
-            return Path(self.flavor_path) / path_in_flavor  # type: ignore
+            return Path(flavor_path) / path_in_flavor
         else:
-            return Path(self.flavor_path)  # type: ignore
+            return Path(flavor_path)
 
     def get_dockerfile(self) -> str:
         return str(self.get_build_step_path().joinpath("Dockerfile"))

exasol/slc/internal/tasks/clean/clean_images.py

@@ -1,4 +1,9 @@
+from typing import Generator, List
+
+import docker.models.images
 import luigi
+from docker import DockerClient
+from exasol_integration_test_docker_environment.lib.base.base_task import BaseTask
 from exasol_integration_test_docker_environment.lib.base.docker_base_task import (
     DockerBaseTask,
 )
@@ -14,12 +19,9 @@
 
 
 class CleanImageTask(DockerBaseTask):
-    image_id = luigi.Parameter()
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+    image_id: str = luigi.Parameter()  # type: ignore
 
-    def run_task(self):
+    def run_task(self) -> Generator[BaseTask, None, None]:
         self.logger.info("Try to remove dependent images of %s" % self.image_id)
         yield from self.run_dependencies(
             self.get_clean_image_tasks_for_dependent_images()
@@ -38,7 +40,7 @@ def run_task(self):
                     )
                 )
 
-    def get_clean_image_tasks_for_dependent_images(self):
+    def get_clean_image_tasks_for_dependent_images(self) -> List["CleanImageTask"]:
         with self._get_docker_client() as docker_client:
             image_ids = [
                 str(possible_child).replace("sha256:", "")
@@ -50,7 +52,7 @@ def get_clean_image_tasks_for_dependent_images(self):
                 for image_id in image_ids
             ]
 
-    def is_child_image(self, possible_child, docker_client):
+    def is_child_image(self, possible_child, docker_client) -> bool:
         try:
             inspect = docker_client.api.inspect_image(
                 image=str(possible_child).replace("sha256:", "")
@@ -61,9 +63,9 @@ def is_child_image(self, possible_child, docker_client):
 
 
 class CleanImagesStartingWith(DockerBaseTask):
-    starts_with_pattern = luigi.Parameter()
+    starts_with_pattern: str = luigi.Parameter()  # type: ignore
 
-    def register_required(self):
+    def register_required(self) -> None:
         with self._get_docker_client() as docker_client:
             image_ids = [
                 str(image.id).replace("sha256:", "")
@@ -76,7 +78,9 @@ def register_required(self):
             ]
         )
 
-    def find_images_to_clean(self, docker_client):
+    def find_images_to_clean(
+        self, docker_client: DockerClient
+    ) -> List[docker.models.images.Image]:
         self.logger.info(
             "Going to remove all images starting with %s" % self.starts_with_pattern
         )

exasol/slc/internal/tasks/export/create_export_directory.py

@@ -9,7 +9,7 @@ class CreateExportDirectory(DependencyLoggerBaseTask):
     # This task is needed because ExportContainerTask
     # requires the releases directory which stores the exported container.
 
-    def run_task(self):
+    def run_task(self) -> None:
         export_directory = Path(self.get_cache_path(), "exports")
         export_directory.mkdir(parents=True, exist_ok=True)
         self.return_object(export_directory)