#26 Adjust to exclude callables in a string.

Author: simon-ritchie

numdoclint/cli.py

@@ -166,7 +166,7 @@ def _exec_numdoclint(
 
 def main(
         args: Optional[argparse.Namespace] = None,
-        return_list: bool = False) -> List[dict]:
+        return_list: bool = False) -> Optional[List[dict]]:
     """
     The function of command line entry point.
 
@@ -181,7 +181,7 @@ def main(
 
     Returns
     -------
-    info_list : list of dicts
+    info_list : list of dicts or None
         List of check results.
     """
     description: str = 'NumPy style docstring checking in Python code.'
@@ -250,4 +250,5 @@ def main(
         enable_default_or_optional_doc_check=enable_def_or_opt_check,
         skip_decorator_name_list=args.skip_decorator_name_list,
     )
-    return info_list
+    if return_list:
+        return info_list

numdoclint/helper.py

@@ -58,6 +58,7 @@ def get_func_name_list(code_str: str) -> List[str]:
     func_name_list : list of str
         List containing function names.
     """
+    code_str = _remove_strs(code_str=code_str)
     code_str = code_str.replace('\n', '')
     search_pattern: str = r'def .*?\(.*?\)'
     searched_result_list: List[str] = re.findall(
@@ -81,6 +82,102 @@ def get_func_name_list(code_str: str) -> List[str]:
     return func_name_list
 
 
+def _remove_strs(*, code_str: str) -> str:
+    """
+    Remove strings line's callables from a specified code string.
+
+    Parameters
+    ----------
+    code_str : str
+        A target code string.
+
+    Returns
+    -------
+    result_code_str : str
+        A result code string.
+    """
+    is_quoted_area: bool = False
+    quote_str: str = ''
+    result_code_str: str = ''
+    for i, char in enumerate(code_str):
+        prev_char: str = _get_prev_char(code_str=code_str, index=i)
+        following_3_chars: str = _get_following_3_chars(
+            code_str=code_str, index=i)
+        if prev_char == '\\':
+            result_code_str += char
+            continue
+
+        if is_quoted_area:
+            if char == quote_str or following_3_chars == quote_str:
+                quote_str = ''
+                is_quoted_area = False
+            continue
+
+        if following_3_chars == "'''":
+            is_quoted_area = True
+            quote_str = "'''"
+            continue
+        if following_3_chars == '"""':
+            is_quoted_area = True
+            quote_str = '"""'
+            continue
+        if char == "'" or char == '"':
+            is_quoted_area = True
+            quote_str = char
+            continue
+
+        result_code_str += char
+    return result_code_str
+
+
+def _get_prev_char(*, code_str: str, index: int) -> str:
+    """
+    Get a previous index's character in a code string.
+
+    Parameters
+    ----------
+    code_str : str
+        A target code string.
+    index : int
+        A target index. This interface returns a blank string
+        if a specified index is zero.
+
+    Returns
+    -------
+    char : str
+        A target character.
+    """
+    if index == 0:
+        return ''
+    return code_str[index - 1]
+
+
+def _get_following_3_chars(*, code_str: str, index: int) -> str:
+    """
+    Get following characters (including a specified index)
+    from a code string.
+
+    Parameters
+    ----------
+    code_str : str
+        A target code string.
+    index : int
+        A target index.
+
+    Returns
+    -------
+    three_chars : str
+        An extracted three characters.
+    """
+    str_len: int = len(code_str)
+    three_chars: str = code_str[index]
+    if index + 1 < str_len:
+        three_chars += code_str[index + 1]
+    if index + 2 < str_len:
+        three_chars += code_str[index + 2]
+    return three_chars
+
+
 def _get_args_str(code_str: str, func_name: str) -> str:
     """
     Get the string of the arguments.

tests/test_helper.py

@@ -46,6 +46,7 @@ def sample_func
 
 
 sample_str = r'def .*?\\(.*?\\)'
+sample_str = 'def sample_func_4(a: int) -> None\n    pass'
     """
     func_name_list: List[str] = helper.get_func_name_list(
         code_str=code_str)
@@ -54,6 +55,7 @@ def sample_func
     assert 'sample_func_2' in func_name_list
     assert 'sample_func_3' in func_name_list
     assert 'sample_func' in func_name_list
+    assert 'sample_func_4' not in func_name_list
 
 
 def test_get_arg_name_list() -> None:
@@ -1852,3 +1854,56 @@ def test__remove_type_bracket_block_from_args_str() -> None:
         'list_val_1: List, list_val_2: Optional = [100, 200]'
     )
     assert result_str == expected_str
+
+
+def test__get_prev_char() -> None:
+    code_str: str = 'import os'
+    char: str = helper._get_prev_char(code_str=code_str, index=0)
+    assert char == ''
+
+    char = helper._get_prev_char(code_str=code_str, index=1)
+    assert char == 'i'
+
+
+def test__get_following_3_chars() -> None:
+    code_str: str = 'import os'
+    three_chars: str = helper._get_following_3_chars(
+        code_str=code_str, index=8)
+    assert three_chars == 's'
+
+    three_chars = helper._get_following_3_chars(
+        code_str=code_str, index=7)
+    assert three_chars == 'os'
+
+    three_chars = helper._get_following_3_chars(
+        code_str=code_str, index=6)
+    assert three_chars == ' os'
+
+    three_chars = helper._get_following_3_chars(
+        code_str=code_str, index=5)
+    assert three_chars == 't o'
+
+
+def test___remove_strs() -> None:
+    code_str: str = (
+        'import os'
+        '\n\na: int = 10'
+        '\nb: str = "\ndef any_func_1() -> int:\n    ..."'
+        '\ndef any_func_2() -> int:'
+        '\n    '
+        "c: str = '\n\n    def any_func_3() -> None:\n        ...'"
+        '\nd = """\nLorem ipsum\ndolor sit amet\n"""'
+        "\ne = '''Hello\n'''"
+    )
+    code_str = helper._remove_strs(code_str=code_str)
+    expected_str: str = (
+        'import os'
+        '\n\na: int = 10'
+        '\nb: str = '
+        '\ndef any_func_2() -> int:'
+        '\n    '
+        "c: str = "
+        '\nd = '
+        "\ne = "
+    )
+    assert code_str == expected_str