root/branches/mk/cheesecake/codeparser.py

import os
from model import System, Module, Class, Function, parseFile, processModuleAst

class CodeParser(object):
    """
    Information about the structure of a Python module

    * Collects modules, classes, methods, functions and associated docstrings
    * Based on mwh's docextractor.model module
    """
    def __init__(self, pyfile, log=None):
        if log:
            self.log = log.codeparser
        else:
            import logger
            self.log = logger.default.codeparser
        self.modules = []
        self.classes = []
        self.methods = []
        self.method_func = []
        self.functions = []
        self.docstrings = {}

        (path, filename) = os.path.split(pyfile)
        (module, ext) = os.path.splitext(filename)
        self.log("Inspecting file: " + pyfile)

        self.system = System()
        try:
            processModuleAst(parseFile(pyfile), module, self.system)
        except:
            return

        for obj in self.system.orderedallobjects:
            fullname = obj.fullName()
            if isinstance(obj, Module):
                self.modules.append(fullname)
            if isinstance(obj, Class):
                self.classes.append(fullname)
            if isinstance(obj, Function):
                self.method_func.append(fullname)
            if isinstance(obj.docstring, str) and obj.docstring.strip():
                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))

    def object_count(self):
        """
        Return number of objects found in this module

        * module
        * classes
        * methods
        * functions
        """
        module_count = len(self.modules)
        cls_count = len(self.classes)
        method_count = len(self.methods)
        func_count = len(self.functions)
        return module_count + cls_count + method_count + func_count

    def docstring_count(self):
        """
        Return number of docstrings found in this module
        """
        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()