Added missing typings. (opensearch-project#2123)

* Added missing typings.

Signed-off-by: dblock <dblock@amazon.com>

* Added missing __init__ annotations.

Signed-off-by: dblock <dblock@amazon.com>

* Use dict instead of Any in manifest arguments.

Signed-off-by: dblock <dblock@amazon.com>

* Removed unused imports.

Signed-off-by: dblock <dblock@amazon.com>

Author: dblock

.github/workflows/python-tests.yml

@@ -32,7 +32,7 @@ jobs:
           pipenv run flake8 .
       - name: Run Type Checker
         run: |
-          pipenv run mypy src/build_workflow tests/tests_build_workflow src/checkout_workflow tests/tests_checkout_workflow src/run_assemble.py tests/test_run_assemble.py src/assemble_workflow tests/tests_assemble_workflow src/manifests tests/tests_manifests src/paths tests/tests_paths src/system tests/tests_system src/ci_workflow tests/tests_ci_workflow src/manifests_workflow tests/tests_manifests_workflow
+          pipenv run mypy .
       - name: Run Tests with Coverage
         run: |
           pipenv run coverage run -m pytest --cov=./src --cov-report=xml

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
       - id: mypy
         stages: [commit]
         name: mypy
-        entry: bash -c 'pipenv run mypy src/build_workflow tests/tests_build_workflow src/checkout_workflow tests/tests_checkout_workflow src/run_assemble.py tests/test_run_assemble.py src/assemble_workflow tests/tests_assemble_workflow src/manifests tests/tests_manifests src/paths tests/tests_paths src/system tests/tests_system src/ci_workflow tests/tests_ci_workflow src/manifests_workflow tests/tests_manifests_workflow'
+        entry: bash -c 'pipenv run mypy .'
         language: system
       - id: pytest
         stages: [commit]

src/build_workflow/build_recorder.py

@@ -16,7 +16,7 @@
 
 
 class BuildRecorder:
-    def __init__(self, target: BuildTarget):
+    def __init__(self, target: BuildTarget) -> None:
         self.build_manifest = self.BuildManifestBuilder(target)
         self.target = target
         self.name = target.name
@@ -52,7 +52,7 @@ def write_manifest(self) -> None:
         logging.info(f"Created build manifest {manifest_path}")
 
     class BuildManifestBuilder:
-        def __init__(self, target: BuildTarget):
+        def __init__(self, target: BuildTarget) -> None:
             self.data: Dict[str, Any] = {}
             self.data["build"] = {}
             self.data["build"]["id"] = target.build_id

src/build_workflow/build_target.py

@@ -34,7 +34,7 @@ def __init__(
         snapshot: bool = True,
         build_id: str = None,
         output_dir: str = "artifacts",
-    ):
+    ) -> None:
         self.build_id = os.getenv("BUILD_NUMBER") or build_id or uuid.uuid4().hex
         self.name = name
         self.version = version

src/build_workflow/builder.py

@@ -12,6 +12,10 @@
 
 
 class Builder(ABC):
+    component: Any
+    target: BuildTarget
+    output_path: str
+
     def __init__(self, component: Any, target: BuildTarget) -> None:
         self.output_path = "builds"
         self.component = component

src/ci_workflow/ci_check_list_source.py

@@ -31,7 +31,7 @@ def checkout(self, work_dir: str) -> None:
     }
 
     class InvalidCheckError(Exception):
-        def __init__(self, check: Any):
+        def __init__(self, check: Any) -> None:
             self.check = check
             super().__init__(f"Invalid check: {check.name}, must be one of {CiCheckListSource.CHECKS.keys()}.")
 

src/manifests/build/build_manifest_1_0.py

@@ -4,8 +4,6 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-from typing import Any
-
 from manifests.component_manifest import Component, ComponentManifest, Components
 
 """
@@ -75,7 +73,7 @@ class BuildManifest_1_0(ComponentManifest['BuildManifest_1_0', 'BuildComponents_
         },
     }
 
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.build = self.Build(data["build"])
         self.components = BuildComponents_1_0(data.get("components", []))  # type: ignore[assignment]
@@ -88,7 +86,7 @@ def __to_dict__(self) -> dict:
         }
 
     class Build:
-        def __init__(self, data: Any):
+        def __init__(self, data: dict) -> None:
             self.name: str = data["name"]
             self.version = data["version"]
             self.architecture = data["architecture"]
@@ -109,12 +107,12 @@ def filename(self) -> str:
 
 class BuildComponents_1_0(Components['BuildComponent_1_0']):
     @classmethod
-    def __create__(self, data: Any) -> 'BuildComponent_1_0':
+    def __create__(self, data: dict) -> 'BuildComponent_1_0':
         return BuildComponent_1_0(data)
 
 
 class BuildComponent_1_0(Component):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.repository = data["repository"]
         self.ref = data["ref"]

src/manifests/build/build_manifest_1_1.py

@@ -4,8 +4,6 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-from typing import Any
-
 from manifests.component_manifest import Component, ComponentManifest, Components
 
 """
