bee_python 0.0.1

data/tools/pylint2/pylint/pyreverse/utils.py

@@ -0,0 +1,131 @@
+# Copyright (c) 2002-2010 LOGILAB S.A. (Paris, FRANCE).
+# http://www.logilab.fr/ -- mailto:contact@logilab.fr
+#
+# 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.
+"""
+generic classes/functions for pyreverse core/extensions
+"""
+
+import sys
+import re
+import os
+
+########### pyreverse option utils ##############################
+
+
+RCFILE = '.pyreverserc'
+
+def get_default_options():
+    """
+    Read config file and return list of options
+    """
+    options = []
+    home = os.environ.get('HOME', '')
+    if home:
+        rcfile = os.path.join(home, RCFILE)
+        try:
+            options = open(rcfile).read().split()
+        except IOError:
+            pass # ignore if no config file found
+    return options
+
+def insert_default_options():
+    """insert default options to sys.argv
+    """
+    options = get_default_options()
+    options.reverse()
+    for arg in options:
+        sys.argv.insert(1, arg)
+
+
+
+# astng utilities ###########################################################
+
+SPECIAL = re.compile('^__[A-Za-z0-9]+[A-Za-z0-9_]*__$')
+PRIVATE = re.compile('^__[_A-Za-z0-9]*[A-Za-z0-9]+_?$')
+PROTECTED = re.compile('^_[_A-Za-z0-9]*$')
+
+def get_visibility(name):
+    """return the visibility from a name: public, protected, private or special
+    """
+    if SPECIAL.match(name):
+        visibility = 'special'
+    elif PRIVATE.match(name):
+        visibility = 'private'
+    elif PROTECTED.match(name):
+        visibility = 'protected'
+
+    else:
+        visibility = 'public'
+    return visibility
+
+ABSTRACT = re.compile('^.*Abstract.*')
+FINAL = re.compile('^[A-Z_]*$')
+
+def is_abstract(node):
+    """return true if the given class node correspond to an abstract class
+    definition
+    """
+    return ABSTRACT.match(node.name)
+
+def is_final(node):
+    """return true if the given class/function node correspond to final
+    definition
+    """
+    return FINAL.match(node.name)
+
+def is_interface(node):
+    # bw compat
+    return node.type == 'interface'
+
+def is_exception(node):
+    # bw compat
+    return node.type == 'exception'
+
+
+# Helpers #####################################################################
+
+_CONSTRUCTOR = 1
+_SPECIAL = 2
+_PROTECTED = 4
+_PRIVATE = 8
+MODES = {
+    'ALL'       : 0,
+    'PUB_ONLY'  : _SPECIAL + _PROTECTED + _PRIVATE,
+    'SPECIAL'   : _SPECIAL,
+    'OTHER'     : _PROTECTED + _PRIVATE,
+}
+VIS_MOD = {'special': _SPECIAL, 'protected': _PROTECTED, \
+            'private': _PRIVATE, 'public': 0 }
+
+class FilterMixIn:
+    """filter nodes according to a mode and nodes' visibility
+    """
+    def __init__(self, mode):
+        "init filter modes"
+        __mode = 0
+        for nummod in mode.split('+'):
+            try:
+                __mode += MODES[nummod]
+            except KeyError, ex:
+                print >> sys.stderr, 'Unknown filter mode %s' % ex
+        self.__mode = __mode
+
+
+    def show_attr(self, node):
+        """return true if the node should be treated
+        """
+        visibility = get_visibility(getattr(node, 'name', node))
+        return not (self.__mode & VIS_MOD[visibility] )
+

