bee_python 0.0.1

data/tools/pylint2/pylint/epylint.py

@@ -0,0 +1,149 @@
+#!/usr/bin/env python
+# -*- coding: utf-8; mode: python; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:ft=python:et:sw=4:ts=4:sts=4
+"""Emacs and Flymake compatible Pylint.
+
+This script is for integration with emacs and is compatible with flymake mode.
+
+This version of epylint traverses out of packages before invoking pylint.  This avoids the reporting
+of errors that occur when a module within package uses a full package import path to get hold of
+another module within this package.
+
+For example:
+    - Suppose a package is structured as
+
+        a/__init__.py
+        a/b/x.py
+        a/c/y.py
+
+   - Then if y.py imports x as "from a.b import x" the following produces pylint errors
+
+       cd a/c; pylint y.py
+
+   - The following obviously doesn't
+
+       pylint a/c/y.py
+
+   - As this script will be invoked by emacs within the directory of the file we are checking
+     we need to traverse down out of it to avoid these false positives.
+
+
+You may also use py_run to run pylint with desired options and get back (or not) its output.
+"""
+
+import sys, os, re
+from subprocess import Popen, PIPE
+
+
+def lint(filename):
+    """Pylint the given file.
+
+    When run from emacs we will be in the directory of a file, and passed its filename.
+    If this file is part of a package and is trying to import other modules from within
+    its own package or another package rooted in a directory below it, pylint will classify
+    it as a failed import.
+
+    To get around this, we traverse down the directory tree to find the root of the package this
+    module is in.  We then invoke pylint from this directory.
+
+    Finally, we must correct the filenames in the output generated by pylint so Emacs doesn't
+    become confused (it will expect just the original filename, while pylint may extend it with
+    extra directories if we've traversed down the tree)
+    """
+    # traverse downwards until we are out of a python package
+    fullPath = os.path.abspath(filename)
+    parentPath, childPath = os.path.dirname(fullPath), os.path.basename(fullPath)
+
+    while parentPath != "/" and os.path.exists(os.path.join(parentPath, '__init__.py')):
+        childPath = os.path.join(os.path.basename(parentPath), childPath)
+        parentPath = os.path.dirname(parentPath)
+
+    # Start pylint
+    process = Popen("pylint -f parseable -r n --disable=C,R,I '%s'" %
+                    childPath, shell=True, stdout=PIPE, stderr=PIPE,
+                    cwd=parentPath)
+    p = process.stdout
+
+    # The parseable line format is '%(path)s:%(line)s: [%(sigle)s%(obj)s] %(msg)s'
+    # NOTE: This would be cleaner if we added an Emacs reporter to pylint.reporters.text ..
+    regex = re.compile(r"\[(?P<type>[WE])(?P<remainder>.*?)\]")
+
+    def _replacement(mObj):
+        "Alter to include 'Error' or 'Warning'"
+        if mObj.group("type") == "W":
+            replacement = "Warning"
+        else:
+            replacement = "Error"
+        # replace as "Warning (W0511, funcName): Warning Text"
+        return "%s (%s%s):" % (replacement, mObj.group("type"), mObj.group("remainder"))
+
+    for line in p:
+        # remove pylintrc warning
+        if line.startswith("No config file found"):
+            continue
+        line = regex.sub(_replacement, line, 1)
+        # modify the file name thats output to reverse the path traversal we made
+        parts = line.split(":")
+        if parts and parts[0] == childPath:
+            line = ":".join([filename] + parts[1:])
+        print line,
+
+    p.close()
+
+def Run():
+    lint(sys.argv[1])
+
+
+def py_run(command_options='', return_std=False, stdout=None, stderr=None,
+           script='pylint'):
+    """Run pylint from python (needs Python >= 2.4).
+
+    ``command_options`` is a string containing ``pylint`` command line options;
+    ``return_std`` (boolean) indicates return of created standart output
+    and error (see below);
+    ``stdout`` and ``stderr`` are 'file-like' objects in which standart output
+    could be written.
+
+    Calling agent is responsible for stdout/err management (creation, close).
+    Default standart output and error are those from sys,
+    or standalone ones (``subprocess.PIPE``) are used
+    if they are not set and ``return_std``.
+
+    If ``return_std`` is set to ``True``, this function returns a 2-uple
+    containing standart output and error related to created process,
+    as follows: ``(stdout, stderr)``.
+
+    A trivial usage could be as follows:
+        >>> py_run( '--version')
+        No config file found, using default configuration
+        pylint 0.18.1,
+            ...
+
+    To silently run Pylint on a module, and get its standart output and error:
+        >>> (pylint_stdout, pylint_stderr) = py_run( 'module_name.py', True)
+    """
+    # Create command line to call pylint
+    if os.name == 'nt':
+        script += '.bat'
+    command_line = script + ' ' + command_options
+    # Providing standart output and/or error if not set
+    if stdout is None:
+        if return_std:
+            stdout = PIPE
+        else:
+            stdout = sys.stdout
+    if stderr is None:
+        if return_std:
+            stderr = PIPE
+        else:
+            stderr = sys.stderr
+    # Call pylint in a subprocess
+    p = Popen(command_line, shell=True, stdout=stdout, stderr=stderr)
+    p.wait()
+    # Return standart output and error
+    if return_std:
+        return (p.stdout, p.stderr)
+
+
+if __name__ == '__main__':
+    lint(sys.argv[1])
+

