Merge pull request #172 from nschloe/pylint

Pylint

Author: nschloe

.pylintrc

@@ -0,0 +1,15 @@
+[MESSAGES CONTROL]
+
+disable=
+    bad-continuation,
+    duplicate-code,
+    fixme,
+    invalid-name,
+    locally-disabled,
+    missing-docstring,
+    no-member,
+    too-few-public-methods,
+    too-many-branches,
+    too-many-statements,
+    too-many-arguments,
+    too-many-locals

.travis.yml

@@ -31,7 +31,7 @@ addons:
       - python-tk
 
 before_install:
-  - pip install pytest pytest-cov code_extract
+  - pip install pytest pytest-cov code_extract pylint
   # Make sure to put the readme test at the very end; otherwise it's messing
   # around with the other tests.
   - code_extract README.md test/zzz_readme_test.py --filter python,test
@@ -51,6 +51,8 @@ before_script:
 
 # run tests
 script:
+  - pylint matplotlib2tikz/
+  - pylint test/*py
   # cd into test directory to make sure we're using the pip-installed
   # matplotlib2tikz.
   - cd test && MPLBACKEND=Agg pytest --cov matplotlib2tikz

matplotlib2tikz/__about__.py

@@ -5,6 +5,6 @@
 __copyright__ = 'Copyright (c) 2010-2017, %s <%s>' % (__author__, __email__)
 __credits__ = []
 __license__ = 'License :: OSI Approved :: MIT License'
-__version__ = '0.6.8'
+__version__ = '0.6.9'
 __maintainer__ = u'Nico Schlömer'
 __status__ = 'Development Status :: 5 - Production/Stable'

matplotlib2tikz/__init__.py

@@ -2,6 +2,7 @@
 #
 '''Script to convert Matplotlib generated figures into TikZ/PGFPlots figures.
 '''
+from __future__ import print_function
 
 from matplotlib2tikz.__about__ import (
         __author__,

matplotlib2tikz/axes.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 #
-from . import color
-
 import matplotlib as mpl
 import numpy
 
+from . import color
+
 
 class Axes(object):
     def __init__(self, data, obj):
@@ -174,6 +174,7 @@ def __init__(self, data, obj):
         # Unfortunately, _tickdir doesn't seem to be quite accurate. See
         # <https://github.com/matplotlib/matplotlib/issues/5311>.
         # For now, just take the first tick direction of each of the axes.
+        # pylint: disable=protected-access
         x_tick_dirs = [tick._tickdir for tick in obj.xaxis.get_major_ticks()]
         y_tick_dirs = [tick._tickdir for tick in obj.yaxis.get_major_ticks()]
         if x_tick_dirs or y_tick_dirs:
@@ -200,20 +201,18 @@ def __init__(self, data, obj):
 
         # Set each rotation for every label
         x_tick_rotation_and_horizontal_alignment = \
-            self.__get_label_rotation_and_horizontal_alignment(obj, data, 'x')
+            _get_label_rotation_and_horizontal_alignment(obj, data, 'x')
         if x_tick_rotation_and_horizontal_alignment:
             self.axis_options.append(x_tick_rotation_and_horizontal_alignment)
 
         y_tick_rotation_and_horizontal_alignment = \
-            self.__get_label_rotation_and_horizontal_alignment(obj, data, 'y')
+            _get_label_rotation_and_horizontal_alignment(obj, data, 'y')
         if y_tick_rotation_and_horizontal_alignment:
             self.axis_options.append(y_tick_rotation_and_horizontal_alignment)
 
         # Set tick position
-        x_tick_position_string, x_tick_position = \
-            self.__get_tick_position(obj, data, 'x')
-        y_tick_position_string, y_tick_position = \
-            self.__get_tick_position(obj, data, 'y')
+        x_tick_position_string, x_tick_position = _get_tick_position(obj, 'x')
+        y_tick_position_string, y_tick_position = _get_tick_position(obj, 'y')
 
         if x_tick_position == y_tick_position and x_tick_position is not None:
             self.axis_options.append("tick pos=%s" % x_tick_position)
@@ -225,6 +224,7 @@ def __init__(self, data, obj):
         # <http://sourceforge.net/p/matplotlib/mailman/message/25169234/>
         # Coordinate of the lines are entirely meaningless, but styles
         # (colors,...) are respected.
+        # pylint: disable=protected-access
         if obj.xaxis._gridOnMajor:
             self.axis_options.append('xmajorgrids')
         elif obj.xaxis._gridOnMinor:
@@ -237,6 +237,7 @@ def __init__(self, data, obj):
             if col != 'black':
                 self.axis_options.append('x grid style={%s}' % col)
 
+        # pylint: disable=protected-access
         if obj.yaxis._gridOnMajor:
             self.axis_options.append('ymajorgrids')
         elif obj.yaxis._gridOnMinor:
@@ -386,128 +387,138 @@ def __init__(self, data, obj):
 
         return
 
-    def __get_label_rotation_and_horizontal_alignment(self, obj, data, axes):
-        tick_label_text_width = None
-        tick_label_text_width_identifier = "%s tick label text width" % axes
-        if tick_label_text_width_identifier in data['extra axis options']:
-            tick_label_text_width = data['extra axis options [base]'][
-                        tick_label_text_width_identifier
-                        ]
-            del data['extra axis options'][tick_label_text_width_identifier]
+    def get_begin_code(self):
+        content = self.content
+        if self.axis_options:
+            content.append('[\n' + ',\n'.join(self.axis_options) + '\n]\n')
+        return content
+
+    def get_end_code(self, data):
+        if not self.is_subplot:
+            return '\\end{axis}\n\n'
+        elif self.is_subplot and self.nsubplots == self.subplot_index:
+            data['is_in_groupplot_env'] = False
+            return '\\end{groupplot}\n\n'
+
+        return ''
 
-        label_style = ""
 
-        major_tick_labels = obj.xaxis.get_majorticklabels() if axes == 'x' \
-            else obj.yaxis.get_majorticklabels()
+def _get_label_rotation_and_horizontal_alignment(
+        obj, data, axes_obj
+        ):
+    tick_label_text_width = None
+    tick_label_text_width_identifier = \
+        '%s tick label text width' % axes_obj
+    if tick_label_text_width_identifier in data['extra axis options']:
+        tick_label_text_width = data['extra axis options [base]'][
+                    tick_label_text_width_identifier
+                    ]
+        del data['extra axis options'][tick_label_text_width_identifier]
 
-        if len(major_tick_labels) == 0:
-            return None
+    label_style = ""
 
-        tick_labels_rotation = \
-            [label.get_rotation() for label in major_tick_labels]
-        tick_labels_rotation_same_value = len(set(tick_labels_rotation)) == 1
+    major_tick_labels = \
+        obj.xaxis.get_majorticklabels() if axes_obj == 'x' \
+        else obj.yaxis.get_majorticklabels()
 
-        tick_labels_horizontal_alignment = \
-            [label.get_horizontalalignment() for label in major_tick_labels]
-        tick_labels_horizontal_alignment_same_value = \
-            len(set(tick_labels_horizontal_alignment)) == 1
+    if not major_tick_labels:
+        return None
 
-        if tick_labels_rotation_same_value and \
-                tick_labels_horizontal_alignment_same_value:
-            values = []
+    tick_labels_rotation = \
+        [label.get_rotation() for label in major_tick_labels]
+    tick_labels_rotation_same_value = len(set(tick_labels_rotation)) == 1
 
-            if any(tick_labels_rotation) != 0:
-                values.append('rotate=%d' % tick_labels_rotation[0])
+    tick_labels_horizontal_alignment = \
+        [label.get_horizontalalignment() for label in major_tick_labels]
+    tick_labels_horizontal_alignment_same_value = \
+        len(set(tick_labels_horizontal_alignment)) == 1
 
-            if tick_label_text_width:
-                values.append('align=%s' % tick_labels_horizontal_alignment[0])
-                values.append('text width=%s' % tick_label_text_width)
-            else:
-                print('Horizontal alignment will be ignored as no \'%s tick '
-                      'label text width\' has been passed in the \'extra\' '
-                      'parameter' % axes)
+    if tick_labels_rotation_same_value and \
+            tick_labels_horizontal_alignment_same_value:
+        values = []
+
+        if any(tick_labels_rotation) != 0:
+            values.append('rotate=%d' % tick_labels_rotation[0])
 
-            if len(values) > 0:
-                label_style = \
-                    '%sticklabel style = {%s}' % (axes, ','.join(values))
+        if tick_label_text_width:
+            values.append('align=%s' % tick_labels_horizontal_alignment[0])
+            values.append('text width=%s' % tick_label_text_width)
         else:
-            values = []
+            print('Horizontal alignment will be ignored as no \'%s tick '
+                  'label text width\' has been passed in the \'extra\' '
+                  'parameter' % axes_obj)
 
-            if tick_labels_rotation_same_value:
-                values.append('rotate=%d' % tick_labels_rotation[0])
-            else:
-                values.append('rotate={%s,0}[\\ticknum]'
-                              % ','.join(str(x) for x in tick_labels_rotation))
-
-            if tick_label_text_width:
-                if tick_labels_horizontal_alignment_same_value:
-                    values.append('align=%s' %
-                                  tick_labels_horizontal_alignment[0])
-                    values.append('text width=%s' % tick_label_text_width)
-                else:
-                    for idx, x in enumerate(tick_labels_horizontal_alignment):
-                        label_style += '%s_tick_label_ha_%d/.initial = %s' \
-                            % (axes, idx, x)
-
-                    values.append(
-                        'align=\pgfkeysvalueof{/pgfplots/'
-                        '%s_tick_label_ha_\\ticknum}' % axes)
-                    values.append('text width=%s' % tick_label_text_width)
+        if values:
+            label_style = \
+                '%sticklabel style = {%s}' % (axes_obj, ','.join(values))
+    else:
+        values = []
+
+        if tick_labels_rotation_same_value:
+            values.append('rotate=%d' % tick_labels_rotation[0])
+        else:
+            values.append('rotate={%s,0}[\\ticknum]'
+                          % ','.join(str(x) for x in tick_labels_rotation))
+
+        if tick_label_text_width:
+            if tick_labels_horizontal_alignment_same_value:
+                values.append('align=%s' %
+                              tick_labels_horizontal_alignment[0])
+                values.append('text width=%s' % tick_label_text_width)
             else:
-                print('Horizontal alignment will be ignored as no \'%s tick '
-                      'label text width\' has been passed in the \'extra\' '
-                      'parameter' % axes)
+                for idx, x in enumerate(tick_labels_horizontal_alignment):
+                    label_style += '%s_tick_label_ha_%d/.initial = %s' \
+                        % (axes_obj, idx, x)
 
-            label_style = 'every %s tick label/.style = {\n' \
-                '%s\n' \
-                '}' % (axes, ',\n'.join(values))
+                values.append(
+                    'align=\\pgfkeysvalueof{/pgfplots/'
+                    '%s_tick_label_ha_\\ticknum}' % axes_obj
+                    )
+                values.append('text width=%s' % tick_label_text_width)
+        else:
+            print(
+                'Horizontal alignment will be ignored as no \'%s tick '
+                'label text width\' has been passed in the \'extra\' '
+                'parameter' % axes_obj
+                )
 
-        return label_style
+        label_style = 'every %s tick label/.style = {\n' \
+            '%s\n' \
+            '}' % (axes_obj, ',\n'.join(values))
 
-    def __get_tick_position(self, obj, data, axes):
-        major_ticks = obj.xaxis.majorTicks if axes == 'x' else \
-            obj.yaxis.majorTicks
+    return label_style
 
-        major_ticks_bottom = [tick.tick1On for tick in major_ticks]
-        major_ticks_top = [tick.tick2On for tick in major_ticks]
 
-        major_ticks_bottom_show_all = False
-        if len(set(major_ticks_bottom)) == 1 and major_ticks_bottom[0] is True:
-            major_ticks_bottom_show_all = True
+def _get_tick_position(obj, axes_obj):
+    major_ticks = obj.xaxis.majorTicks if axes_obj == 'x' else \
+        obj.yaxis.majorTicks
 
-        major_ticks_top_show_all = False
-        if len(set(major_ticks_top)) == 1 and major_ticks_top[0] is True:
-            major_ticks_top_show_all = True
+    major_ticks_bottom = [tick.tick1On for tick in major_ticks]
+    major_ticks_top = [tick.tick2On for tick in major_ticks]
 
-        major_ticks_position = None
-        if not major_ticks_bottom_show_all and not major_ticks_top_show_all:
-            position_string = "%smajorticks=false" % axes
-        elif major_ticks_bottom_show_all and major_ticks_top_show_all:
-            major_ticks_position = 'both'
-        elif major_ticks_bottom_show_all:
-            major_ticks_position = 'left'
-        elif major_ticks_top_show_all:
-            major_ticks_position = 'right'
+    major_ticks_bottom_show_all = False
+    if len(set(major_ticks_bottom)) == 1 and major_ticks_bottom[0] is True:
+        major_ticks_bottom_show_all = True
 
-        if major_ticks_position:
-            position_string = "%stick pos=%s" % (axes, major_ticks_position)
+    major_ticks_top_show_all = False
+    if len(set(major_ticks_top)) == 1 and major_ticks_top[0] is True:
+        major_ticks_top_show_all = True
 
-        return position_string, major_ticks_position
+    major_ticks_position = None
+    if not major_ticks_bottom_show_all and not major_ticks_top_show_all:
+        position_string = "%smajorticks=false" % axes_obj
+    elif major_ticks_bottom_show_all and major_ticks_top_show_all:
+        major_ticks_position = 'both'
+    elif major_ticks_bottom_show_all:
+        major_ticks_position = 'left'
+    elif major_ticks_top_show_all:
+        major_ticks_position = 'right'
 
-    def get_begin_code(self):
-        content = self.content
-        if self.axis_options:
-            content.append('[\n' + ',\n'.join(self.axis_options) + '\n]\n')
-        return content
+    if major_ticks_position:
+        position_string = \
+            "%stick pos=%s" % (axes_obj, major_ticks_position)
 
-    def get_end_code(self, data):
-        if not self.is_subplot:
-            return '\\end{axis}\n\n'
-        elif self.is_subplot and self.nsubplots == self.subplot_index:
-            data['is_in_groupplot_env'] = False
-            return '\\end{groupplot}\n\n'
-        else:
-            return ''
+    return position_string, major_ticks_position
 
 
 def _get_ticks(data, xy, ticks, ticklabels):
@@ -613,6 +624,7 @@ def _handle_linear_segmented_color_map(cmap):
     # Label the 3 elements in each row in the cdict entry for a given color as
     # (x, y0, y1).  Then for values of x between x[i] and x[i+1] the color
     # value is interpolated between y1[i] and y0[i+1].
+    # pylint: disable=protected-access
     segdata = cmap._segmentdata
     red = segdata['red']
     green = segdata['green']
@@ -721,16 +733,16 @@ def _handle_listed_color_map(cmap):
     if cmap.N is None or cmap.N == len(cmap.colors):
         colors = [
             'rgb(%d%s)=(%.15g,%.15g,%.15g)'
-            % (k, unit, color[0], color[1], color[2])
-            for (k, color) in enumerate(cmap.colors)
+            % (k, unit, rgb[0], rgb[1], rgb[2])
+            for (k, rgb) in enumerate(cmap.colors)
             ]
     else:
         reps = int(float(cmap.N) / len(cmap.colors) - 0.5) + 1
         repeated_cols = reps * cmap.colors
         colors = [
             'rgb(%d%s)=(%.15g,%.15g,%.15g)'
-            % (k, unit, color[0], color[1], color[2])
-            for (k, color) in enumerate(repeated_cols[:cmap.N])
+            % (k, unit, rgb[0], rgb[1], rgb[2])
+            for (k, rgb) in enumerate(repeated_cols[:cmap.N])
             ]
 
     colormap_string = '{mymap}{[1%s]\n  %s\n}' % \

matplotlib2tikz/color.py

@@ -17,7 +17,7 @@ def mpl_color2xcolor(data, matplotlib_color):
         'red':  numpy.array([1, 0, 0]),
         'green': numpy.array([0, 1, 0]),
         'blue': numpy.array([0, 0, 1]),
-        'brown': numpy.array([0.75, 0.5,  0.25]),
+        'brown': numpy.array([0.75, 0.5, 0.25]),
         'lime': numpy.array([0.75, 1, 0]),
         'orange': numpy.array([1, 0.5, 0]),
         'pink': numpy.array([1, 0.75, 0.75]),
@@ -60,7 +60,7 @@ def mpl_color2xcolor(data, matplotlib_color):
 
         # The cases 0.0 (my_col == black) and 1.0 (my_col == rgb) are
         # already accounted for by checking in available_colors above.
-        if all(my_col[:3] == alpha * rgb) and 0.0 < alpha and alpha < 1.0:
+        if all(my_col[:3] == alpha * rgb) and 0.0 < alpha < 1.0:
             xcol = name + ('!%r!black' % (alpha * 100))
             return data, xcol, my_col