Changeset 89

Timestamp:

07/19/06 09:36:58 (2 years ago)

Author:

mk

Message:

Search for doctests inside docstrings (closes ticket #45).

Files:

• branches/mk/cheesecake/cheesecake_index.py (modified) (5 diffs)
• branches/mk/cheesecake/codeparser.py (modified) (4 diffs)
• branches/mk/tests/unit/test_index_unittests.py (modified) (1 diff)
• branches/mk/tests/unit/test_index_use_test_framework.py (added)

branches/mk/cheesecake/cheesecake_index.py

@@ -820 +820 @@
-        return self.value
-
+class IndexUseTestFramework(Index):
+    """Check if a package uses any of known test frameworks.
+
+    Currently only checking for doctest.
+    """
+    max_value = 30
+
+    def compute(self, doctests_count):
+        if doctests_count > 0:
+            self.value = self.max_value
+            self.details = "found doctests"
+        else:
+            self.value = 0
+            self.details = "doesn't use any of known test frameworks"
+
+        return self.value
+
-class IndexPyLint(Index):
-    """Compute pylint index as average of positive pylint scores obtained for
@@ -903 +920 @@
-        IndexPyLint,
-        IndexUnitTests,
+        IndexUseTestFramework,
-    ]
-
@@ -1304 +1322 @@
-          docformat_cnt : int
-              Number of formatted docstrings found in all package objects.
+          doctests_count : int
+              Number of docstrings that include doctests.
-          files_list : list
-              List of files package contains.
@@ -1322 +1342 @@
-        self.docstring_cnt = 0
-        self.docformat_cnt = 0
+        self.doctests_count = 0
-        self.functions = []
-        self.classes = []
@@ -1336 +1357 @@
-            self.functions += code.functions
-            self.classes += code.classes
+            self.doctests_count += code.doctests_count
-
-        # Log a bit of debugging info.

branches/mk/cheesecake/codeparser.py

@@ +1 @@
+import doctest
-import os
-import re
-
-from model import System, Module, Class, Function, parseFile, processModuleAst
+
+
+# Python 2.3/2.4 compatibilty hacks.
+if getattr(doctest, 'DocTestParser', False):
+    # Python 2.4 have DocTestParser class.
+    get_doctests = doctest.DocTestParser().get_examples
+else:
+    # Python 2.3 have _extract_examples function.
+    get_doctests = doctest._extract_examples
-
-
@@ -112 +122 @@
-        self.docstrings_by_format = {}
-        self.formatted_docstrings_count = 0
+        self.doctests_count = 0
-
-        # Initialize lists of format docstrings.
@@ -146 +157 @@
-                    self.formatted_docstrings_count += 1
-
+                # Check if docstring include any doctests.
+                if get_doctests(obj.docstring):
+                    self.doctests_count += 1
+
-        for method_or_func in self.method_func:
-            method_found = 0
@@ -161 +176 @@
-        self.log("functions: " + ",".join(self.functions))
-        self.log("docstrings: %s" % self.docstrings_by_format)
+        self.log("number of doctests: %d" % self.doctests_count)
-
-    def object_count(self):

branches/mk/tests/unit/test_index_unittests.py

@@ -7 +7 @@
-import _path_cheesecake
-
-from _helper_cheesecake import Glutton
-from cheesecake.cheesecake_index import IndexUnitTests
-from cheesecake import logger