data/tools/pylint2/pylint/gui.py

@@ -0,0 +1,433 @@
+"""Tkinker gui for pylint"""
+
+import os
+import sys
+import re
+import Queue
+from threading import Thread
+from Tkinter import Tk, Frame, Listbox, Entry, Label, Button, Scrollbar, Checkbutton, Radiobutton, IntVar, StringVar
+from Tkinter import TOP, LEFT, RIGHT, BOTTOM, END, X, Y, BOTH, SUNKEN, W, HORIZONTAL, DISABLED, NORMAL, W, E
+from tkFileDialog import askopenfilename, askdirectory
+
+import pylint.lint
+from pylint.reporters.guireporter import GUIReporter
+
+HOME = os.path.expanduser('~/')
+HISTORY = '.pylint-gui-history'
+COLORS = {'(I)':'lightblue',
+          '(C)':'blue', '(R)':'darkblue',
+          '(W)':'black', '(E)':'darkred',
+          '(F)':'red'}
+
+class BasicStream:
+    '''
+    used in gui reporter instead of writing to stdout, it is written to
+    this stream and saved in contents
+    '''
+    def __init__(self, gui):
+        """init"""
+        self.curline = ""
+        self.gui = gui
+        self.contents = []
+        self.outdict = {}
+        self.currout = None
+        self.nextTitle = None
+
+    def write(self, text):
+        """write text to the stream"""
+        if re.match('^--+$', text.strip()) or re.match('^==+$', text.strip()):
+            if self.currout:
+                self.outdict[self.currout].remove(self.nextTitle)
+                self.outdict[self.currout].pop()
+            self.currout = self.nextTitle
+            self.outdict[self.currout] = ['']
+
+        if text.strip():
+            self.nextTitle = text.strip()
+
+        if text.startswith('\n'):
+            self.contents.append('')
+            if self.currout: self.outdict[self.currout].append('')
+        self.contents[-1] += text.strip('\n')
+        if self.currout: self.outdict[self.currout][-1] += text.strip('\n')
+        if text.endswith('\n') and text.strip():
+            self.contents.append('')
+            if self.currout: self.outdict[self.currout].append('')
+
+    def fix_contents(self):
+        """finalize what the contents of the dict should look like before output"""
+        for item in self.outdict:
+            numEmpty = self.outdict[item].count('')
+            for i in range(numEmpty):
+                self.outdict[item].remove('')
+            if self.outdict[item]:
+                self.outdict[item].pop(0)
+
+    def output_contents(self):
+        """output contents of dict to the gui, and set the rating"""
+        self.fix_contents()
+        self.gui.tabs = self.outdict
+        try:
+            self.gui.rating.set(self.outdict['Global evaluation'][0])
+        except:
+            self.gui.rating.set('Error')
+        self.gui.refresh_results_window()
+
+        #reset stream variables for next run
+        self.contents = []
+        self.outdict = {}
+        self.currout = None
+        self.nextTitle = None
+
+
+class LintGui:
+    """Build and control a window to interact with pylint"""
+
+    def __init__(self, root=None):
+        """init"""
+        self.root = root or Tk()
+        self.root.title('Pylint')
+        #reporter
+        self.reporter = None
+        #message queue for output from reporter
+        self.msg_queue = Queue.Queue()
+        self.msgs = []
+        self.filenames = []
+        self.rating = StringVar()
+        self.tabs = {}
+        self.report_stream = BasicStream(self)
+        #gui objects
+        self.lbMessages = None
+        self.showhistory = None
+        self.results = None
+        self.btnRun = None
+        self.information_box = None
+        self.convention_box = None
+        self.refactor_box = None
+        self.warning_box = None
+        self.error_box = None
+        self.fatal_box = None
+        self.txtModule = None
+        self.status = None
+        self.msg_type_dict = None
+        self.init_gui()
+
+    def init_gui(self):
+        """init helper"""
+        #setting up frames
+        top_frame = Frame(self.root)
+        mid_frame = Frame(self.root)
+        radio_frame = Frame(self.root)
+        res_frame = Frame(self.root)
+        msg_frame = Frame(self.root)
+        check_frame = Frame(self.root)
+        history_frame = Frame(self.root)
+        btn_frame = Frame(self.root)
+        rating_frame = Frame(self.root)
+        top_frame.pack(side=TOP, fill=X)
+        mid_frame.pack(side=TOP, fill=X)
+        history_frame.pack(side=TOP, fill=BOTH, expand=True)
+        radio_frame.pack(side=TOP, fill=BOTH, expand=True)
+        rating_frame.pack(side=TOP, fill=BOTH, expand=True)
+        res_frame.pack(side=TOP, fill=BOTH, expand=True)
+        check_frame.pack(side=TOP, fill=BOTH, expand=True)
+        msg_frame.pack(side=TOP, fill=BOTH, expand=True)
+        btn_frame.pack(side=TOP, fill=X)
+
+        #Message ListBox
+        rightscrollbar = Scrollbar(msg_frame)
+        rightscrollbar.pack(side=RIGHT, fill=Y)
+        bottomscrollbar = Scrollbar(msg_frame, orient=HORIZONTAL)
+        bottomscrollbar.pack(side=BOTTOM, fill=X)
+        self.lbMessages = Listbox(msg_frame,
+                  yscrollcommand=rightscrollbar.set,
+                  xscrollcommand=bottomscrollbar.set,
+                  bg="white")
+        self.lbMessages.pack(expand=True, fill=BOTH)
+        rightscrollbar.config(command=self.lbMessages.yview)
+        bottomscrollbar.config(command=self.lbMessages.xview)
+
+        #History ListBoxes
+        rightscrollbar2 = Scrollbar(history_frame)
+        rightscrollbar2.pack(side=RIGHT, fill=Y)
+        bottomscrollbar2 = Scrollbar(history_frame, orient=HORIZONTAL)
+        bottomscrollbar2.pack(side=BOTTOM, fill=X)
+        self.showhistory = Listbox(history_frame,
+                    yscrollcommand=rightscrollbar2.set,
+                    xscrollcommand=bottomscrollbar2.set,
+                    bg="white")
+        self.showhistory.pack(expand=True, fill=BOTH)
+        rightscrollbar2.config(command=self.showhistory.yview)
+        bottomscrollbar2.config(command=self.showhistory.xview)
+        self.showhistory.bind('<Double-Button-1>', self.select_recent_file)
+        self.set_history_window()
+
+        #status bar
+        self.status = Label(self.root, text="", bd=1, relief=SUNKEN, anchor=W)
+        self.status.pack(side=BOTTOM, fill=X)
+
+        #labels
+        self.lblRatingLabel = Label(rating_frame, text='Rating:')
+        self.lblRatingLabel.pack(side=LEFT)
+        self.lblRating = Label(rating_frame, textvariable=self.rating)
+        self.lblRating.pack(side=LEFT)
+        Label(mid_frame, text='Recently Used:').pack(side=LEFT)
+        Label(top_frame, text='Module or package').pack(side=LEFT)
+
+        #file textbox
+        self.txtModule = Entry(top_frame, background='white')
+        self.txtModule.bind('<Return>', self.run_lint)
+        self.txtModule.pack(side=LEFT, expand=True, fill=X)
+
+        #results box
+        rightscrollbar = Scrollbar(res_frame)
+        rightscrollbar.pack(side=RIGHT, fill=Y)
+        bottomscrollbar = Scrollbar(res_frame, orient=HORIZONTAL)
+        bottomscrollbar.pack(side=BOTTOM, fill=X)
+        self.results = Listbox(res_frame,
+                  yscrollcommand=rightscrollbar.set,
+                  xscrollcommand=bottomscrollbar.set,
+                  bg="white", font="Courier")
+        self.results.pack(expand=True, fill=BOTH, side=BOTTOM)
+        rightscrollbar.config(command=self.results.yview)
+        bottomscrollbar.config(command=self.results.xview)
+
+        #buttons
+        Button(top_frame, text='Open', command=self.file_open).pack(side=LEFT)
+        Button(top_frame, text='Open Package', command=(lambda : self.file_open(package=True))).pack(side=LEFT)
+
+        self.btnRun = Button(top_frame, text='Run', command=self.run_lint)
+        self.btnRun.pack(side=LEFT)
+        Button(btn_frame, text='Quit', command=self.quit).pack(side=BOTTOM)
+
+        #radio buttons
+        self.information_box = IntVar()
+        self.convention_box = IntVar()
+        self.refactor_box = IntVar()
+        self.warning_box = IntVar()
+        self.error_box = IntVar()
+        self.fatal_box = IntVar()
+        i = Checkbutton(check_frame, text="Information", fg=COLORS['(I)'], variable=self.information_box, command=self.refresh_msg_window)
+        c = Checkbutton(check_frame, text="Convention", fg=COLORS['(C)'], variable=self.convention_box, command=self.refresh_msg_window)
+        r = Checkbutton(check_frame, text="Refactor", fg=COLORS['(R)'], variable=self.refactor_box, command=self.refresh_msg_window)
+        w = Checkbutton(check_frame, text="Warning", fg=COLORS['(W)'], variable=self.warning_box, command=self.refresh_msg_window)
+        e = Checkbutton(check_frame, text="Error", fg=COLORS['(E)'], variable=self.error_box, command=self.refresh_msg_window)
+        f = Checkbutton(check_frame, text="Fatal", fg=COLORS['(F)'], variable=self.fatal_box, command=self.refresh_msg_window)
+        i.select()
+        c.select()
+        r.select()
+        w.select()
+        e.select()
+        f.select()
+        i.pack(side=LEFT)
+        c.pack(side=LEFT)
+        r.pack(side=LEFT)
+        w.pack(side=LEFT)
+        e.pack(side=LEFT)
+        f.pack(side=LEFT)
+
+        #check boxes
+        self.box = StringVar()
+        # XXX should be generated
+        report = Radiobutton(radio_frame, text="Report", variable=self.box, value="Report", command=self.refresh_results_window)
+        rawMet = Radiobutton(radio_frame, text="Raw metrics", variable=self.box, value="Raw metrics", command=self.refresh_results_window)
+        dup = Radiobutton(radio_frame, text="Duplication", variable=self.box, value="Duplication", command=self.refresh_results_window)
+        ext = Radiobutton(radio_frame, text="External dependencies", variable=self.box, value="External dependencies", command=self.refresh_results_window)
+        stat = Radiobutton(radio_frame, text="Statistics by type", variable=self.box, value="Statistics by type", command=self.refresh_results_window)
+        msgCat = Radiobutton(radio_frame, text="Messages by category", variable=self.box, value="Messages by category", command=self.refresh_results_window)
+        msg = Radiobutton(radio_frame, text="Messages", variable=self.box, value="Messages", command=self.refresh_results_window)
+        report.select()
+        report.grid(column=0, row=0, sticky=W)
+        rawMet.grid(column=1, row=0, sticky=W)
+        dup.grid(column=2, row=0, sticky=W)
+        msg.grid(column=3, row=0, sticky=E)
+        stat.grid(column=0, row=1, sticky=W)
+        msgCat.grid(column=1, row=1, sticky=W)
+        ext.grid(column=2, row=1, columnspan=2, sticky=W)
+
+        #dictionary for check boxes and associated error term
+        self.msg_type_dict = {
+            'I' : lambda : self.information_box.get() == 1,
+            'C' : lambda : self.convention_box.get() == 1,
+            'R' : lambda : self.refactor_box.get() == 1,
+            'E' : lambda : self.error_box.get() == 1,
+            'W' : lambda : self.warning_box.get() == 1,
+            'F' : lambda : self.fatal_box.get() == 1
+        }
+        self.txtModule.focus_set()
+
+
+    def select_recent_file(self, event):
+        """adds the selected file in the history listbox to the Module box"""
+        if not self.showhistory.size():
+            return
+
+        selected = self.showhistory.curselection()
+        item = self.showhistory.get(selected)
+        #update module
+        self.txtModule.delete(0, END)
+        self.txtModule.insert(0, item)
+
+    def refresh_msg_window(self):
+        """refresh the message window with current output"""
+        #clear the window
+        self.lbMessages.delete(0, END)
+        for msg in self.msgs:
+            if (self.msg_type_dict.get(msg[0])()):
+                msg_str = self.convert_to_string(msg)
+                self.lbMessages.insert(END, msg_str)
+                fg_color = COLORS.get(msg_str[:3], 'black')
+                self.lbMessages.itemconfigure(END, fg=fg_color)
+
+    def refresh_results_window(self):
+        """refresh the results window with current output"""
+        #clear the window
+        self.results.delete(0, END)
+        try:
+            for res in self.tabs[self.box.get()]:
+                self.results.insert(END, res)
+        except:
+            pass
+
+    def convert_to_string(self, msg):
+        """make a string representation of a message"""
+        if (msg[2] != ""):
+            return "(" + msg[0] + ") " + msg[1] + "." + msg[2] + " [" + msg[3] + "]: " + msg[4]
+        else:
+            return "(" + msg[0] + ") " + msg[1] + " [" + msg[3] + "]: " + msg[4]
+
+    def process_incoming(self):
+        """process the incoming messages from running pylint"""
+        while self.msg_queue.qsize():
+            try:
+                msg = self.msg_queue.get(0)
+                if msg == "DONE":
+                    self.report_stream.output_contents()
+                    return False
+
+                #adding message to list of msgs
+                self.msgs.append(msg)
+
+                #displaying msg if message type is selected in check box
+                if (self.msg_type_dict.get(msg[0])()):
+                    msg_str = self.convert_to_string(msg)
+                    self.lbMessages.insert(END, msg_str)
+                    fg_color = COLORS.get(msg_str[:3], 'black')
+                    self.lbMessages.itemconfigure(END, fg=fg_color)
+
+            except Queue.Empty:
+                pass
+        return True
+
+    def periodic_call(self):
+        """determine when to unlock the run button"""
+        if self.process_incoming():
+            self.root.after(100, self.periodic_call)
+        else:
+            #enabling button so it can be run again
+            self.btnRun.config(state=NORMAL)
+
+    def mainloop(self):
+        """launch the mainloop of the application"""
+        self.root.mainloop()
+
+    def quit(self, _=None):
+        """quit the application"""
+        self.root.quit()
+
+    def halt(self):
+        """program halt placeholder"""
+        return
+
+    def file_open(self, package=False, _=None):
+        """launch a file browser"""
+        if not package:
+            filename = askopenfilename(parent=self.root, filetypes=[('pythonfiles','*.py'),
+                                                    ('allfiles','*')],title='Select Module')
+        else:
+            filename = askdirectory(title="Select A Folder", mustexist=1)
+
+        if filename == ():
+            return
+
+        self.txtModule.delete(0, END)
+        self.txtModule.insert(0, filename)
+
+    def update_filenames(self):
+        """update the list of recent filenames"""
+        filename = self.txtModule.get()
+        if not filename:
+            filename = os.getcwd()
+        if filename+'\n' in self.filenames:
+            index = self.filenames.index(filename+'\n')
+            self.filenames.pop(index)
+
+        #ensure only 10 most recent are stored
+        if len(self.filenames) == 10:
+            self.filenames.pop()
+        self.filenames.insert(0, filename+'\n')
+
+    def set_history_window(self):
+        """update the history window with info from the history file"""
+        #clear the window
+        self.showhistory.delete(0, END)
+        # keep the last 10 most recent files
+        try:
+            view_history = open(HOME+HISTORY, 'r')
+            for hist in view_history.readlines():
+                if not hist in self.filenames:
+                    self.filenames.append(hist)
+                self.showhistory.insert(END, hist.split('\n')[0])
+            view_history.close()
+        except IOError:
+            # do nothing since history file will be created later
+            return
+
+    def run_lint(self, _=None):
+        """launches pylint"""
+        self.update_filenames()
+        self.root.configure(cursor='watch')
+        self.reporter = GUIReporter(self, output=self.report_stream)
+        module = self.txtModule.get()
+        if not module:
+            module = os.getcwd()
+
+        #cleaning up msgs and windows
+        self.msgs = []
+        self.lbMessages.delete(0, END)
+        self.tabs = {}
+        self.results.delete(0, END)
+        self.btnRun.config(state=DISABLED)
+
+        #setting up a worker thread to run pylint
+        worker = Thread(target=lint_thread, args=(module, self.reporter, self,))
+        self.periodic_call()
+        worker.start()
+
+        # Overwrite the .pylint-gui-history file with all the new recently added files
+        # in order from filenames but only save last 10 files
+        write_history = open(HOME+HISTORY, 'w')
+        write_history.writelines(self.filenames)
+        write_history.close()
+        self.set_history_window()
+
+        self.root.configure(cursor='')
+
+
+def lint_thread(module, reporter, gui):
+    """thread for pylint"""
+    gui.status.text = "processing module(s)"
+    lint_obj = pylint.lint.Run(args=[module], reporter=reporter, exit=False)
+    gui.msg_queue.put("DONE")
+
+
+def Run(args):
+    """launch pylint gui from args"""
+    if args:
+        print 'USAGE: pylint-gui\n launch a simple pylint gui using Tk'
+        return
+    gui = LintGui()
+    gui.mainloop()
+
+if __name__ == '__main__':
+    Run(sys.argv[1:])

