Fixes after review

jklymak · jklymak · commit 536dcaedaa07 · 2018-01-25T09:56:58.000-08:00
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -219,7 +219,7 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad,
                     ax.set_frame_on(False)
                     ax.set_xticks([])
                     ax.set_yticks([])
-                    ax.set_facecolor((1., 0., 0., 0.))
+                    ax.set_facecolor((1, 0, 0, 0))
 
     # for each axes, make a margin between the *pos* layoutbox and the
     # *axes* layoutbox be a minimum size that can accomodate the
@@ -252,15 +252,15 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad,
             # or width.  This stops that...  It *should* have been
             # taken into account w/ pref_width...
             if fig._layoutbox.constrained_layout_called < 1:
-                ax._poslayoutbox.constrain_height_min(20., strength='weak')
-                ax._poslayoutbox.constrain_width_min(20., strength='weak')
-                ax._layoutbox.constrain_height_min(20., strength='weak')
-                ax._layoutbox.constrain_width_min(20., strength='weak')
-                ax._poslayoutbox.constrain_top_margin(0., strength='weak')
-                ax._poslayoutbox.constrain_bottom_margin(0.,
+                ax._poslayoutbox.constrain_height_min(20, strength='weak')
+                ax._poslayoutbox.constrain_width_min(20, strength='weak')
+                ax._layoutbox.constrain_height_min(20, strength='weak')
+                ax._layoutbox.constrain_width_min(20, strength='weak')
+                ax._poslayoutbox.constrain_top_margin(0, strength='weak')
+                ax._poslayoutbox.constrain_bottom_margin(0,
                         strength='weak')
-                ax._poslayoutbox.constrain_right_margin(0., strength='weak')
-                ax._poslayoutbox.constrain_left_margin(0., strength='weak')
+                ax._poslayoutbox.constrain_right_margin(0, strength='weak')
+                ax._poslayoutbox.constrain_left_margin(0, strength='weak')
 
     # do layout for suptitle.
     if fig._suptitle is not None:
@@ -285,8 +285,7 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad,
         # parent gridspec.  The ones that contain axes are not so constrained.
         figlb = fig._layoutbox
         for child in figlb.children:
-            name = (child.name).split('.')[-1][:-3]
-            if name == 'gridspec':
+            if child._is_gridspec_layoutbox():
                 # farm the gridspec layout out.
                 #
                 # This routine makes all the subplot spec containers
@@ -437,8 +436,7 @@ def arange_subplotspecs(gs, hspace=0, wspace=0):
     """
     sschildren = []
     for child in gs.children:
-        name = (child.name).split('.')[-1][:-3]
-        if name == 'ss':
+        if child._is_subplotspec_layoutbox():
             for child2 in child.children:
                 # check for gridspec children...
                 name = (child2.name).split('.')[-1][:-3]
@@ -513,10 +511,10 @@ def layoutcolorbarsingle(ax, cax, shrink, aspect, location, pad=0.05):
         else:
             layoutbox.hstack([lb, axlb], padding=pad * axlb.width)
         # constrain the height and center...
-        layoutbox.match_heights([axpos, lbpos], [1., shrink])
+        layoutbox.match_heights([axpos, lbpos], [1, shrink])
         layoutbox.align([axpos, lbpos], 'v_center')
         # set the width of the pos box
-        lbpos.constrain_width(shrink * axpos.height * (1./aspect),
+        lbpos.constrain_width(shrink * axpos.height * (1/aspect),
                               strength='strong')
     elif location in ('bottom', 'top'):
         lbpos = layoutbox.LayoutBox(
@@ -533,7 +531,7 @@ def layoutcolorbarsingle(ax, cax, shrink, aspect, location, pad=0.05):
             layoutbox.vstack([lb, axlb], padding=pad * axlb.height)
         # constrain the height and center...
         layoutbox.match_widths([axpos, lbpos],
-                               [1., shrink], strength='strong')
+                               [1, shrink], strength='strong')
         layoutbox.align([axpos, lbpos], 'h_center')
         # set the height of the pos box
         lbpos.constrain_height(axpos.width * aspect * shrink,
@@ -605,7 +603,7 @@ def layoutcolorbargridspec(parents, cax, shrink, aspect, location, pad=0.05):
                 shrink, strength='strong')
         lbpos.constrain_bottom(
                 (maxposlb.top - minposlb.bottom) *
-                (1. - shrink)/2. + minposlb.bottom,
+                (1 - shrink)/2 + minposlb.bottom,
                 strength='strong')
 
         # set the width of the pos box
@@ -647,7 +645,7 @@ def layoutcolorbargridspec(parents, cax, shrink, aspect, location, pad=0.05):
                               shrink)
         lbpos.constrain_left(
                 (maxposlb.right - minposlb.left) *
-                (1.-shrink)/2. + minposlb.left)
+                (1-shrink)/2 + minposlb.left)
         # set the height of the pos box
         lbpos.constrain_height(lbpos.width * shrink * aspect,
                                strength='medium')
diff --git a/lib/matplotlib/_layoutbox.py b/lib/matplotlib/_layoutbox.py
@@ -353,6 +353,26 @@ def constrain_top(self, top, strength='strong'):
         c = (self.top == top)
         self.solver.addConstraint(c | strength)
 
+    def _is_subplotspec_layoutbox(self):
+        '''
+        Helper to check if this layoutbox is the layoutbox of a
+        subplotspec
+        '''
+        name = (self.name).split('.')[-1][:-3]
+        if name == 'ss':
+            return True
+        return False
+
+    def _is_gridspec_layoutbox(self):
+        '''
+        Helper to check if this layoutbox is the layoutbox of a
+        gridspec
+        '''
+        name = (self.name).split('.')[-1][:-3]
+        if name == 'gridspec':
+            return True
+        return False
+
     def find_child_subplots(self):
         '''
         Find children of this layout box that are subplots.  We want to line
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -389,11 +389,6 @@ def __init__(self,
         # constrained_layout:
         self._layoutbox = None
         # set in set_constrained_layout_pads()
-        self._constrained_layout_pads = dict()
-        self._constrained_layout_pads['w_pad'] = None
-        self._constrained_layout_pads['h_pad'] = None
-        self._constrained_layout_pads['wspace'] = None
-        self._constrained_layout_pads['hspace'] = None
         self.set_constrained_layout(constrained_layout)
 
         self.set_tight_layout(tight_layout)
@@ -540,19 +535,25 @@ def set_constrained_layout(self, constrained):
 
         See :doc:`/tutorials/intermediate/constrainedlayout_guide`
         """
+        self._constrained_layout_pads = dict()
+        self._constrained_layout_pads['w_pad'] = None
+        self._constrained_layout_pads['h_pad'] = None
+        self._constrained_layout_pads['wspace'] = None
+        self._constrained_layout_pads['hspace'] = None
         if constrained is None:
             constrained = rcParams['figure.constrained_layout.use']
         self._constrained = bool(constrained)
         if isinstance(constrained, dict):
-            self.set_constrained_layout_pads(padd=constrained)
+            self.set_constrained_layout_pads(**constrained)
         else:
             self.set_constrained_layout_pads()
 
         self.stale = True
 
     def set_constrained_layout_pads(self, **kwargs):
         """
-        Set padding for ``constrained_layout``.
+        Set padding for ``constrained_layout``.  Note the kwargs can be passed
+        as a dictionary ``fig.set_constrained_layout(**paddict)``.
 
         Parameters:
         -----------
@@ -573,31 +574,16 @@ def set_constrained_layout_pads(self, **kwargs):
             Height padding between subplots, expressed as a fraction of the
             subplot width. The total padding ends up being h_pad + hspace.
 
-        padd : dict
-            Dictionary with possible keywords as above.  If a keyword
-            is specified then it takes precedence over the dictionary.
-
         See :doc:`/tutorials/intermediate/constrainedlayout_guide`
         """
 
         todo = ['w_pad', 'h_pad', 'wspace', 'hspace']
-
-        if 'padd' in kwargs:
-            padd = kwargs['padd']
-        else:
-            padd = None
-
         for td in todo:
-            # default:
-            pad = rcParams['figure.constrained_layout.' + td]
-            if padd is not None and td in padd:
-                if padd[td] is not None:
-                    pad = padd[td]
-            if td in kwargs:
-                # kw arg override padd or rcParam
-                if kwargs[td] is not None:
-                    pad = kwargs[td]
-            self._constrained_layout_pads[td] = pad
+            if td in kwargs and kwargs[td] is not None:
+                self._constrained_layout_pads[td] = kwargs[td]
+            else:
+                self._constrained_layout_pads[td] = (
+                    rcParams['figure.constrained_layout.' + td])
 
     def get_constrained_layout_pads(self, relative=False):
         """
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -225,7 +225,7 @@ def __getstate__(self):
         state = self.__dict__
         try:
             state.pop('_layoutbox')
-        except:
+        except KeyError:
             pass
         return state
 
@@ -418,7 +418,7 @@ def __getstate__(self):
         state = self.__dict__
         try:
             state.pop('_layoutbox')
-        except:
+        except KeyError:
             pass
         return state
 
