Merge pull request #17032 from anntzer/ccell

timhoffm · web-flow · commit e55e79b97d0b · 2020-04-15T04:33:17.000+02:00
Fold table.CustomCell into Cell.
diff --git a/doc/api/api_changes_3.3/behaviour.rst b/doc/api/api_changes_3.3/behaviour.rst
@@ -171,3 +171,8 @@ The default method used to format `.Slider` values has been changed to use a
 values are displayed with an appropriate number of significant digits even if
 they are much smaller or much bigger than 1.  To restore the old behavior,
 explicitly pass a "%1.2f" as the *valfmt* parameter to `.Slider`.
+
+``table.CustomCell`` is now an alias for `.table.Cell`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+All the functionality of ``CustomCell`` has been moved to its base class
+`~.table.Cell`.
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -39,12 +39,21 @@ class Cell(Rectangle):
     PAD = 0.1
     """Padding between text and rectangle."""
 
+    _edges = 'BRTL'
+    _edge_aliases = {'open':         '',
+                     'closed':       _edges,  # default
+                     'horizontal':   'BT',
+                     'vertical':     'RL'
+                     }
+
     def __init__(self, xy, width, height,
                  edgecolor='k', facecolor='w',
                  fill=True,
                  text='',
                  loc=None,
-                 fontproperties=None
+                 fontproperties=None,
+                 *,
+                 visible_edges='closed',
                  ):
         """
         Parameters
@@ -68,12 +77,18 @@ def __init__(self, xy, width, height,
         fontproperties : dict
             A dict defining the font properties of the text. Supported keys and
             values are the keyword arguments accepted by `.FontProperties`.
+        visible_edges : str, default: 'closed'
+            The cell edges to be drawn with a line: a substring of 'BRTL'
+            (bottom, right, top, left), or one of 'open' (no edges drawn),
+            'closed' (all edges drawn), 'horizontal' (bottom and top),
+            'vertical' (right and left).
         """
 
         # Call base
         Rectangle.__init__(self, xy, width=width, height=height, fill=fill,
                            edgecolor=edgecolor, facecolor=facecolor)
         self.set_clip_on(False)
+        self.visible_edges = visible_edges
 
         # Create text object
         if loc is None:
@@ -167,23 +182,6 @@ def set_text_props(self, **kwargs):
         self._text.update(kwargs)
         self.stale = True
 
-
-class CustomCell(Cell):
-    """
-    A `.Cell` subclass with configurable edge visibility.
-    """
-
-    _edges = 'BRTL'
-    _edge_aliases = {'open':         '',
-                     'closed':       _edges,  # default
-                     'horizontal':   'BT',
-                     'vertical':     'RL'
-                     }
-
-    def __init__(self, *args, visible_edges, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.visible_edges = visible_edges
-
     @property
     def visible_edges(self):
         """
@@ -228,6 +226,9 @@ def get_path(self):
             )
 
 
+CustomCell = Cell  # Backcompat. alias.
+
+
 class Table(Artist):
     """
     A table of cells.
@@ -331,20 +332,20 @@ def add_cell(self, row, col, *args, **kwargs):
 
         Returns
         -------
-        `.CustomCell`
+        `.Cell`
             The created cell.
 
         """
         xy = (0, 0)
-        cell = CustomCell(xy, visible_edges=self.edges, *args, **kwargs)
+        cell = Cell(xy, visible_edges=self.edges, *args, **kwargs)
         self[row, col] = cell
         return cell
 
     def __setitem__(self, position, cell):
         """
         Set a custom cell in a given position.
         """
-        cbook._check_isinstance(CustomCell, cell=cell)
+        cbook._check_isinstance(Cell, cell=cell)
         try:
             row, col = position[0], position[1]
         except Exception as err:
@@ -363,7 +364,7 @@ def __getitem__(self, position):
     @property
     def edges(self):
         """
-        The default value of `~.CustomCell.visible_edges` for newly added
+        The default value of `~.Cell.visible_edges` for newly added
         cells using `.add_cell`.
 
         Notes
@@ -713,7 +714,7 @@ def table(ax,
 
     edges : substring of 'BRTL' or {'open', 'closed', 'horizontal', 'vertical'}
         The cell edges to be drawn with a line. See also
-        `~.CustomCell.visible_edges`.
+        `~.Cell.visible_edges`.
 
     Returns
     -------
