#16 Add default value conditions and test patterns

Author: simon-ritchie

numdoclint/helper.py

@@ -814,6 +814,8 @@ def get_arg_default_val_info_dict(py_module_str, func_name):
     default_val_info_dict = {}
     for arg_str in splitted_arg_list:
         arg_str = arg_str.replace(' ', '')
+        arg_str = arg_str.replace("'", '')
+        arg_str = arg_str.replace('"', '')
         arg_str = _remove_type_str_from_arg_str(arg_str=arg_str)
         default_val_exists = '=' in arg_str
         if not default_val_exists:
@@ -840,6 +842,7 @@ def _remove_type_str_from_arg_str(arg_str):
     after_arg_str : str
         String after type information has been removed.
     """
+    arg_str = arg_str.replace(' = ', '=')
     is_in = ':' in arg_str
     if not is_in:
         return arg_str

tests/test_helper.py

@@ -82,6 +82,9 @@ class SampleClass:
 
     def sample_func_6(self, cls, price, name, *args, **kwargs):
         pass
+
+def sample_func_7(price: int = 100, name: str = 'apple'):
+    pass
     """
 
     arg_name_list = helper.get_arg_name_list(
@@ -114,6 +117,10 @@ def sample_func_6(self, cls, price, name, *args, **kwargs):
     assert arg_name_list == [
         'self', 'cls', 'price', 'name', '*args', '**kwargs']
 
+    arg_name_list = helper.get_arg_name_list(
+        py_module_str=py_module_str, func_name='sample_func_7')
+    assert arg_name_list == ['price', 'name']
+
 
 def test_get_func_indent_num():
     py_module_str = """
@@ -726,12 +733,16 @@ def sample_func_6( prince = 100, location_id = 200 ):
         print(600)
 
 
-    def sample_func
+    def sample_func_7
     (
         price,
         name
     ):
         pass
+
+
+    def sample_func_8(dict_val: Optional[Dict[str, int]] = None):
+        pass
     """
     args_str = helper._get_args_str(
         code_str=code_str, func_name='sample_func_1')
@@ -758,7 +769,7 @@ def sample_func
     assert args_str == 'prince = 100, location_id = 200'
 
     args_str = helper._get_args_str(
-        code_str=code_str, func_name='sample_func')
+        code_str=code_str, func_name='sample_func_7')
     assert args_str == 'price, name'
 
 
@@ -775,6 +786,15 @@ def sample_func_2(price, location_id=100, season=3):
     def sample_func_3(
             price: int, location_id: int=100) -> str:
         print(300)
+
+
+    def sample_func_4(
+            price: int = 100, name: str = 'apple') -> str:
+        print(300)
+
+
+    def sample_func_5(name: str = "apple") -> 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')
@@ -797,6 +817,21 @@ def sample_func_3(
     }
     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_4')
+    expected_dict = {
+        'price': '100',
+        'name': 'apple',
+    }
+    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_5')
+    expected_dict = {
+        'name': 'apple',
+    }
+    assert default_val_info_dict == expected_dict
+
 
 def test__get_return_value_docstring():
     docstring = """
@@ -1684,6 +1719,10 @@ def test__remove_type_str_from_arg_str():
         arg_str=' price: int=100 ')
     assert after_arg_str == 'price=100'
 
+    after_arg_str = helper._remove_type_str_from_arg_str(
+        arg_str=' price: int = 100 ')
+    assert after_arg_str == 'price=100'
+
 
 def test__remove_nested_func_str():
     func_str = """