@@ -76,7 +74,7 @@ class BuildManifest_1_1(ComponentManifest['BuildManifest_1_1', 'BuildComponents_
         },
     }
 
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.build = self.Build(data["build"])
         self.components = BuildComponents_1_1(data.get("components", []))  # type: ignore[assignment]
@@ -89,7 +87,7 @@ def __to_dict__(self) -> dict:
         }
 
     class Build:
-        def __init__(self, data: Any):
+        def __init__(self, data: dict) -> None:
             self.name: str = data["name"]
             self.version = data["version"]
             self.architecture = data["architecture"]
@@ -110,12 +108,12 @@ def filename(self) -> str:
 
 class BuildComponents_1_1(Components['BuildComponent_1_1']):
     @classmethod
-    def __create__(self, data: Any) -> 'BuildComponent_1_1':
+    def __create__(self, data: dict) -> 'BuildComponent_1_1':
         return BuildComponent_1_1(data)
 
 
 class BuildComponent_1_1(Component):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.repository = data["repository"]
         self.ref = data["ref"]

src/manifests/build_manifest.py

@@ -4,8 +4,6 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-from typing import Any
-
 from manifests.build.build_manifest_1_0 import BuildManifest_1_0
 from manifests.build.build_manifest_1_1 import BuildManifest_1_1
 from manifests.component_manifest import Component, ComponentManifest, Components
@@ -89,7 +87,7 @@ class BuildManifest(ComponentManifest['BuildManifest', 'BuildComponents']):
         },
     }
 
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.build = self.Build(data["build"])
         self.components = BuildComponents(data.get("components", []))  # type: ignore[assignment]
@@ -102,7 +100,7 @@ def __to_dict__(self) -> dict:
         }
 
     class Build:
-        def __init__(self, data: Any):
+        def __init__(self, data: dict) -> None:
             self.name: str = data["name"]
             self.version: str = data["version"]
             self.platform: str = data["platform"]
@@ -127,12 +125,12 @@ def filename(self) -> str:
 
 class BuildComponents(Components['BuildComponent']):
     @classmethod
-    def __create__(self, data: Any) -> 'BuildComponent':
+    def __create__(self, data: dict) -> 'BuildComponent':
         return BuildComponent(data)
 
 
 class BuildComponent(Component):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.repository = data["repository"]
         self.ref = data["ref"]

src/manifests/bundle/bundle_manifest_1_0.py

@@ -4,8 +4,6 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-from typing import Any
-
 from manifests.component_manifest import Component, ComponentManifest, Components
 
 
@@ -59,7 +57,7 @@ class BundleManifest_1_0(ComponentManifest['BundleManifest_1_0', 'BundleComponen
         },
     }
 
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.build = self.Build(data["build"])
         self.components = BundleComponents_1_0(data.get("components", []))  # type: ignore[assignment]
@@ -72,7 +70,7 @@ def __to_dict__(self) -> dict:
         }
 
     class Build:
-        def __init__(self, data: Any):
+        def __init__(self, data: dict) -> None:
             self.name = data["name"]
             self.version = data["version"]
             self.architecture = data["architecture"]
@@ -91,12 +89,12 @@ def __to_dict__(self) -> dict:
 
 class BundleComponents_1_0(Components):
     @classmethod
-    def __create__(self, data: Any) -> 'BundleComponent_1_0':
+    def __create__(self, data: dict) -> 'BundleComponent_1_0':
         return BundleComponent_1_0(data)
 
 
 class BundleComponent_1_0(Component):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.repository = data["repository"]
         self.ref = data["ref"]

src/manifests/bundle_manifest.py

@@ -4,7 +4,7 @@
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
 
-from typing import Any, Dict
+from typing import Dict
 
 from manifests.bundle.bundle_manifest_1_0 import BundleManifest_1_0
 from manifests.component_manifest import Component, ComponentManifest, Components
@@ -65,7 +65,7 @@ class BundleManifest(ComponentManifest['BundleManifest', 'BundleComponents']):
         },
     }
 
-    def __init__(self, data: Any) -> None:
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.build = self.Build(data["build"])
         self.components = BundleComponents(data.get("components", []))  # type: ignore[assignment]
@@ -78,7 +78,7 @@ def __to_dict__(self) -> dict:
         }
 
     class Build:
-        def __init__(self, data: Dict[str, str]):
+        def __init__(self, data: Dict[str, str]) -> None:
             self.name = data["name"]
             self.version = data["version"]
             self.platform = data["platform"]
@@ -105,12 +105,12 @@ def filename(self) -> str:
 
 class BundleComponents(Components['BundleComponent']):
     @classmethod
-    def __create__(self, data: Any) -> 'BundleComponent':
+    def __create__(self, data: dict) -> 'BundleComponent':
         return BundleComponent(data)
 
 
 class BundleComponent(Component):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.repository = data["repository"]
         self.ref = data["ref"]

src/manifests/component_manifest.py

@@ -26,7 +26,7 @@ class ComponentManifest(Manifest[ManifestType], Generic[ManifestType, Components
         }
     }
 
-    def __init__(self, data: Any) -> None:
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
 
         self.components = Components(data.get("components", []))  # type: ignore[assignment]
@@ -44,7 +44,7 @@ def __init__(self, data: Dict[Any, Any]) -> None:
         super().__init__(map(create_component, data))
 
     @classmethod
-    def __create__(self, data: Any) -> ComponentType:
+    def __create__(self, data: dict) -> ComponentType:
         return Component(data)  # type: ignore[return-value]
 
     def __to_dict__(self) -> List[Dict[Any, Any]]:

src/manifests/distribution.py

@@ -4,7 +4,7 @@
 
 
 class DistributionNotFound(Exception):
-    def __init__(self, urls: List[str]):
+    def __init__(self, urls: List[str]) -> None:
         self.urls = urls
         super().__init__(f"Unable to find a distribution under urls {self.urls}")
 

src/manifests/input_manifest.py

@@ -39,7 +39,7 @@
 import copy
 import itertools
 import logging
-from typing import Any, Callable, Iterator, List, Optional
+from typing import Callable, Iterator, List, Optional
 
 from git.git_repository import GitRepository
 from manifests.component_manifest import Component, ComponentManifest, Components
@@ -101,7 +101,7 @@ class InputManifest(ComponentManifest['InputManifest', 'InputComponents']):
         },
     }
 
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
 
         self.build = self.Build(data["build"])
@@ -123,14 +123,14 @@ def stable(self) -> 'InputManifest':
         return manifest
 
     class Ci:
-        def __init__(self, data: Any):
+        def __init__(self, data: dict) -> None:
             self.image = None if data is None else self.Image(data.get("image", None))
 
         def __to_dict__(self) -> Optional[dict]:
             return None if self.image is None else {"image": self.image.__to_dict__()}
 
         class Image:
-            def __init__(self, data: Any):
+            def __init__(self, data: dict) -> None:
                 self.name = data["name"]
                 self.args = data.get("args", None)
 
@@ -141,7 +141,7 @@ def __to_dict__(self) -> dict:
                 }
 
     class Build:
-        def __init__(self, data: Any):
+        def __init__(self, data: dict) -> None:
             self.name: str = data["name"]
             self.version = data["version"]
             self.qualifier = data.get("qualifier", None)
@@ -168,7 +168,7 @@ def filename(self) -> str:
 
 class InputComponents(Components['InputComponent']):
     @classmethod
-    def __create__(self, data: Any) -> 'InputComponent':
+    def __create__(self, data: dict) -> 'InputComponent':
         return InputComponent._from(data)  # type: ignore[no-any-return]
 
     def __stabilize__(self) -> None:
@@ -199,13 +199,13 @@ def select(self, focus: List[str] = [], platform: str = None) -> Iterator['Input
 
 
 class InputComponent(Component):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.platforms = data.get("platforms", None)
         self.checks = list(map(lambda entry: Check(entry), data.get("checks", [])))
 
     @classmethod
-    def _from(self, data: Any) -> 'InputComponent':
+    def _from(self, data: dict) -> 'InputComponent':
         if "repository" in data:
             return InputComponentFromSource(data)
         elif "dist" in data:
@@ -232,7 +232,7 @@ def __stabilize__(self) -> None:
 
 
 class InputComponentFromSource(InputComponent):
-    def __init__(self, data: Any) -> None:
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.repository = data["repository"]
         self.ref = data["ref"]
@@ -255,7 +255,7 @@ def __to_dict__(self) -> dict:
 
 
 class InputComponentFromDist(InputComponent):
-    def __init__(self, data: Any):
+    def __init__(self, data: dict) -> None:
         super().__init__(data)
         self.dist = data["dist"]
 
@@ -269,7 +269,7 @@ def __to_dict__(self) -> dict:
 
 
 class Check:
-    def __init__(self, data: Any) -> None:
+    def __init__(self, data: dict) -> None:
         if isinstance(data, dict):
             if len(data) != 1:
                 raise ValueError(f"Invalid check format: {data}")