data/tools/pylint2/pylint/pyreverse/writer.py

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2008-2010 LOGILAB S.A. (Paris, FRANCE).
+# http://www.logilab.fr/ -- mailto:contact@logilab.fr
+#
+# 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.
+"""
+Utilities for creating VCG and Dot diagrams.
+"""
+
+from logilab.common.vcgutils import VCGPrinter
+from logilab.common.graph import DotBackend
+
+from pylint.pyreverse.utils import is_exception
+
+class DiagramWriter:
+    """base class for writing project diagrams
+    """
+    def __init__(self, config, styles):
+        self.config = config
+        self.pkg_edges, self.inh_edges, self.imp_edges, self.ass_edges = styles
+        self.printer = None # defined in set_printer
+
+    def write(self, diadefs):
+        """write files for <project> according to <diadefs>
+        """
+        for diagram in diadefs:
+            basename = diagram.title.strip().replace(' ', '_')
+            file_name = '%s.%s' % (basename, self.config.output_format)
+            self.set_printer(file_name, basename)
+            if diagram.TYPE == 'class':
+                self.write_classes(diagram)
+            else:
+                self.write_packages(diagram)
+            self.close_graph()
+
+    def write_packages(self, diagram):
+        """write a package diagram"""
+        for obj in diagram.modules():
+            label = self.get_title(obj)
+            self.printer.emit_node(obj.fig_id, label=label, shape='box')
+        # package dependencies
+        for rel in diagram.relationships.get('depends', ()):
+            self.printer.emit_edge(rel.from_object.fig_id, rel.to_object.fig_id,
+                              **self.pkg_edges)
+
+    def write_classes(self, diagram):
+        """write a class diagram"""
+        for obj in diagram.objects:
+            self.printer.emit_node(obj.fig_id, **self.get_values(obj) )
+        # inheritance links
+        for rel in diagram.relationships.get('specialization', ()):
+            self.printer.emit_edge(rel.from_object.fig_id, rel.to_object.fig_id,
+                              **self.inh_edges)
+        # implementation links
+        for rel in diagram.relationships.get('implements', ()):
+            self.printer.emit_edge(rel.from_object.fig_id, rel.to_object.fig_id,
+                              **self.imp_edges)
+        # generate associations
+        for rel in diagram.relationships.get('association', ()):
+            self.printer.emit_edge(rel.from_object.fig_id, rel.to_object.fig_id,
+                              label=rel.name, **self.ass_edges)
+
+    def set_printer(self, file_name, basename):
+        """set printer"""
+        raise NotImplementedError
+
+    def get_title(self, obj):
+        """get project title"""
+        raise NotImplementedError
+
+    def get_values(self, obj):
+        """get label and shape for classes."""
+        raise NotImplementedError
+
+    def close_graph(self):
+        """finalize the graph"""
+        raise NotImplementedError
+
+
+class DotWriter(DiagramWriter):
+    """write dot graphs from a diagram definition and a project
+    """
+
+    def __init__(self, config):
+        styles = [dict(arrowtail='none', arrowhead="open"), 
+                  dict(arrowtail = "none", arrowhead='empty'), 
+                  dict(arrowtail="node", arrowhead='empty', style='dashed'),
+                  dict(fontcolor='green', arrowtail='none',
+                       arrowhead='diamond', style='solid') ]
+        DiagramWriter.__init__(self, config, styles)
+
+    def set_printer(self, file_name, basename):
+        """initialize DotWriter and add options for layout.
+        """
+        layout = dict(rankdir="BT")
+        self.printer = DotBackend(basename, additionnal_param=layout)
+        self.file_name = file_name
+
+    def get_title(self, obj):
+        """get project title"""
+        return obj.title
+
+    def get_values(self, obj):
+        """get label and shape for classes.
+        
+        The label contains all attributes and methods
+        """
+        label =  obj.title
+        if obj.shape == 'interface':
+            label = "«interface»\\n%s" % label
+        if not self.config.only_classnames:
+            label = "%s|%s\l|" % (label,  r"\l".join(obj.attrs) )
+            for func in obj.methods:
+                label = r'%s%s()\l' % (label, func.name)
+            label = '{%s}' % label
+        if is_exception(obj.node):
+            return dict(fontcolor="red", label=label, shape="record")
+        return dict(label=label, shape="record")
+
+    def close_graph(self):
+        """print the dot graph into <file_name>"""
+        self.printer.generate(self.file_name)
+
+
+class VCGWriter(DiagramWriter):
+    """write vcg graphs from a diagram definition and a project
+    """
+    def __init__(self, config):
+        styles = [dict(arrowstyle='solid', backarrowstyle='none',
+                       backarrowsize=0),
+                  dict(arrowstyle='solid', backarrowstyle='none', 
+                       backarrowsize=10),
+                  dict(arrowstyle='solid', backarrowstyle='none',
+                       linestyle='dotted', backarrowsize=10),
+                  dict(arrowstyle='solid', backarrowstyle='none',
+                       textcolor='green') ]
+        DiagramWriter.__init__(self, config, styles)
+
+    def set_printer(self, file_name, basename):
+        """initialize VCGWriter for a UML graph"""
+        self.graph_file = open(file_name, 'w+')
+        self.printer = VCGPrinter(self.graph_file)
+        self.printer.open_graph(title=basename, layoutalgorithm='dfs',
+                                late_edge_labels='yes', port_sharing='no',
+                                manhattan_edges='yes')
+        self.printer.emit_node = self.printer.node
+        self.printer.emit_edge = self.printer.edge
+
+    def get_title(self, obj):
+        """get project title in vcg format"""
+        return r'\fb%s\fn' % obj.title
+
+    def get_values(self, obj):
+        """get label and shape for classes.
+        
+        The label contains all attributes and methods
+        """
+        if is_exception(obj.node):
+            label = r'\fb\f09%s\fn' % obj.title
+        else:
+            label = r'\fb%s\fn' % obj.title
+        if obj.shape == 'interface':
+            shape = 'ellipse'
+        else:
+            shape = 'box'
+        if not self.config.only_classnames:
+            attrs = obj.attrs
+            methods = [func.name for func in obj.methods]
+            # box width for UML like diagram
+            maxlen = max(len(name) for name in [obj.title] + methods + attrs)
+            line =  "_" * (maxlen + 2)
+            label = r'%s\n\f%s' % (label, line)
+            for attr in attrs:
+                label = r'%s\n\f08%s' % (label, attr)
+            if attrs:
+                label = r'%s\n\f%s' % (label, line)
+            for func in methods:
+                label = r'%s\n\f10%s()' % (label, func)
+        return dict(label=label, shape=shape)
+
+    def close_graph(self):
+        """close graph and file"""
+        self.printer.close_graph()
+        self.graph_file.close()
+

