Merge pull request #4677 from jhamrick/set-fig-size

tacaswell · tacaswell · commit 7285c4ce1e9f · 2015-07-14T23:23:47.000-04:00
MNT: Set figure width and height with set_size_inches
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -659,7 +659,7 @@ def figimage(self, X,
         self.stale = True
         return im
 
-    def set_size_inches(self, *args, **kwargs):
+    def set_size_inches(self, w, h=None, forward=False):
         """
         set_size_inches(w,h, forward=False)
 
@@ -682,11 +682,10 @@ def set_size_inches(self, *args, **kwargs):
         matplotlib.Figure.get_size_inches
         """
 
-        forward = kwargs.get('forward', False)
-        if len(args) == 1:
-            w, h = args[0]
-        else:
-            w, h = args
+        # the width and height have been passed in as a tuple to the first
+        # argument, so unpack them
+        if h is None:
+            w, h = w
 
         dpival = self.dpi
         self.bbox_inches.p1 = w, h
@@ -766,23 +765,21 @@ def set_dpi(self, val):
         self.dpi = val
         self.stale = True
 
-    def set_figwidth(self, val):
+    def set_figwidth(self, val, forward=False):
         """
         Set the width of the figure in inches
 
         ACCEPTS: float
         """
-        self.bbox_inches.x1 = val
-        self.stale = True
+        self.set_size_inches(val, self.get_figheight(), forward=forward)
 
-    def set_figheight(self, val):
+    def set_figheight(self, val, forward=False):
         """
         Set the height of the figure in inches
 
         ACCEPTS: float
         """
-        self.bbox_inches.y1 = val
-        self.stale = True
+        self.set_size_inches(self.get_figwidth(), val, forward=forward)
 
     def set_frameon(self, b):
         """
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -158,6 +158,29 @@ def _as_mpl_axes(self):
     plt.close(fig)
 
 
+@cleanup
+def test_set_fig_size():
+    fig = plt.figure()
+
+    # check figwidth
+    fig.set_figwidth(5)
+    assert_equal(fig.get_figwidth(), 5)
+
+    # check figheight
+    fig.set_figheight(1)
+    assert_equal(fig.get_figheight(), 1)
+
+    # check using set_size_inches
+    fig.set_size_inches(2, 4)
+    assert_equal(fig.get_figwidth(), 2)
+    assert_equal(fig.get_figheight(), 4)
+
+    # check using tuple to first argument
+    fig.set_size_inches((1, 3))
+    assert_equal(fig.get_figwidth(), 1)
+    assert_equal(fig.get_figheight(), 3)
+
+
 if __name__ == "__main__":
     import nose
     nose.runmodule(argv=['-s', '--with-doctest'], exit=False)
