Merge pull request matplotlib#9124 from anntzer/savefig

MNT: Use savefig instead of print_figure in GUIs when save button is pressed

Author: tacaswell

examples/api/agg_oo_sgskip.py

@@ -3,18 +3,21 @@
 The object-oriented interface
 =============================
 
-A pure OO (look Ma, no pylab!) example using the agg backend
-
+A pure OO (look Ma, no pyplot!) example using the agg backend.
 """
+
 from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
 from matplotlib.figure import Figure
 
 fig = Figure()
-canvas = FigureCanvas(fig)
+# A canvas must be manually attached to the figure (pyplot would automatically
+# do it).  This is done by instanciating the canvas with the figure as
+# argument.
+FigureCanvas(fig)
 ax = fig.add_subplot(111)
 ax.plot([1, 2, 3])
 ax.set_title('hi mom')
 ax.grid(True)
 ax.set_xlabel('time')
 ax.set_ylabel('volts')
-canvas.print_figure('test')
+fig.savefig('test')

examples/misc/hyperlinks_sgskip.py

@@ -20,7 +20,7 @@
 f = plt.figure()
 s = plt.scatter([1, 2, 3], [4, 5, 6])
 s.set_urls(['http://www.bbc.co.uk/news', 'http://www.google.com', None])
-f.canvas.print_figure('scatter.svg')
+f.savefig('scatter.svg')
 
 ###############################################################################
 
@@ -36,4 +36,4 @@
                 origin='lower', extent=[-3, 3, -3, 3])
 
 im.set_url('http://www.google.com')
-f.canvas.print_figure('image.svg')
+f.savefig('image.svg')

examples/user_interfaces/embedding_webagg_sgskip.py

@@ -153,7 +153,7 @@ def get(self, fmt):
             self.set_header('Content-Type', mimetypes.get(fmt, 'binary'))
 
             buff = io.BytesIO()
-            manager.canvas.print_figure(buff, format=fmt)
+            manager.canvas.figure.savefig(buff, format=fmt)
             self.write(buff.getvalue())
 
     class WebSocket(tornado.websocket.WebSocketHandler):

lib/matplotlib/backend_bases.py

@@ -2303,7 +2303,7 @@ def get_default_filename(self):
         default_filetype = self.get_default_filetype()
         default_filename = default_basename + '.' + default_filetype
 
-        save_dir = os.path.expanduser(rcParams.get('savefig.directory', ''))
+        save_dir = os.path.expanduser(rcParams['savefig.directory'])
 
         # ensure non-existing filename in save dir
         i = 1

lib/matplotlib/backends/backend_gtk.py

@@ -707,7 +707,7 @@ def get_filechooser(self):
         fc = FileChooserDialog(
             title='Save the figure',
             parent=self.win,
-            path=os.path.expanduser(rcParams.get('savefig.directory', '')),
+            path=os.path.expanduser(rcParams['savefig.directory']),
             filetypes=self.canvas.get_supported_filetypes(),
             default_filetype=self.canvas.get_default_filetype())
         fc.set_current_name(self.canvas.get_default_filename())
@@ -718,15 +718,12 @@ def save_figure(self, *args):
         fname, format = chooser.get_filename_from_user()
         chooser.destroy()
         if fname:
-            startpath = os.path.expanduser(rcParams.get('savefig.directory', ''))
-            if startpath == '':
-                # explicitly missing key or empty str signals to use cwd
-                rcParams['savefig.directory'] = startpath
-            else:
-                # save dir for next time
-                rcParams['savefig.directory'] = os.path.dirname(six.text_type(fname))
+            # Save dir for next time, unless empty str (i.e., use cwd).
+            if startpath != "":
+                rcParams['savefig.directory'] = (
+                    os.path.dirname(six.text_type(fname)))
             try:
-                self.canvas.print_figure(fname, format=format)
+                self.canvas.figure.savefig(fname, format=format)
             except Exception as e:
                 error_msg_gtk(str(e), parent=self)
 

lib/matplotlib/backends/backend_gtk3.py

@@ -561,7 +561,7 @@ def get_filechooser(self):
         fc = FileChooserDialog(
             title='Save the figure',
             parent=self.win,
-            path=os.path.expanduser(rcParams.get('savefig.directory', '')),
+            path=os.path.expanduser(rcParams['savefig.directory']),
             filetypes=self.canvas.get_supported_filetypes(),
             default_filetype=self.canvas.get_default_filetype())
         fc.set_current_name(self.canvas.get_default_filename())
@@ -572,15 +572,13 @@ def save_figure(self, *args):
         fname, format = chooser.get_filename_from_user()
         chooser.destroy()
         if fname:
-            startpath = os.path.expanduser(rcParams.get('savefig.directory', ''))
-            if startpath == '':
-                # explicitly missing key or empty str signals to use cwd
-                rcParams['savefig.directory'] = startpath
-            else:
-                # save dir for next time
-                rcParams['savefig.directory'] = os.path.dirname(six.text_type(fname))
+            startpath = os.path.expanduser(rcParams['savefig.directory'])
+            # Save dir for next time, unless empty str (i.e., use cwd).
+            if startpath != "":
+                rcParams['savefig.directory'] = (
+                    os.path.dirname(six.text_type(fname)))
             try:
-                self.canvas.print_figure(fname, format=format)
+                self.canvas.figure.savefig(fname, format=format)
             except Exception as e:
                 error_msg_gtk(str(e), parent=self)
 
@@ -814,7 +812,7 @@ def get_filechooser(self):
         fc = FileChooserDialog(
             title='Save the figure',
             parent=self.figure.canvas.manager.window,
-            path=os.path.expanduser(rcParams.get('savefig.directory', '')),
+            path=os.path.expanduser(rcParams['savefig.directory']),
             filetypes=self.figure.canvas.get_supported_filetypes(),
             default_filetype=self.figure.canvas.get_default_filetype())
         fc.set_current_name(self.figure.canvas.get_default_filename())
@@ -825,8 +823,7 @@ def trigger(self, *args, **kwargs):
         fname, format_ = chooser.get_filename_from_user()
         chooser.destroy()
         if fname:
-            startpath = os.path.expanduser(
-                rcParams.get('savefig.directory', ''))
+            startpath = os.path.expanduser(rcParams['savefig.directory'])
             if startpath == '':
                 # explicitly missing key or empty str signals to use cwd
                 rcParams['savefig.directory'] = startpath

lib/matplotlib/backends/backend_macosx.py

@@ -192,7 +192,7 @@ def save_figure(self, *args):
                                             self.canvas.get_default_filename())
         if filename is None: # Cancel
             return
-        self.canvas.print_figure(filename)
+        self.canvas.figure.savefig(filename)
 
     def prepare_configure_subplots(self):
         toolfig = Figure(figsize=(6,3))

lib/matplotlib/backends/backend_qt5.py

@@ -725,8 +725,8 @@ def save_figure(self, *args):
         sorted_filetypes = sorted(six.iteritems(filetypes))
         default_filetype = self.canvas.get_default_filetype()
 
-        startpath = matplotlib.rcParams.get('savefig.directory', '')
-        startpath = os.path.expanduser(startpath)
+        startpath = os.path.expanduser(
+            matplotlib.rcParams['savefig.directory'])
         start = os.path.join(startpath, self.canvas.get_default_filename())
         filters = []
         selectedFilter = None
@@ -742,15 +742,12 @@ def save_figure(self, *args):
                                          "Choose a filename to save to",
                                          start, filters, selectedFilter)
         if fname:
-            if startpath == '':
-                # explicitly missing key or empty str signals to use cwd
-                matplotlib.rcParams['savefig.directory'] = startpath
-            else:
-                # save dir for next time
-                savefig_dir = os.path.dirname(six.text_type(fname))
-                matplotlib.rcParams['savefig.directory'] = savefig_dir
+            # Save dir for next time, unless empty str (i.e., use cwd).
+            if startpath != "":
+                matplotlib.rcParams['savefig.directory'] = (
+                    os.path.dirname(six.text_type(fname)))
             try:
-                self.canvas.print_figure(six.text_type(fname))
+                self.canvas.figure.savefig(six.text_type(fname))
             except Exception as e:
                 QtWidgets.QMessageBox.critical(
                     self, "Error saving file", six.text_type(e),

lib/matplotlib/backends/backend_tkagg.py

@@ -768,8 +768,7 @@ def save_figure(self, *args):
         # work - JDH!
         #defaultextension = self.canvas.get_default_filetype()
         defaultextension = ''
-        initialdir = rcParams.get('savefig.directory', '')
-        initialdir = os.path.expanduser(initialdir)
+        initialdir = os.path.expanduser(rcParams['savefig.directory'])
         initialfile = self.canvas.get_default_filename()
         fname = tkinter_tkfiledialog.asksaveasfilename(
             master=self.window,
@@ -780,20 +779,17 @@ def save_figure(self, *args):
             initialfile=initialfile,
             )
 
-        if fname == "" or fname == ():
+        if fname in ["", ()]:
             return
-        else:
-            if initialdir == '':
-                # explicitly missing key or empty str signals to use cwd
-                rcParams['savefig.directory'] = initialdir
-            else:
-                # save dir for next time
-                rcParams['savefig.directory'] = os.path.dirname(six.text_type(fname))
-            try:
-                # This method will handle the delegation to the correct type
-                self.canvas.print_figure(fname)
-            except Exception as e:
-                tkinter_messagebox.showerror("Error saving file", str(e))
+        # Save dir for next time, unless empty str (i.e., use cwd).
+        if initialdir != "":
+            rcParams['savefig.directory'] = (
+                os.path.dirname(six.text_type(fname)))
+        try:
+            # This method will handle the delegation to the correct type
+            self.canvas.figure.savefig(fname)
+        except Exception as e:
+            tkinter_messagebox.showerror("Error saving file", str(e))
 
     def set_active(self, ind):
         self._ind = ind
@@ -984,8 +980,7 @@ def trigger(self, *args):
         # work - JDH!
         # defaultextension = self.figure.canvas.get_default_filetype()
         defaultextension = ''
-        initialdir = rcParams.get('savefig.directory', '')
-        initialdir = os.path.expanduser(initialdir)
+        initialdir = os.path.expanduser(rcParams['savefig.directory'])
         initialfile = self.figure.canvas.get_default_filename()
         fname = tkinter_tkfiledialog.asksaveasfilename(
             master=self.figure.canvas.manager.window,
@@ -1008,7 +1003,7 @@ def trigger(self, *args):
                     six.text_type(fname))
             try:
                 # This method will handle the delegation to the correct type
-                self.figure.canvas.print_figure(fname)
+                self.figure.savefig(fname)
             except Exception as e:
                 tkinter_messagebox.showerror("Error saving file", str(e))
 

lib/matplotlib/backends/backend_webagg.py

@@ -151,7 +151,7 @@ def get(self, fignum, fmt):
             self.set_header('Content-Type', mimetypes.get(fmt, 'binary'))
 
             buff = six.BytesIO()
-            manager.canvas.print_figure(buff, format=fmt)
+            manager.canvas.figure.savefig(buff, format=fmt)
             self.write(buff.getvalue())
 
     class WebSocket(tornado.websocket.WebSocketHandler):