data/tools/pylint2/pylint/reporters/__init__.py

@@ -0,0 +1,67 @@
+# 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.
+"""utilities methods and classes for reporters
+
+ Copyright (c) 2000-2003 LOGILAB S.A. (Paris, FRANCE).
+ http://www.logilab.fr/ -- mailto:contact@logilab.fr
+"""
+
+import sys
+
+CMPS = ['=', '-', '+']
+
+def diff_string(old, new):
+    """given a old and new int value, return a string representing the
+    difference
+    """
+    diff = abs(old - new)
+    diff_str = "%s%s" % (CMPS[cmp(old, new)], diff and ('%.2f' % diff) or '')
+    return diff_str
+
+
+class EmptyReport(Exception):
+    """raised when a report is empty and so should not be displayed"""
+
+class BaseReporter:
+    """base class for reporters"""
+
+    extension = ''
+    
+    def __init__(self, output=None):
+        self.linter = None
+        self.include_ids = None
+        self.section = 0
+        self.out = None
+        self.set_output(output)
+        
+    def set_output(self, output=None):
+        """set output stream"""
+        if output is None:
+            output = sys.stdout
+        self.out = output
+        
+    def writeln(self, string=''):
+        """write a line in the output buffer"""
+        print >> self.out, string
+        
+    def display_results(self, layout):
+        """display results encapsulated in the layout tree"""
+        self.section = 0
+        if self.include_ids and hasattr(layout, 'report_id'):
+            layout.children[0].children[0].data += ' (%s)' % layout.report_id
+        self._display(layout)
+        
+    def _display(self, layout):
+        """display the layout"""
+        raise NotImplementedError()
+        

