Changeset 38

Timestamp:

06/03/06 13:11:55 (7 years ago)

Author:

mk

Message:

Incorporate formatted docstrings count into documentation index.

Files:

• branches/mk/cheesecake/cheesecake_index.py (modified) (8 diffs)
• branches/mk/cheesecake/codeparser.py (modified) (3 diffs)

branches/mk/cheesecake/cheesecake_index.py

@@ -222 +222 @@
-        self.INDEX_DIR_EMPTY     = 5
-        self.MAX_INDEX_DOCSTRINGS = 100 # max. percentage of modules/classes/methods/functions with docstrings
+        self.MAX_INDEX_DOCFORMAT  = 100 # max. percentage of modules/classes/methods/functions with formatted docstrings
-        self.MAX_INDEX_UNITTESTS  = 100 # max. percentage of methods/functions that are unit tested
-        self.MAX_INDEX_PYLINT     = 100 # max. pylint score
@@ -337 +338 @@
-                                            self.INDEX_INSTALL
-        self.max_cheesecake_index_documentation = self.INDEX_REQUIRED_FILES + \
-
+
+
-        self.max_cheesecake_index_codekwalitee = self.MAX_INDEX_PYLINT 
-#                                        self.MAX_INDEX_UNITTESTS
@@ -346 +348 @@
-        for index_type in ["pypi_download", "url_download", 
-                           "unpack_dir", "unpack", "install",
-
+doc_format", "
-            self.index[index_type] = Index(index_type)
-
@@ -379 +381 @@
-        self.object_cnt = 0  # Number of modules/functions/classes/methods in .py files found
-        self.docstring_cnt = 0
+        self.docformat_cnt = 0
-        self.functions = [] # List of methods/functions found in .py files
-
@@ -663 +666 @@
-                    self.object_cnt += code.object_count()
-                    self.docstring_cnt += code.docstring_count()
+                    self.docformat_cnt += code.formatted_docstrings_count
-                    self.functions += code.functions
-                elif self.is_test_file(file, dirs_in_rootdir):
@@ -801 +805 @@
-        # index["unpack"] is already set in unpack_pkg()
-        return self.index["unpack"]
-
-
-    def index_unpack_dir(self):
@@ -851 +854 @@
-        self.index[index_type].details = details
-        return self.index[index_type]
+
+    def index_doc_format(self):
+        percent = float(self.docformat_cnt)/float(self.object_cnt)
+        index_value = int(ceil(percent*100))
+        details = "found %d/%d=%.2f%% modules/classes/methods/functions with formatted docstrings" %\
+                 (self.docformat_cnt, self.object_cnt, percent*100)
+        self.index["doc_format"].value = index_value
+        self.index["doc_format"].details = details
+        return self.index["doc_format"]
-
-    def index_unittests(self):
@@ -965 +977 @@
-                                         index_types, self.max_cheesecake_index_installability)
-
-
+_format", "doc
-        self.cheesecake_index_documentation = self.process_partial_index("DOCUMENTATION",\
-                                         index_types, self.max_cheesecake_index_documentation)

branches/mk/cheesecake/codeparser.py

@@ -110 +110 @@
-        self.docstrings = [] # objects that have docstrings
-        self.docstrings_by_format = {}
+        self.formatted_docstrings_count = 0
-
-        # Initialize lists of format docstrings.
@@ -136 +137 @@
-                self.docstrings.append(fullname)
-                # Check docstring for known documenation formats.
+                formatted = False
-                for format in supported_formats:
-                    if use_format(obj.docstring, format):
-                        self.docstrings_by_format[format].append(fullname)
+                        formatted = True
+                if formatted:
+                    self.formatted_docstrings_count += 1
-
-        for method_or_func in self.method_func:
@@ -177 +182 @@
-
-    def docstring_count_by_type(self, type):
-reST docstrings
+docstrings of given type
-        """
-        return len(self.docstrings_by_format[type])