Cleaned up code to get it ready for PR.

dkua · dkua · commit 6169f0cf133c · 2015-04-01T23:41:17.000Z
* FancyCell renamed to CustomCell.
* Missing variables removed.
* Variables renamed to fit style better.
* Test changed to use single image instead of three separate ones.
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -147,51 +147,55 @@ def set_text_props(self, **kwargs):
         self._text.update(kwargs)
 
 
-class FancyCell(Cell):
+class CustomCell(Cell):
     """
-    A subclass of Cell where vertical and horizontal lines may
-    be selectively ommited.
+    A subclass of Cell where the sides may be visibly toggled.
+
     """
 
-    def __init__(self, xy, width, height,
-                 edgecolor='k', facecolor='w',
-                 fill=True,
-                 text='',
-                 loc=None,
-                 fontproperties=None,
-                 edgeVisibility="LRBT"
-                 ):
-        Cell.__init__(self, xy, width, height, edgecolor, facecolor, fill,
-                text, loc, fontproperties)
-        for letter in edgeVisibility:
-            if letter not in "LRBT":
-                msg = ('Invalid edgeVisibility params for FancyCell:' +
-                      '{0}, must only consist of {1}.').format(
-                        value,
-                        ", ".join({'T', 'B', 'L', 'R'}),
-                        )
-                raise ValueError(msg)
-        self._edgeVisibility = edgeVisibility
+    EDGES = 'BRTL'
+    EDGE_ALIASES = {'open':         '',
+                    'closed':       EDGES,  # default
+                    'horizontal':   'BT',
+                    'vertical':     'RL'
+                    }
+
+    def __init__(self, *args, **kwargs):
+
+        visible_edges = kwargs.pop('visible_edges')
+        Cell.__init__(self, *args, **kwargs)
+
+        if visible_edges is None:
+            self._visible_edges = self.EDGES
+        elif visible_edges in self.EDGE_ALIASES:
+            self._visible_edges = self.EDGE_ALIASES[visible_edges]
+        else:
+            for edge in visible_edges:
+                if edge not in self.EDGES:
+                    msg = 'Invalid edge param {0}, must only be one of {1} or \
+                            string of {2}.'.format(
+                                    visible_edges,
+                                    ", ".join(self.EDGE_ALIASES.keys()),
+                                    ", ".join(self.EDGES),
+                                    )
+                    raise ValueError(msg)
+            self._visible_edges = visible_edges
 
     def get_path(self):
-        'Return a path where the edges specificed by edgeVisibility are drawn'
-        edgeCodes = [Path.MOVETO, Path.MOVETO, Path.MOVETO,
-                     Path.MOVETO, Path.MOVETO]
-        if 'B' in self._edgeVisibility:
-            edgeCodes[1] = Path.LINETO
-        if 'R' in self._edgeVisibility:
-            edgeCodes[2] = Path.LINETO
-        if 'T' in self._edgeVisibility:
-            edgeCodes[3] = Path.LINETO
-        if 'L' in self._edgeVisibility:
-            edgeCodes[4] = Path.LINETO
-
-        path = Path([[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [0.0, 1.0],
-                    [0.0, 0.0]],
-                    edgeCodes,
-                    readonly=True
-                    )
-        return path
+        'Return a path where the edges specificed by _visible_edges are drawn'
+
+        codes = [Path.MOVETO] * 4
+        codes.append(Path.CLOSEPOLY)
+
+        for i, edge in enumerate(self.EDGES, 1):
+            if edge in self._visible_edges:
+                codes[i] = Path.LINETO
+
+        return Path(
+                [[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [0.0, 1.0], [0.0, 0.0]],
+                codes,
+                readonly=True
+                )
 
 
 class Table(Artist):
@@ -227,12 +231,6 @@ class Table(Artist):
              'bottom':       17,
              }
 
-    DRAWLINE_ALIASES = {'open':         '',
-                        'closed':       'LRBT',  # default
-                        'horizontal':   'TB',
-                        'vertical':     'LR'
-                        }
-
     FONTSIZE = 10
     AXESPAD = 0.02    # the border between the axes and table edge
 
@@ -257,7 +255,7 @@ def __init__(self, ax, loc=None, bbox=None, **kwargs):
 
         self._texts = []
         self._cells = {}
-        self._drawLines = "LTRB"
+        self._drawLines = None
         self._autoRows = []
         self._autoColumns = []
         self._autoFontsize = True
@@ -271,7 +269,7 @@ def add_cell(self, row, col, *args, **kwargs):
         """ Add a cell to the table. """
         xy = (0, 0)
 
-        cell = FancyCell(xy, edgeVisibility=self._drawLines, *args, **kwargs)
+        cell = CustomCell(xy, visible_edges=self._drawLines, *args, **kwargs)
         cell.set_figure(self.figure)
         cell.set_transform(self.get_transform())
 
@@ -284,21 +282,7 @@ def drawLines(self):
 
     @drawLines.setter
     def drawLines(self, value):
-        if value is None:
-            pass  # Leave as previously set
-        elif value in self.DRAWLINE_ALIASES.keys():
-            self._drawLines = self.DRAWLINE_ALIASES[value]
-        else:
-            for letter in value:
-                if letter not in "LRBT":
-                    msg = ('Unrecognized draw lines for Cell:' +
-                           ' {0}, must be one of {1}.').format(
-                            value,
-                            ", ".join({'open', 'closed', 'horizontal',
-                            'vertical', 'string consisting of {T, B, R, L}'}),
-                            )
-                    raise ValueError(msg)
-            self._drawLines = value
+        self._drawLines = value
 
     def _approx_text_height(self):
         return (self.FONTSIZE / 72.0 * self.figure.dpi /
@@ -536,14 +520,14 @@ def table(ax,
           cellLoc='right', colWidths=None,
           rowLabels=None, rowColours=None, rowLoc='left',
           colLabels=None, colColours=None, colLoc='center',
-          loc='bottom', bbox=None, drawLines='LRBT',
+          loc='bottom', bbox=None, drawLines='BRTL',
           **kwargs):
     """
     TABLE(cellText=None, cellColours=None,
           cellLoc='right', colWidths=None,
           rowLabels=None, rowColours=None, rowLoc='left',
           colLabels=None, colColours=None, colLoc='center',
-          loc='bottom', bbox=None, drawLines='LRBT')
+          loc='bottom', bbox=None, drawLines='BRTL')
 
     Factory function to generate a Table instance.
 
