Added savefig.pad_inches; refactored savefig.bbox

oxling · oxling · commit 69dcec448614 · 2012-07-13T11:42:45.000-04:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1978,11 +1978,11 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
         *bbox_inches*
             Bbox in inches. Only the given portion of the figure is
             saved. If 'tight', try to figure out the tight bbox of
-            the figure.
+            the figure. If None, use savefig.bbox
 
         *pad_inches*
             Amount of padding around the figure when bbox_inches is
-            'tight'.
+            'tight'. If None, use savefig.pad_inches
 
         *bbox_extra_artists*
             A list of extra artists that will be considered when the
@@ -2013,7 +2013,10 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
         self.figure.set_facecolor(facecolor)
         self.figure.set_edgecolor(edgecolor)
 
-        bbox_inches = kwargs.pop("bbox_inches", rcParams['savefig.bbox'])
+        bbox_inches = kwargs.pop("bbox_inches", None)
+        if bbox_inches == None:
+            bbox_inches = rcParams['savefig.bbox']
+
 
         if bbox_inches:
             # call adjust_bbox to save only the given area
@@ -2054,8 +2057,10 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
 
                     bbox_inches = Bbox.union([bbox_inches, bbox_inches1])
 
+                pad = kwargs.pop("pad_inches", None)
+                if pad == None:
+                    pad = rcParams['savefig.pad_inches']
 
-                pad = kwargs.pop("pad_inches", 0.1)
                 bbox_inches = bbox_inches.padded(pad)
 
             restore_bbox = tight_bbox.adjust_bbox(self.figure, format,
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -328,11 +328,11 @@ def validate_hinting(s):
 def validate_bbox(s):
     if type(s) is str:
         s = s.lower()
-    if s in ('tight'):
-        return s
-    if s in ('auto'):
-        return None
-    raise ValueError("bbox_inches should be 'auto' or 'tight'")
+        if s == 'tight':
+            return s
+        if s == 'default':
+            return None
+        raise ValueError("bbox should be 'tight' or 'default'")
 
 
 
@@ -559,7 +559,8 @@ def __call__(self, s):
     'savefig.orientation' : ['portrait', validate_orientation],  # edgecolor; white
     'savefig.extension'   : ['png', deprecate_savefig_extension], # what to add to extensionless filenames
     'savefig.format'      : ['png', str], # value checked by backend at runtime
-    'savefig.bbox'        : [None, validate_bbox], # options are tight or auto. Auto validates to 'None'
+    'savefig.bbox'        : [None, validate_bbox], # options are 'tight', or 'default'. 'default' validates to None.
+    'savefig.pad_inches'  : [0.1, validate_float],
 
     'tk.window_focus'    : [False, validate_bool],  # Maintain shell focus for TkAgg
     'tk.pythoninspect'   : [False, validate_tkpythoninspect],  # obsolete
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -346,11 +346,12 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
 # the default savefig params can be different from the display params
 # Eg, you may want a higher resolution, or to make the figure
 # background white
-#savefig.dpi       : 100      # figure dots per inch
-#savefig.facecolor : white    # figure facecolor when saving
-#savefig.edgecolor : white    # figure edgecolor when saving
-#savefig.format    : png      # png, ps, pdf, svg
-#savefig.bbox      : auto     # tight, auto. When set to 'tight', will set the figure's bounding box to 'tight' and recalculate. When set to 'auto', it will use the automatic bounding box calculation.
+#savefig.dpi        : 100      # figure dots per inch
+#savefig.facecolor  : white    # figure facecolor when saving
+#savefig.edgecolor  : white    # figure edgecolor when saving
+#savefig.format     : png      # png, ps, pdf, svg
+#savefig.bbox       : default  # 'tight' or 'default'.
+#savefig.pad_inches : 0.1      # Padding to be used when bbox is set to 'tight'
 
 # tk backend params
 #tk.window_focus   : False    # Maintain shell focus for TkAgg
