#16 Add combination pattern of type annotation and default value (e.g., 'Dict[str, int] = {}').

Author: simon-ritchie

numdoclint/helper.py

@@ -808,6 +808,7 @@ def get_arg_default_val_info_dict(py_module_str, func_name):
     """
     args_str = _get_args_str(
         code_str=py_module_str, func_name=func_name)
+    args_str = _remove_type_bracket_block_from_args_str(args_str=args_str)
     if args_str == '':
         return {}
     splitted_arg_list = args_str.split(',')
@@ -828,6 +829,39 @@ def get_arg_default_val_info_dict(py_module_str, func_name):
     return default_val_info_dict
 
 
+def _remove_type_bracket_block_from_args_str(args_str: str):
+    """
+    Remove type annotation block bracket from arguments string.
+
+    Parameters
+    ----------
+    args_str : str
+        The target arguments string.
+        e.g., 'dict_val: Dict[str, int] == {}'
+
+    Returns
+    -------
+    result_str : str
+        The converted arguments string.
+        e.g., 'dict_val: Dict == {}'
+    """
+    if '[' not in args_str:
+        return args_str
+    bracket_count: int = 0
+    result_str: str = ''
+    for char in args_str:
+        if char == '[':
+            bracket_count += 1
+            continue
+        if char == ']':
+            bracket_count -= 1
+            continue
+        if bracket_count != 0:
+            continue
+        result_str += char
+    return result_str
+
+
 def _remove_type_str_from_arg_str(arg_str):
     """
     Remove the string of type information from the argument string.

tests/test_helper.py

@@ -795,6 +795,10 @@ def sample_func_4(
 
     def sample_func_5(name: str = "apple") -> str:
         print(300)
+
+
+    def sample_func_6(dict_value: Optional[Dict[str, int]] = None) -> str:
+        print(300)
     """
     default_val_info_dict = helper.get_arg_default_val_info_dict(
         py_module_str=py_module_str, func_name='sample_func_1')
@@ -832,6 +836,13 @@ def sample_func_5(name: str = "apple") -> str:
     }
     assert default_val_info_dict == expected_dict
 
+    default_val_info_dict = helper.get_arg_default_val_info_dict(
+        py_module_str=py_module_str, func_name='sample_func_6')
+    expected_dict = {
+        'dict_value': 'None',
+    }
+    assert default_val_info_dict == expected_dict
+
 
 def test__get_return_value_docstring():
     docstring = """
@@ -1785,3 +1796,16 @@ def test__type_anotation_comment_exists():
     result = helper._type_anotation_comment_exists(
         line_str='    # type: (int) -> str')
     assert result
+
+
+def test__remove_type_bracket_block_from_args_str():
+    args_str: str = (
+        'dict_val: Optional[Dict[str, int]] = None,'
+        ' tuple_val: Optional[Tuple[int, str, int]]=None'
+    )
+    result_str = helper._remove_type_bracket_block_from_args_str(
+        args_str=args_str)
+    expected_str = (
+        'dict_val: Optional = None, tuple_val: Optional=None'
+    )
+    assert result_str == expected_str