- r add type hints

Author: JayBazuzi

approval_utilities/utilities/clipboard_utilities.py

@@ -1,4 +1,4 @@
-def copy_to_clipboard(text):
+def copy_to_clipboard(text: str) -> None:
     """
     This acts as a wrapper to defer the importing of pyperclip util actual usage
     """

approval_utilities/utilities/logger/logging_instance.py

@@ -28,7 +28,7 @@ def print_type(value):
 
 
 class LoggingInstance:
-    def __init__(self):
+    def __init__(self) -> None:
         self.log_stack_traces = True
         self.toggles = Toggles(True)
         self.previous_timestamp = None
@@ -112,7 +112,7 @@ def log_line(self, text: str, use_timestamps=True) -> None:
         output_message = f"{timestamp}{self.get_tabs()}{text}\n"
         self.logger(output_message)
 
-    def get_timestamp(self) -> str:
+    def get_timestamp(self):
         timestamp = ""
         if self.log_with_timestamps:
             time1: datetime.datetime = self.timer()

approval_utilities/utilities/map_reduce.py

@@ -1,13 +1,13 @@
 import itertools
-from typing import Sequence, Any, Callable
+from typing import Sequence, Any, Callable, Generator, Dict
 
 
 def first(sequence: Sequence[Any], predicate: Callable[[Any], bool]) -> Any:
     matching = filter(predicate, sequence)
     return next(matching, None)
 
 
-def product_dict(**kwargs):
+def product_dict(**kwargs: Sequence[Any]) -> Generator[Dict[str, Any], None, None]:
     """
     Similar to `itertools.product`, but the resulting combinations retain the names.
     """

approval_utilities/utilities/markdown_table.py

@@ -8,7 +8,7 @@
 
 
 class MarkdownTable(Verifiable):
-    def __init__(self):
+    def __init__(self) -> None:
         self.markdown: str = ""
 
     def get_verify_parameters(self, options: "Options") -> VerifyParameters:

approval_utilities/utilities/string_wrapper.py

@@ -1,12 +1,12 @@
 class StringWrapper:
-    def __init__(self):
+    def __init__(self) -> None:
         self.string = ""
 
-    def append(self, text):
+    def append(self, text: str) -> None:
         self.string += text
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.string
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return self.string

approvaltests/approval_exception.py

@@ -3,7 +3,7 @@ def __init__(self, value: str) -> None:
         super().__init__(self)
         self.value = value
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.value
 
 

approvaltests/inline/split_code.py

@@ -3,16 +3,16 @@
 
 
 class SplitCode:
-    def __init__(self, before_method, after_method, tab):
+    def __init__(self, before_method: str, after_method: str, tab: str) -> None:
         self.before_method = before_method
         self.after_method = after_method
         self.tab = tab
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"before:\n{self.before_method}\nafter:\n{self.after_method}\ntab: '{self.tab}'\n"
 
     @staticmethod
-    def on_method(code, method_name) -> "SplitCode":
+    def on_method(code: str, method_name: str) -> "SplitCode":
         lines = code.split("\n")
         before = []
         after = []
@@ -51,7 +51,7 @@ class State(Enum):
                 after.append(line)
         return SplitCode("\n".join(before), "\n".join(after), tab)
 
-    def indent(self, received_text):
+    def indent(self, received_text: str) -> str:
         lines = received_text.split("\n")
         indented_lines = [f"{self.tab}{line}" for line in lines]
         return "\n".join(indented_lines)

approvaltests/integrations/pytest/pytest_config.py

@@ -2,9 +2,9 @@ class PytestConfig:
     test_naming_patterns = ["test_*"]
 
     @staticmethod
-    def set_config(config):
+    def set_config(config) -> None:
         PytestConfig.test_naming_patterns = config.getini("python_functions")
 
 
-def set_pytest_config(config):
+def set_pytest_config(config) -> None:
     PytestConfig.set_config(config)

approvaltests/namer/inline_comparator.py

@@ -23,7 +23,7 @@ def get_received_filename(self, base: Optional[str] = None) -> str:
         return tempfile.NamedTemporaryFile(suffix=".received.txt", delete=False).name
 
     @staticmethod
-    def get_test_method_doc_string():
+    def get_test_method_doc_string() -> str:
         test_stack_frame: FrameInfo = StackFrameNamer.get_test_frame()
         method: Callable[..., Any] = InlineComparator.get_caller_method(
             test_stack_frame

approvaltests/namer/inline_python_reporter.py

@@ -23,7 +23,7 @@ def report(self, received_path: str, approved_path: str) -> bool:
         received_path = self.create_received_file(received_path, test_source_file)
         return self.diffReporter.report(received_path, test_source_file)
 
-    def get_test_source_file(self):
+    def get_test_source_file(self) -> str:
         test_stack_frame: FrameInfo = StackFrameNamer.get_test_frame()
         return test_stack_frame.filename