data/tools/pylint2/pylint/interfaces.py

@@ -0,0 +1,98 @@
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+""" Copyright (c) 2002-2003 LOGILAB S.A. (Paris, FRANCE).
+ http://www.logilab.fr/ -- mailto:contact@logilab.fr
+
+Interfaces for PyLint objects
+"""
+
+__revision__ = "$Id: interfaces.py,v 1.1 2010/06/14 14:30:29 casa Exp $"
+
+from logilab.common.interface import Interface
+
+
+class IChecker(Interface):
+    """This is an base interface, not designed to be used elsewhere than for
+    sub interfaces definition.
+    """
+
+    def open(self):
+        """called before visiting project (i.e set of modules)"""
+        
+    def close(self):
+        """called after visiting project (i.e set of modules)"""
+
+##     def open_module(self):
+##         """called before visiting a module"""
+        
+##     def close_module(self):
+##         """called after visiting a module"""
+        
+    
+class IRawChecker(IChecker):
+    """interface for checker which need to parse the raw file
+    """
+    
+    def process_module(self, stream):
+        """ process a module
+        
+        the module's content is accessible via the stream object
+        """
+
+
+class IASTNGChecker(IChecker):
+    """ interface for checker which prefers receive events according to
+    statement type
+    """
+
+
+class ILinter(Interface):
+    """interface for the linter class
+
+    the linter class will generate events to its registered checkers.
+    Each checker may interact with the linter instance using this API
+    """
+    
+    def register_checker(self, checker):
+        """register a new checker class
+
+        checker is a class implementing IrawChecker or / and IASTNGChecker
+        """
+
+    def add_message(self, msg_id, line=None, node=None, args=None):
+        """add the message corresponding to the given id.
+
+        If provided, msg is expanded using args
+        
+        astng checkers should provide the node argument,
+        raw checkers should provide the line argument.
+        """
+        
+
+class IReporter(Interface):
+    """ reporter collect messages and display results encapsulated in a layout
+    """
+    def add_message(self, msg_id, location, msg):
+        """add a message of a given type
+
+        msg_id is a message identifier
+        location is a 3-uple (module, object, line)
+        msg is the actual message
+        """
+        
+    def display_results(self, layout):
+        """display results encapsulated in the layout tree
+        """
+        
+    
+__all__ = ('IRawChecker', 'IStatable', 'ILinter', 'IReporter')