Changeset 11

Timestamp:

03/30/06 19:32:51 (3 years ago)

Author:

grig

Message:

Added ez_setup.py so that users are forced to upgrade to new version of setuptools.

Changed installation to alternate directory to use --root instead of --home.

Files:

• trunk/cheesecake/_util.py (modified) (1 diff)
• trunk/cheesecake/cheesecake_index.py (modified) (21 diffs)
• trunk/cheesecake/codeparser.py (modified) (6 diffs)
• trunk/cheesecake/config.py (modified) (2 diffs)
• trunk/cheesecake/model.py (modified) (9 diffs)
• trunk/ez_setup.py (added)
• trunk/tests/test_code_parser.py (modified) (1 diff)
• trunk/tests/test_config.py (modified) (2 diffs)

trunk/cheesecake/_util.py

@@ -94 +94 @@
-def pad_line(char="="):
-    """
-Print
+Return
-    """
-
+
+

trunk/cheesecake/cheesecake_index.py

@@ -28 +28 @@
-from _util import StdoutRedirector
-import logger
-import 
+from config import get_pkg_
-from codeparser import CodeParser
-
@@ -141 +141 @@
-        self.sandbox_install_dir = ""
-
-        self.set_defaults()
-        self.get_config_values()
-        self.determine_pkg_name()
-        self.configure_logging()
+        self.set_defaults()
+        self.get_config()
-        self.init_indexes()
-        self.retrieve_pkg()
@@ -196 +196 @@
-        self.INDEX_DIR_EMPTY     = 5
-        self.MAX_INDEX_DOCSTRINGS = 100 # max. percentage of modules/classes/methods/functions with docstrings
+        self.MAX_INDEX_UNITTESTS  = 100 # max. percentage of methods/functions that are unit tested
-        self.MAX_INDEX_PYLINT     = 100 # max. pylint score
-        self.cheese_files = ["readme", "install", "changelog",
@@ -207 +208 @@
-        self.critical_cheese_dirs = ["doc", "test"]
-
-_values
+
-        """
-        Retrieve values from configuration file
-        """
+        self.config = get_pkg_config(self.short_pkg_name)
-        for config_var in ["INDEX_PYPI_DOWNLOAD", "INDEX_PYPI_DISTANCE",
-            "INDEX_URL_DOWNLOAD", "INDEX_UNPACK", "INDEX_UNPACK_DIR",
@@ -220 +222 @@
-            "cheese_dirs", "critical_cheese_dirs",
-            ]:
-
+self.
-            if value: setattr(self, config_var, value)
-
@@ -226 +228 @@
-        if self.name:
-            self.package = self.name
+            self.short_pkg_name = self.name
-        elif self.package_path:
-            self.package = self.get_package_from_path(self.package_path)
@@ -231 +234 @@
-            self.package = self.get_package_from_url()
-
+    def get_package_from_url(self):
+        """
+        Use ``urlparse`` to obtain package path from URL
+        """
+        (scheme,location,path,param,query,fragment_id) = urlparse(self.url)
+        return self.get_package_from_path(path)
+
+
+    def get_package_from_path(self, path):
+        """
+        Get package name as file portion of path
+        """
+        dir, file = os.path.split(path)
+        self.short_pkg_name = file
+        for package_type in self.package_types:
+            s = re.search("(.+)\.%s" % package_type, file)
+            if s:
+                self.short_pkg_name = s.group(1)
+                break
+        return file
+
-    def configure_logging(self):
-        """
@@ -240 +264 @@
-        log.warn and log.error go to both logfile and stdout
-        """
-packag
+short_pkg_nam
-
-        logger.setconsumer('logfile', open(str(self.logfile), 'w', buffering=1))
@@ -258 +282 @@
-        self.log.error = logger.MultipleProducer('cheesecake console')
-
-packag
+short_pkg_nam
-
-    def init_indexes(self):
@@ -276 +300 @@
-                                    self.INDEX_INSTALL + \
-                                    self.MAX_INDEX_DOCSTRINGS + \
-
+
+
-        self.max_cheesecake_index_installability = self.INDEX_PYPI_DOWNLOAD + \
-                                            self.INDEX_UNPACK + \
@@ -283 +308 @@
-        self.max_cheesecake_index_documentation = self.INDEX_REQUIRED_FILES + \
-                                        self.MAX_INDEX_DOCSTRINGS
-
+
+
+
-        self.index = {}
-        for index_type in ["file", "dir"]:
@@ -289 +316 @@
-        for index_type in ["pypi_download", "url_download", 
-                           "unpack_dir", "unpack", "install",
-
+unittests", "
-            self.index[index_type] = Index(index_type)
-
@@ -321 +348 @@
-            self.pkg_files[type] = []
-
+        self.object_cnt = 0  # Number of modules/functions/classes/methods in .py files found
+        self.docstring_cnt = 0
+        self.functions = [] # List of methods/functions found in .py files
+
-    def retrieve_pkg(self):
-        if self.name:
@@ -342 +373 @@
-        """
-        dir, file = os.path.split(path)
+        self.short_pkg_name = file
+        for package_type in self.package_types:
+            s = re.search("(.+)\.%s" % package_type, file)
+            if s:
+                self.short_pkg_name = s.group(1)
+                break
-        return file
-
@@ -586 +623 @@
-                    self.pkg_files["py"].append(fullpath)
-                    self.log.debug("py file found: " + fullpath)
+                    pyfile = os.path.join(self.sandbox, fullpath)
+                    # Parse the file and count objects (modules/classes/functions)
+                    # and their associated docstrings
+                    code = CodeParser(pyfile, self.log.debug)
+                    self.object_cnt += code.object_count()
+                    self.docstring_cnt += code.docstring_count()
+                    self.functions += code.functions
+
-                if os.path.splitext(file)[1] == ".pyc":
-                    self.pkg_files["pyc"].append(fullpath)
-                    self.log.debug("pyc file found: " + fullpath)
+
-                if self.is_test_file(file, dirs_in_rootdir):
-                    self.pkg_files["test"].append(fullpath)
-                    self.log.debug("test file found: " + fullpath)
+
-        len_pyc_list = len(self.pkg_files["pyc"])
-        if len_pyc_list:
@@ -623 +670 @@
-        Return True is file is in directory rooted at "test" or "tests"
-        """
+        if not file.endswith(".py"):
+            return False
-        if file in ["__init__.py"]:
-            return False
@@ -700 +749 @@
-        cwd = os.getcwd()
-        os.chdir(os.path.join(self.sandbox, self.package_name))
-home
+root
-        if not rc:
-            # Install succeeded
@@ -718 +767 @@
-        Return Index object of type "docstrings"
-        """
-        cnt = 0
-        docstring_cnt = 0
-        index_type = "docstrings"
-
-
-
-
-
-
-
+
+
-        else:
-            percent = 0
-        index_value = int(ceil(percent*100))
-
+
+
-        self.index[index_type].value = index_value
-        self.index[index_type].details = details
-        return self.index[index_type]
+
+    def index_unittests(self):
+        """
+        Compute unittest index as percentage of methods/functions
+        that are exercised in unit tests
+
+        Return Index object of type "unittests"
+        """
+        unittest_cnt = 0
+        index_type = "unittests"
+        self.functions_tested = {}
+        for testfile in self.pkg_files["test"]:
+            fullpath = os.path.join(self.sandbox, testfile)
+            code = CodeParser(fullpath, self.log.debug)
+            func_called = code.functions_called()
+            self.log.debug("Functions called in unit test:")
+            self.log.debug(func_called)
+            for func in func_called:
+                self.functions_tested[func] = 1
+        self.log.debug("FUNCTIONS TO BE CHECKED WHETHER THEY ARE UNIT TESTED:")
+        self.log.debug(self.functions)
+        self.log.debug("FUNCTIONS THAT ARE UNIT TESTED:")
+        self.log.debug(self.functions_tested.keys())
+        for funcname in self.functions:
+            if self.is_unit_tested(funcname):
+                unittest_cnt += 1
+                self.log.debug("%s is unit tested" % funcname)
+        cnt = len(self.functions)
+        if cnt:
+            percent = float(unittest_cnt)/float(cnt)
+        else:
+            percent = 0
+        index_value = int(ceil(percent*100))
+        details = "found %d/%d=%.2f%% unit tested methods/functions" % (unittest_cnt, cnt, percent*100)
+        self.index[index_type].value = index_value
+        self.index[index_type].details = details
+        return self.index[index_type]
+
+    def is_unit_tested(self, funcname):
+        elem = funcname.split(".")
+        n1 = elem[-1]
+        n2 = ""
+        if len(elem) > 1:
+            n2 = elem[-2] + "." + elem[-1]
+        for key in self.functions_tested.keys():
+            if key.startswith(n1) or (n2 and key.startswith(n2)):
+                return True
+        return False
-
-    def index_pylint(self):
@@ -805 +896 @@
-                                         index_types, self.max_cheesecake_index_documentation)
-
-
+
+
+
+
-        self.cheesecake_index_codekwalitee = self.process_partial_index("CODE KWALITEE",\
-                                         index_types, self.max_cheesecake_index_codekwalitee)
-
-        print
-
+"="
-        print pad_msg("OVERALL CHEESECAKE INDEX (ABSOLUTE)", self.cheesecake_index)
-        percentage = (self.cheesecake_index * 100) / self.max_cheesecake_index
@@ -829 +923 @@
-            partial_index_value += self.process_index(index_type)
-
-"-"
+
-        print pad_msg("%s INDEX (ABSOLUTE)" % partial_index_name, partial_index_value)
-        percentage = (partial_index_value * 100) / max_value
@@ -850 +944 @@
-        return index.value
-
-
+-
-        """
-        Print line of text, unless quiet flag was given

trunk/cheesecake/codeparser.py

@@ -6 +6 @@
-    Information about the structure of a Python module
-
-/functions and any
+, functions and
-    * Based on mwh's docextractor.model module
-    """
@@ -17 +17 @@
-        self.modules = []
-        self.classes = []
+        self.methods = []
+        self.method_func = []
-        self.functions = []
-        self.docstrings = {}
@@ -24 +26 @@
-        self.log("Inspecting file: " + pyfile)
-
-
-
-
+
+
+
+
+
+
+
-            fullname = obj.fullName()
-            if isinstance(obj, Module):
@@ -33 +39 @@
-                self.classes.append(obj.fullName())
-            if isinstance(obj, Function):
-functions
+method_func
-            if obj.docstring:
-                self.docstrings[fullname] = 1
-
+        for method_or_func in self.method_func:
+            method_found = 0
+            for cls in self.classes:
+                if method_or_func.startswith(cls):
+                    self.methods.append(method_or_func)
+                    method_found = 1
+                    break
+            if not method_found:
+                self.functions.append(method_or_func)
+                
-        self.log("modules: " + ",".join(self.modules))
-        self.log("classes: " + ",".join(self.classes))
+        self.log("methods: " + ",".join(self.methods))
-        self.log("functions: " + ",".join(self.functions))
-
@@ -47 +64 @@
-        * module
-        * classes
-
+
+
-        """
-        module_count = len(self.modules)
-        cls_count = len(self.classes)
+        method_count = len(self.methods)
-        func_count = len(self.functions)
-
+method_count + 
-
-    def docstring_count(self):
@@ -59 +78 @@
-        """
-        return len(self.docstrings.keys())
+
+    def functions_called(self):
+        """
+        Return list of functions called by functions/methods
+        defined in this module
+        """
+        return self.system.func_called.keys()

trunk/cheesecake/config.py

@@ -21 +21 @@
-    INDEX_DIR_EMPTY     = 5,
-    MAX_INDEX_DOCSTRINGS = 100, # max. percentage of modules/classes/methods/functions with docstrings
+    MAX_INDEX_UNITTESTS  = 100, # max. percentage of methods/functions that are unit tested
-    MAX_INDEX_PYLINT     = 100, # max. pylint score
-    cheese_files = ["readme", "install", "changelog",
@@ -28 +29 @@
-    critical_cheese_files = ["readme", "license", "setup.py"],
-    cheese_dirs = ["doc", "test", "example", "demo"],
-
+
+
+
-)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-def get(key, default=None):

trunk/cheesecake/model.py

@@ -1 +1 @@
-"""
-
-
-
-
+
+
-"""
+
-from compiler import ast
-import sys
@@ -12 +11 @@
-import sets
-
+import compiler
-from compiler.transformer import parse, parseFile
-from compiler.visitor import walk
@@ -88 +88 @@
-        # for import * statements
-        self.importstargraph = {}
+        self.func_called = {}
-
-    def _push(self, cls, name, docstring):
@@ -140 +141 @@
-        self.current = self.current.parent
-
-
+, node=None
-        self._stack.append(self.current)
-        self.current = obj
@@ -158 +159 @@
-        self._pop(self.Module)
-
-
+
+
-        return self._push(self.Function, name, docstring)
-    def popFunction(self):
@@ -260 +262 @@
-            assert m.docstring is None
-            m.docstring = node.doc
-
+, node
-            self.default(node)
-            self.system.pop(m)
@@ -327 +329 @@
-
-    def visitFunction(self, node):
-
+
+
+
+
-        # ast.Function has a pretty lame representation of
-        # arguments. Let's convert it to a nice concise
@@ -357 +362 @@
-            argnames2.append(argname)
-        func.argspec = (argnames2, starargname, kwname, tuple(defaults))
+        #for child in node.getChildren():
+        #    if isinstance(child, compiler.ast.Stmt):
+        #        for c in child.getChildren():
+        #            print c.__class__
+        #            print c
-        self.postpone(func, node.code)
-        self.system.popFunction()
-
+def get_function_calls(node, fc):
+    if not isinstance(node, compiler.ast.Node):
+        return
+    for child in node.getChildren():
+        #print "child:", child
+        if isinstance(child, compiler.ast.CallFunc):
+                funcname = ""
+                attrname = ""
+                n = child.node
+                #print "n:", n
+                #print n.__class__
+                if isinstance(n, compiler.ast.Getattr):
+                    expr = n.expr
+                    if isinstance(expr, compiler.ast.Name):
+                        funcname = expr.name
+                    attrname = n.attrname
+                func_called = ""
+                if funcname: func_called = funcname + "."
+                func_called += attrname
+                if func_called:
+                    fc[func_called] = 1
+        get_function_calls(child, fc)
+    
-def processModuleAst(ast, name, system):
-    mv = ModuleVistor(system, name)
@@ -365 +398 @@
-    while mv.morenodes:
-        obj, node = mv.morenodes.pop(0)
-
+, node
-        mv.visit(node)
-        system.pop(obj)

trunk/tests/test_code_parser.py

@@ -14 +14 @@
-        assert self.code1.classes == ["module1.Class1", "module1.Class2"]
-
+    def test_methods(self):
+        assert self.code1.methods== ["module1.Class1.__init__",
+        "module1.Class1.__another_method__",
+        "module1.Class1.method1",
+        "module1.Class1.method2", 
+        "module1.Class1.method3",
+        "module1.Class1.method4"]
+
-    def test_functions(self):
-
-
-
-
+
+
+
+
+
+
+
-    def test_count(self):
-        assert self.code1.object_count() == 14

trunk/tests/test_config.py

@@ -9 +9 @@
-        homedir = os.path.expanduser(homedir)
-        self.cheesecake_dir = os.path.join(homedir, ".cheesecake")
-        self.my_config = os.path.join(self.cheesecake_dir, "my_config.py")
-
-    def test_no_custom_config(self):
@@ -15 +14 @@
-        if os.path.isdir(self.cheesecake_dir):
-            shutil.rmtree(self.cheesecake_dir)
-import cheesecake.
-# since the module might have been imported by another test,
-# we reload it
-reload(cheesecake.config
+from cheesecake import 
+pkg_name = "my"
+pkg_config_file = os.path.join(self.cheesecake_dir, "my_config.py")
+config = config.get_pkg_config(pkg_name
-        # the .cheesecke dir and my_config.py file should have been created
-        assert os.path.isdir(self.cheesecake_dir)
-self.my_config
+pkg_config_file
-        # my_config should contain default values
-        sys.path.insert(0, self.cheesecake_dir)
-        from my_config import my_config
-        for key, value in my_config.items():
-heesecake.c
+