OverallFunctions.py:

jessy-code · jessy-code · commit 0dfb17d17936 · 2021-11-22T15:50:12.000+01:00
- creation of a function to check if a class contains docstring
 - update function to evaluate the indentation of lines object to take already existing docstring into account

 PythonFiles.py: update write_class_docstring function to write docstring only if needed
diff --git a/common/OverallFunctions.py b/common/OverallFunctions.py
@@ -98,7 +98,7 @@ def remove_brackets_to_string(string):
     string : the string in which we want to remove brackets
 
     """
-    return string.replace('(', '').replace(')','')
+    return string.replace('(', '').replace(')', '')
 
 
 def get_indentation(string_list):
@@ -111,9 +111,17 @@ def get_indentation(string_list):
 
     """
     indented_lines = [line for line in string_list if
-                      match(r'^ .*[a-zA-Z0-9]*$', line) and string_list.index(line) > 0]
+                      match(r'^ .*[a-zA-Z0-9\"\']*$', line) and string_list.index(line) > 0]
     try:
-
-        return resplit(r'[a-z0-9]', indented_lines[0], flags=IGNORECASE)[0]
+        return resplit(r'[a-z0-9\"\']', indented_lines[0], flags=IGNORECASE)[0]
     except IndexError:
         raise
+
+
+def check_if_python_class_contains_docstring(class_content):
+    for line in class_content:
+        if match('^ .*def', line):
+            return False
+        if match('^ .*"""', line) or match("^ .*'''", line):
+            return True
+    return False
diff --git a/file/PythonFiles.py b/file/PythonFiles.py
@@ -3,7 +3,7 @@
 from python_objects.Function import Function
 from shutil import move
 from common.OverallFunctions import extract_name_in_line, test_regex, add_content_to_string_from_list, \
-    get_object_name_from_regex
+    get_object_name_from_regex, check_if_python_class_contains_docstring
 
 
 class PythonFiles:
@@ -306,9 +306,10 @@ def write_class_docstring(self):
                             class_name = line.split('class ')[1].split(':')[0]
                         except:
                             class_name = line.split('class ')[1].split('(')[0]
-                        self.init_class_docstring(class_name)
 
-                        file.write(self.build_string_class_with_docstring(class_name))
+                        self.init_class_docstring(class_name)
+                        if not check_if_python_class_contains_docstring(self.__class_dict[class_name].content):
+                            file.write(self.build_string_class_with_docstring(class_name))
 
                     if flag and match('^ .*def .*$', line):
                         method_name = line.split('def ')[1].split('(')[0]
diff --git a/python_objects/Class.py b/python_objects/Class.py
@@ -1,7 +1,7 @@
 from python_objects.Function import Function
 from common.OverallFunctions import get_object_name_from_regex, add_content_to_string_from_list, get_indentation
 from common.Section import Section
-from re import compile
+from re import compile, match
 
 
 class Class:
@@ -37,6 +37,7 @@ class Class:
 
     write_docstring : write the class documentation
     """
+
     def __init__(self, class_name):
         self.__class_name = class_name
         self.__methode_dict = {}
@@ -110,7 +111,6 @@ def get_function_content_from_class_content(self, function_name):
         self.__methode_dict[function_name].content = []
         start_flag = compile('^ *' + 'def ' + function_name + '\(.*: *$')
         stop_flag = compile('^' + get_indentation(self.content) + '[a-zA-Z0-9]' + '.*$')
-
         self.__methode_dict[function_name].content = add_content_to_string_from_list(self.content,
                                                                                      self.__methode_dict[
                                                                                          function_name].content,
diff --git a/tests/partially_documented_project/SeveralClassFileExample.py b/tests/partially_documented_project/SeveralClassFileExample.py
@@ -43,6 +43,28 @@ def other_function(param1, param2='foo'):
 
 
 class Class3:
+    """
+    <TO BE COMPLETED>
+
+    Parameters
+    __________
+    self : <TO BE COMPLETED>
+
+    attr1 : <TO BE COMPLETED>
+
+    attr2 : <TO BE COMPLETED>
+
+    Methods
+    _______
+    __init__ : <TO BE COMPLETED>
+
+    method1 : <TO BE COMPLETED>
+
+    method2 : <TO BE COMPLETED>
+
+    method3 : <TO BE COMPLETED>
+    """
+
     def __init__(self, attr1, attr2):
         self.param1 = attr1
         self.param2 = attr2
