Merge pull request #1685 from mspacek/savefig_directory

efiring · efiring · commit 20cd99c0a775 · 2013-02-17T11:08:51.000-08:00
Add default savefig directory
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2013-01-23 Add 'savefig.directory' to rcParams to remember and fill in the last
+           directory saved to for figure save dialogs - Martin Spacek
+
 2013-01-08 Added two extra titles to axes which are flush with the left and
            right edges of the plot respectively.
            Andrew Dawson
@@ -38,7 +41,7 @@
            _get_rbg_face except it return a (r,g,b,a) tuble, to line2D.
            Modified Line2D.draw to use _get_rbga_face to get the markerface
            color so that any alpha set by  markerfacecolor will respected.
-	   - Thomas Caswell
+           - Thomas Caswell
 
 2012-11-13 Add a symmetric log normalization class to colors.py.
            Also added some tests for the normalization class.
diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -29,6 +29,12 @@ They may be symmetric or weighted.
 
 .. plot:: mpl_examples/pylab_examples/stackplot_demo2.py
 
+Remember save directory
+-----------------------
+Martin Spacek made the save figure dialog remember the last directory saved
+to. The default is configurable with the new `savefig.directory` setting
+in `matplotlibrc`.
+
 Initialize a rotated rectangle
 ------------------------------
 Damon McDougall extended the :class:`~matplotlib.patches.Rectangle` constructor
diff --git a/lib/matplotlib/backends/backend_gtk.py b/lib/matplotlib/backends/backend_gtk.py
@@ -732,6 +732,7 @@ def get_filechooser(self):
         fc = FileChooserDialog(
             title='Save the figure',
             parent=self.win,
+            path=os.path.expanduser(rcParams.get('savefig.directory', '')),
             filetypes=self.canvas.get_supported_filetypes(),
             default_filetype=self.canvas.get_default_filetype())
         fc.set_current_name(self.canvas.get_default_filename())
@@ -740,6 +741,13 @@ def get_filechooser(self):
     def save_figure(self, *args):
         fname, format = self.get_filechooser().get_filename_from_user()
         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(unicode(fname))
             try:
                 self.canvas.print_figure(fname, format=format)
             except Exception as e:
@@ -1010,8 +1018,8 @@ def save_figure(self, *args):
 
 
 class FileChooserDialog(gtk.FileChooserDialog):
-    """GTK+ 2.4 file selector which remembers the last file/directory
-    selected and presents the user with a menu of supported image formats
+    """GTK+ 2.4 file selector which presents the user with a menu
+    of supported image formats
     """
     def __init__ (self,
                   title   = 'Save file',
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -537,6 +537,7 @@ def get_filechooser(self):
         fc = FileChooserDialog(
             title='Save the figure',
             parent=self.win,
+            path=os.path.expanduser(rcParams.get('savefig.directory', '')),
             filetypes=self.canvas.get_supported_filetypes(),
             default_filetype=self.canvas.get_default_filetype())
         fc.set_current_name(self.canvas.get_default_filename())
@@ -545,6 +546,13 @@ def get_filechooser(self):
     def save_figure(self, *args):
         fname, format = self.get_filechooser().get_filename_from_user()
         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(unicode(fname))
             try:
                 self.canvas.print_figure(fname, format=format)
             except Exception, e:
diff --git a/lib/matplotlib/backends/backend_qt4.py b/lib/matplotlib/backends/backend_qt4.py
@@ -644,7 +644,9 @@ def save_figure(self, *args):
         sorted_filetypes.sort()
         default_filetype = self.canvas.get_default_filetype()
 
-        start = self.canvas.get_default_filename()
+        startpath = matplotlib.rcParams.get('savefig.directory', '')
+        startpath = os.path.expanduser(startpath)
+        start = os.path.join(startpath, self.canvas.get_default_filename())
         filters = []
         selectedFilter = None
         for name, exts in sorted_filetypes:
@@ -657,6 +659,12 @@ def save_figure(self, *args):
         fname = _getSaveFileName(self, "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
+                matplotlib.rcParams['savefig.directory'] = os.path.dirname(unicode(fname))
             try:
                 self.canvas.print_figure( unicode(fname) )
             except Exception as e:
diff --git a/lib/matplotlib/backends/backend_tkagg.py b/lib/matplotlib/backends/backend_tkagg.py
@@ -895,17 +895,27 @@ def save_figure(self, *args):
         # work - JDH
         #defaultextension = self.canvas.get_default_filetype()
         defaultextension = ''
+        initialdir = rcParams.get('savefig.directory', '')
+        initialdir = os.path.expanduser(initialdir)
+        initialfile = self.canvas.get_default_filename()
         fname = asksaveasfilename(
             master=self.window,
             title='Save the figure',
-            filetypes = tk_filetypes,
-            defaultextension = defaultextension,
-            initialfile=self.canvas.get_default_filename(),
+            filetypes=tk_filetypes,
+            defaultextension=defaultextension,
+            initialdir=initialdir,
+            initialfile=initialfile,
             )
 
         if fname == "" or fname == ():
             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(unicode(fname))
             try:
                 # This method will handle the delegation to the correct type
                 self.canvas.print_figure(fname)
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -686,6 +686,8 @@ def __call__(self, s):
     # options are 'tight', or 'standard'. 'standard' validates to None.
     'savefig.bbox':       [None, validate_bbox],
     'savefig.pad_inches': [0.1, validate_float],
+    # default directory in savefig dialog box
+    'savefig.directory': ['~', unicode],
 
     # Maintain shell focus for TkAgg
     'tk.window_focus':  [False, validate_bool],
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -366,6 +366,8 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
 #savefig.format     : png      # png, ps, pdf, svg
 #savefig.bbox       : standard # 'tight' or 'standard'.
 #savefig.pad_inches : 0.1      # Padding to be used when bbox is set to 'tight'
+#savefig.directory  : ~        # default directory in savefig dialog box,
+                               # leave empty to always use current working directory
 
 # tk backend params
 #tk.window_focus   : False    # Maintain shell focus for TkAgg
@@ -450,6 +452,6 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
                                    # $PATH is searched
 #animation.avconv_args: ''         # Additional arguments to pass to avconv
 #animation.mencoder_path: 'mencoder' 
-			           # Path to mencoder binary. Without full path
+                                   # Path to mencoder binary. Without full path
                                    # $PATH is searched
 #animation.mencoder_args: ''       # Additional arguments to pass to mencoder
