#24 Change Match type annotation from re to typing for the sake of compatibility of old Python.

Author: simon-ritchie

numdoclint/helper.py

@@ -2,7 +2,7 @@
 """
 
 import re
-from typing import Dict, List, Optional
+from typing import Dict, List, Match, Optional
 
 ARGS_OR_KWARGS_NAME_LIST: List[str] = [
     '*args',
@@ -72,7 +72,7 @@ def get_func_name_list(code_str: str) -> List[str]:
                 break
         if not_func_str:
             continue
-        match: Optional[re.Match] = _get_func_match(
+        match: Optional[Match] = _get_func_match(
             py_module_str=code_str, func_name=func_name)
         if match is None:
             continue
@@ -210,7 +210,7 @@ def get_func_indent_num(py_module_str: str, func_name: str) -> int:
     ValueError
         If the target function can not be found.
     """
-    match: Optional[re.Match] = _get_func_match(
+    match: Optional[Match] = _get_func_match(
         py_module_str=py_module_str, func_name=func_name)
     if match is None:
         err_msg = 'Target function not found: %s' % func_name
@@ -273,7 +273,7 @@ def get_func_overall_docstring(
     docstring : str
         Target docstring string.
     """
-    match: Optional[re.Match] = _get_func_match(
+    match: Optional[Match] = _get_func_match(
         py_module_str=py_module_str, func_name=func_name)
     if match is None:
         return ''
@@ -366,7 +366,7 @@ def _type_anotation_comment_exists(line_str: str) -> bool:
     return result
 
 
-def _get_func_match(py_module_str: str, func_name: str) -> Optional[re.Match]:
+def _get_func_match(py_module_str: str, func_name: str) -> Optional[Match]:
     """
     Get a Match object of search result of target function.
 

tests/test_helper.py

@@ -1,5 +1,4 @@
-import re
-from typing import Dict, List, Optional
+from typing import Dict, List, Match, Optional
 
 import pytest
 import six
@@ -1686,7 +1685,7 @@ def sample_func
     pass
     """
 
-    match: Optional[re.Match] = helper._get_func_match(
+    match: Optional[Match] = helper._get_func_match(
         py_module_str=py_module_str, func_name='sample_func_1')
     start_idx: int = match.start()
     expected_func_str: str = 'def sample_func_1():'

tests/test_jupyter_notebook.py

@@ -344,12 +344,13 @@ def test_check_jupyter_notebook() -> None:
 
 
 def test_check_jupyter_notebook_recursively() -> None:
-    info_list: List[dict] = jupyter_notebook.check_jupyter_notebook_recursively(
-        dir_path='./numdoclint/',
-        verbose=jupyter_notebook.VERBOSE_DISABLED,
-        ignore_func_name_prefix_list=[],
-        ignore_info_id_list=[],
-        enable_default_or_optional_doc_check=True)
+    info_list: List[dict] = \
+        jupyter_notebook.check_jupyter_notebook_recursively(
+            dir_path='./numdoclint/',
+            verbose=jupyter_notebook.VERBOSE_DISABLED,
+            ignore_func_name_prefix_list=[],
+            ignore_info_id_list=[],
+            enable_default_or_optional_doc_check=True)
     assert info_list == []
 
     info_list = jupyter_notebook.check_jupyter_notebook_recursively(