data/tools/pylint2/pylint/reporters/guireporter.py

@@ -0,0 +1,36 @@
+""" reporter used by gui.py """
+
+import sys
+
+from pylint.interfaces import IReporter
+from pylint.reporters import BaseReporter
+from logilab.common.ureports import TextWriter
+
+
+class GUIReporter(BaseReporter):
+    """saves messages"""
+
+    __implements__ = IReporter
+    extension = ''
+
+    def __init__(self, gui, output=sys.stdout):
+        """init"""
+        BaseReporter.__init__(self, output)
+        self.msgs = []
+        self.gui = gui
+
+    def add_message(self, msg_id, location, msg):
+        """manage message of different type and in the context of path"""
+        module, obj, line = location[1:]
+        if self.include_ids:
+            sigle = msg_id
+        else:
+            sigle = msg_id[0]
+
+        full_msg = [sigle, module, obj, str(line), msg]
+        self.msgs += [[sigle, module, obj, str(line)]]
+        self.gui.msg_queue.put(full_msg)
+
+    def _display(self, layout):
+        """launch layouts display"""
+        TextWriter().format(layout, self.out)

data/tools/pylint2/pylint/reporters/html.py

@@ -0,0 +1,69 @@
+# Copyright (c) 2003-2006 Sylvain Thenault (thenault@gmail.com).
+# Copyright (c) 2003-2006 LOGILAB S.A. (Paris, FRANCE).
+# 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.
+"""HTML reporter"""
+
+import sys
+from cgi import escape
+
+from logilab.common.ureports import HTMLWriter, Section, Table
+
+from pylint.interfaces import IReporter
+from pylint.reporters import BaseReporter
+
+
+class HTMLReporter(BaseReporter):
+    """report messages and layouts in HTML"""
+
+    __implements__ = IReporter
+    extension = 'html'
+    
+    def __init__(self, output=sys.stdout):
+        BaseReporter.__init__(self, output)
+        self.msgs = []
+
+    def add_message(self, msg_id, location, msg):
+        """manage message of different type and in the context of path"""
+        module, obj, line = location[1:]
+        if self.include_ids:
+            sigle = msg_id
+        else:
+            sigle = msg_id[0]
+        self.msgs += [sigle, module, obj, str(line), escape(msg)]
+        
+    def set_output(self, output=None):
+        """set output stream
+        
+        messages buffered for old output is processed first"""
+        if self.out and self.msgs:
+            self._display(Section())
+        BaseReporter.set_output(self, output)
+        
+    def _display(self, layout):
+        """launch layouts display
+        
+        overridden from BaseReporter to add insert the messages section
+        (in add_message, message is not displayed, just collected so it
+        can be displayed in an html table)
+        """
+        if self.msgs:
+            # add stored messages to the layout
+            msgs = ['type', 'module', 'object', 'line', 'message']
+            msgs += self.msgs
+            sect = Section('Messages')
+            layout.append(sect)
+            sect.append(Table(cols=5, children=msgs, rheaders=1))
+            self.msgs = []
+        HTMLWriter().format(layout, self.out)
+

data/tools/pylint2/pylint/reporters/text.py

