add type hints to testing framework

Author: dromer

tests/framework/base_control.py

@@ -19,18 +19,21 @@
 import shutil
 import subprocess
 
+from typing import List, Optional
+
+from hvcc.interpreters.pd2hv.NotificationEnum import NotificationEnum
 from tests.framework.base_test import HvBaseTest
 
 
 class TestPdControlBase(HvBaseTest):
 
     def compile_and_run(
         self,
-        source_files,
-        out_dir,
-        num_iterations,
-        flag=None
-    ):
+        source_files: List[str],
+        out_dir: str,
+        num_iterations: int,
+        flag: Optional[str] = None
+    ) -> List[str]:
         exe_path = self._compile_and_run(source_files, out_dir, flag)
 
         # run executable (returns stdout)
@@ -41,21 +44,34 @@ def compile_and_run(
 
         return [x.decode('utf-8') for x in output]
 
-    def create_fail_message(self, result, golden, flag=None):
+    def create_fail_message(
+        self,
+        result: str,
+        golden: str,
+        flag: Optional[str] = None
+    ) -> str:
         return "\nResult ({0})\n-----------\n{1}\n\nGolden\n-----------\n{2}".format(
             flag or "",
             "\n".join(result),
             "\n".join(golden))
 
-    def _test_control_patch_expect_error(self, pd_file, expected_enum):
+    def _test_control_patch_expect_error(
+        self,
+        pd_file: str,
+        expected_enum: NotificationEnum
+    ) -> None:
         pd_path = os.path.join(self.TEST_DIR, pd_file)
 
         try:
             self._run_hvcc(pd_path, expect_fail=True, expected_enum=expected_enum)
         except Exception as e:
             self.fail(str(e))
 
-    def _test_control_patch_expect_warning(self, pd_file, expected_enum):
+    def _test_control_patch_expect_warning(
+        self,
+        pd_file: str,
+        expected_enum: NotificationEnum
+    ) -> None:
         # setup
         pd_path = os.path.join(self.TEST_DIR, pd_file)
 
@@ -64,7 +80,13 @@ def _test_control_patch_expect_warning(self, pd_file, expected_enum):
         except Exception as e:
             self.fail(str(e))
 
-    def _test_control_patch(self, pd_file, num_iterations=1, allow_warnings=True, fail_message=None):
+    def _test_control_patch(
+        self,
+        pd_file: str,
+        num_iterations: int = 1,
+        allow_warnings: bool = True,
+        fail_message: Optional[str] = None
+    ) -> None:
         """Compiles, runs, and tests a control patch.
         Allows warnings by default, always fails on errors.
         @param fail_message  An optional message displayed in case of test failure.

tests/framework/base_midi.py

@@ -19,18 +19,21 @@
 import shutil
 import subprocess
 
+from typing import List, Optional
+
+from hvcc.interpreters.pd2hv.NotificationEnum import NotificationEnum
 from tests.framework.base_test import HvBaseTest
 
 
 class TestPdMIDIBase(HvBaseTest):
 
     def compile_and_run(
         self,
-        source_files,
-        out_dir,
-        num_iterations,
-        flag=None
-    ):
+        source_files: List[str],
+        out_dir: str,
+        num_iterations: int,
+        flag: Optional[str] = None
+    ) -> List[str]:
         exe_path = self._compile_and_run(source_files, out_dir, flag)
 
         # run executable (returns stdout)
@@ -42,21 +45,34 @@ def compile_and_run(
 
         return [x.decode('utf-8') for x in output]
 
-    def create_fail_message(self, result, golden, flag=None):
+    def create_fail_message(
+        self,
+        result: str,
+        golden: str,
+        flag: Optional[str] = None
+    ) -> str:
         return "\nResult ({0})\n-----------\n{1}\n\nGolden\n-----------\n{2}".format(
             flag or "",
             "\n".join(result),
             "\n".join(golden))
 
-    def _test_control_patch_expect_error(self, pd_file, expected_enum):
+    def _test_control_patch_expect_error(
+        self,
+        pd_file: str,
+        expected_enum: NotificationEnum
+    ) -> None:
         pd_path = os.path.join(self.TEST_DIR, pd_file)
 
         try:
             self._run_hvcc(pd_path, expect_fail=True, expected_enum=expected_enum)
         except Exception as e:
             self.fail(str(e))
 
-    def _test_midi_patch_expect_warning(self, pd_file, expected_enum):
+    def _test_control_patch_expect_warning(
+        self,
+        pd_file: str,
+        expected_enum: NotificationEnum
+    ) -> None:
         # setup
         pd_path = os.path.join(self.TEST_DIR, pd_file)
 
@@ -65,7 +81,13 @@ def _test_midi_patch_expect_warning(self, pd_file, expected_enum):
         except Exception as e:
             self.fail(str(e))
 
-    def _test_midi_patch(self, pd_file, num_iterations=1, allow_warnings=True, fail_message=None):
+    def _test_midi_patch(
+        self,
+        pd_file: str,
+        num_iterations: int = 1,
+        allow_warnings: bool = True,
+        fail_message: Optional[str] = None
+    ) -> None:
         """Compiles, runs, and tests a control patch.
         Allows warnings by default, always fails on errors.
         @param fail_message  An optional message displayed in case of test failure.

tests/framework/base_signal.py

@@ -20,6 +20,8 @@
 import subprocess
 import numpy
 
+from typing import List, Optional
+
 from scipy.io import wavfile
 
 from tests.framework.base_test import HvBaseTest
@@ -29,12 +31,12 @@ class TestPdSignalBase(HvBaseTest):
 
     def compile_and_run(
         self,
-        source_files,
-        out_dir,
-        sample_rate=None,
-        block_size=None,
-        num_iterations=None,
-        flag=None
+        source_files: List[str],
+        out_dir: str,
+        sample_rate: Optional[int] = None,
+        block_size: Optional[int] = None,
+        num_iterations: Optional[int] = None,
+        flag: Optional[str] = None
     ):
         exe_path = self._compile_and_run(source_files, out_dir, flag)
 
@@ -50,7 +52,13 @@ def compile_and_run(
 
         return wav_path
 
-    def _compare_wave_output(self, out_dir, c_sources, golden_path, flag=None):
+    def _compare_wave_output(
+        self,
+        out_dir: str,
+        c_sources: List[str],
+        golden_path: str,
+        flag: Optional[str] = None
+    ):
         # http://stackoverflow.com/questions/10580676/comparing-two-numpy-arrays-for-equality-element-wise
         # http://docs.scipy.org/doc/numpy/reference/routines.testing.html
 
@@ -69,7 +77,7 @@ def _compare_wave_output(self, out_dir, c_sources, golden_path, flag=None):
         except AssertionError as e:
             self.fail(e)
 
-    def _test_signal_patch(self, pd_file):
+    def _test_signal_patch(self, pd_file: str):
         """Compiles, runs, and tests a signal patch.
         """
 

tests/framework/base_speed.py

@@ -19,19 +19,21 @@
 import shutil
 import subprocess
 
+from typing import List, Optional
+
 from tests.framework.base_test import HvBaseTest
 
 
 class TestPdSpeedBase(HvBaseTest):
 
     def compile_and_run(
         self,
-        source_files,
-        out_dir,
-        sample_rate=None,
-        block_size=None,
-        num_iterations=None,
-        flag=None
+        source_files: List[str],
+        out_dir: str,
+        sample_rate: Optional[int] = None,
+        block_size: Optional[int] = None,
+        num_iterations: Optional[int] = None,
+        flag: Optional[str] = None
     ):
         exe_path = self._compile_and_run_clang(source_files, out_dir, flag)
 
@@ -44,7 +46,7 @@ def compile_and_run(
 
         return float(result)
 
-    def _test_speed_patch(self, pd_file):
+    def _test_speed_patch(self, pd_file: str):
         pd_path = os.path.join(self.TEST_DIR, pd_file)
         # out_dir = os.path.join(os.path.dirname(__file__), "build")
 

tests/framework/base_test.py

@@ -20,7 +20,7 @@
 import subprocess
 import unittest
 
-from typing import Optional
+from typing import List, Optional
 
 import hvcc
 
@@ -48,7 +48,7 @@ def setUp(self):
 
     def _run_hvcc(
         self,
-        pd_path,
+        pd_path: str,
         expect_warning: bool = False,
         expect_fail: bool = False,
         expected_enum: NotificationEnum = NotificationEnum.EMPTY
@@ -97,9 +97,9 @@ def _run_hvcc(
 
     def _compile_and_run(
         self,
-        source_files,
-        out_dir,
-        flag=None
+        source_files: List[str],
+        out_dir: str,
+        flag: Optional[str] = None
     ):
         exe_path = os.path.join(out_dir, "heavy")
 
@@ -119,9 +119,9 @@ def _compile_and_run(
 
     def _compile_and_run_clang(
         self,
-        source_files,
-        out_dir,
-        flag=None,
+        source_files: List[str],
+        out_dir: str,
+        flag: Optional[str] = None,
     ):
         flag = flag or "HV_SIMD_NONE"
         self.assertTrue(flag in simd_flags, f"Unknown compiler flag: {flag}")