Merge pull request #9090 from NelleV/savefig_improve_error_mesg

fariza · web-flow · commit a22617147418 · 2017-08-24T16:51:46.000-04:00
[MAINT] savefig only takes one args
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1709,7 +1709,7 @@ def add_axobserver(self, func):
         'whenever the axes state change, ``func(self)`` will be called'
         self._axobservers.append(func)
 
-    def savefig(self, *args, **kwargs):
+    def savefig(self, fname, **kwargs):
         """
         Save the current figure.
 
@@ -1787,7 +1787,6 @@ def savefig(self, *args, **kwargs):
             tight bbox is calculated.
 
         """
-
         kwargs.setdefault('dpi', rcParams['savefig.dpi'])
         frameon = kwargs.pop('frameon', rcParams['savefig.frameon'])
         transparent = kwargs.pop('transparent',
@@ -1811,7 +1810,7 @@ def savefig(self, *args, **kwargs):
             original_frameon = self.get_frameon()
             self.set_frameon(frameon)
 
-        self.canvas.print_figure(*args, **kwargs)
+        self.canvas.print_figure(fname, **kwargs)
 
         if frameon:
             self.set_frameon(original_frameon)
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -319,3 +319,10 @@ def test_subplots_shareax_loglabels():
 
     for ax in ax_arr[:, 0]:
         assert 0 < len(ax.yaxis.get_ticklabels(which='both'))
+
+
+def test_savefig():
+    fig, ax = plt.subplots()
+    msg = "savefig() takes 2 positional arguments but 3 were given"
+    with pytest.raises(TypeError, message=msg):
+        fig.savefig("fname1.png", "fname2.png")