@@ -0,0 +1,156 @@
+# Copyright (c) 2003-2007 Sylvain Thenault (thenault@gmail.com).
+# Copyright (c) 2003-2007 LOGILAB S.A. (Paris, FRANCE).
+# 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.
+"""Plain text reporters:
+
+:text: the default one grouping messages by module
+:parseable:
+  standard parseable output with full module path on each message (for
+  editor integration) 
+:colorized: an ANSI colorized text reporter
+
+"""
+
+import os
+import sys
+
+from logilab.common.ureports import TextWriter
+from logilab.common.textutils import colorize_ansi
+
+from pylint.interfaces import IReporter
+from pylint.reporters import BaseReporter
+
+TITLE_UNDERLINES = ['', '=', '-', '.']
+
+
+class TextReporter(BaseReporter):
+    """reports messages and layouts in plain text
+    """
+    
+    __implements__ = IReporter
+    extension = 'txt'
+    
+    def __init__(self, output=sys.stdout):
+        BaseReporter.__init__(self, output)
+        self._modules = {}
+
+    def add_message(self, msg_id, location, msg):
+        """manage message of different type and in the context of path"""
+        module, obj, line = location[1:]
+        if not self._modules.has_key(module):
+            if module:
+                self.writeln('************* Module %s' % module)
+                self._modules[module] = 1
+            else:
+                self.writeln('************* %s' % module)
+        if obj:
+            obj = ':%s' % obj
+        if self.include_ids:
+            sigle = msg_id
+        else:
+            sigle = msg_id[0]
+        self.writeln('%s:%3s%s: %s' % (sigle, line, obj, msg))
+
+    def _display(self, layout):
+        """launch layouts display"""
+        print >> self.out 
+        TextWriter().format(layout, self.out)
+
+
+class ParseableTextReporter(TextReporter):
+    """a reporter very similar to TextReporter, but display messages in a form
+    recognized by most text editors :
+    
+    <filename>:<linenum>:<msg>
+    """
+    line_format = '%(path)s:%(line)s: [%(sigle)s%(obj)s] %(msg)s'
+    
+    def __init__(self, output=sys.stdout, relative=True):
+        TextReporter.__init__(self, output)
+        if relative:
+            self._prefix = os.getcwd() + os.sep
+        else:
+            self._prefix = ''
+
+    def add_message(self, msg_id, location, msg):
+        """manage message of different type and in the context of path"""
+        path, _, obj, line = location
+        if obj:
+            obj = ', %s' % obj
+        if self.include_ids:
+            sigle = msg_id
+        else:
+            sigle = msg_id[0]
+        if self._prefix:
+            path = path.replace(self._prefix, '')
+        self.writeln(self.line_format % locals())
+    
+class VSTextReporter(ParseableTextReporter):
+    """Visual studio text reporter"""
+    line_format = '%(path)s(%(line)s): [%(sigle)s%(obj)s] %(msg)s'
+    
+class ColorizedTextReporter(TextReporter):
+    """Simple TextReporter that colorizes text output"""
+
+    COLOR_MAPPING = {
+        "I" : ("green", None),
+        'C' : (None, "bold"),
+        'R' : ("magenta", "bold, italic"),
+        'W' : ("blue", None),
+        'E' : ("red", "bold"),
+        'F' : ("red", "bold, underline"),
+        'S' : ("yellow", "inverse"), # S stands for module Separator
+    }
+
+    def __init__(self, output=sys.stdout, color_mapping = None):
+        TextReporter.__init__(self, output)
+        self.color_mapping = color_mapping or \
+                             dict(ColorizedTextReporter.COLOR_MAPPING)
+       
+
+    def _get_decoration(self, msg_id):
+        """Returns the tuple color, style associated with msg_id as defined
+        in self.color_mapping
+        """
+        try:
+            return self.color_mapping[msg_id[0]]
+        except KeyError:
+            return None, None
+
+    def add_message(self, msg_id, location, msg):
+        """manage message of different types, and colorize output
+        using ansi escape codes
+        """
+        module, obj, line = location[1:]
+        if not self._modules.has_key(module):
+            color, style = self._get_decoration('S')
+            if module:
+                modsep = colorize_ansi('************* Module %s' % module,
+                                       color, style)
+            else:
+                modsep = colorize_ansi('************* %s' % module,
+                                       color, style)
+            self.writeln(modsep)
+            self._modules[module] = 1
+        if obj:
+            obj = ':%s' % obj
+        if self.include_ids:
+            sigle = msg_id
+        else:
+            sigle = msg_id[0]
+        color, style = self._get_decoration(sigle)
+        msg = colorize_ansi(msg, color, style)
+        sigle = colorize_ansi(sigle, color, style)
+        self.writeln('%s:%3s%s: %s' % (sigle, line, obj, msg))
+