deprecate 'savefig.extension' rcParam in favour of 'savefig.format'

mspacek · mspacek · commit 8cdc0da6d184 · 2012-06-02T18:53:55.000-07:00
remove all mention of cairo.&lt;format&gt;
remove unnecessary check for supported formats in get_default_filetype, rely on check in _get_print_method instead
for uniformity, use get_supported_filetypes instead of directly accessing self.filetypes
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,7 +1,8 @@
 2012-06-02 Add new Axes method and pyplot function, hist2d. - PO
 
 2012-05-31 Remove support for 'cairo.<format>' style of backend specification.
-           - Martin Spacek
+           Deprecate 'cairo.format' and 'savefig.extension' rcParams and
+           replace with 'savefig.format'. - Martin Spacek
 
 2012-05-29 pcolormesh now obeys the passed in "edgecolor" kwarg.
            To support this, the "shading" argument to pcolormesh now only
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -14,6 +14,10 @@ For new features that were added to matplotlib, please see
 Changes in 1.2.x
 ================
 
+* The new rc parameter ``savefig.format`` replaces ``cairo.format`` and
+  ``savefig.extension``, and sets the default file format used by
+  :meth:`matplotlib.figure.Figure.savefig`.
+
 * In :meth:`~matplotlib.pyplot.pie` and :meth:`~matplotlib.Axes.pie`, one can
   now set the radius of the pie; setting the *radius* to 'None' (the default
   value), will result in a pie with a radius of 1 as before.
diff --git a/examples/tests/backend_driver.py b/examples/tests/backend_driver.py
@@ -9,11 +9,10 @@
 switch, which takes a comma-separated list, or as separate arguments,
 e.g.
 
-    python backend_driver.py agg ps cairo.png cairo.ps
+    python backend_driver.py agg ps
 
-would test the agg and ps backends, and the cairo backend with output
-to png and ps files. If no arguments are given, a default list of
-backends will be tested.
+would test the agg and ps backends. If no arguments are given, a
+default list of backends will be tested.
 
 Interspersed with the backend arguments can be switches for the Python
 interpreter executing the tests. If entering such arguments causes an
@@ -27,7 +26,6 @@
 from matplotlib.cbook import Bunch, dedent
 
 all_backends = list(rcsetup.all_backends)  # to leave the original list alone
-all_backends.extend(['cairo.png', 'cairo.ps', 'cairo.pdf', 'cairo.svg'])
 
 # actual physical directory for each dir
 dirs = dict(pylab = os.path.join('..', 'pylab_examples'),
@@ -408,8 +406,7 @@ def parse_options():
                   help=dedent('''
       Run tests only for these backends; comma-separated list of
       one or more of: agg, ps, svg, pdf, template, cairo,
-      cairo.png, cairo.ps, cairo.pdf, cairo.svg. Default is everything
-      except cairo.'''))
+      Default is everything except cairo.'''))
     op.add_option('--clean', action='store_true', dest='clean',
                   help='Remove result directories, run no tests')
     op.add_option('-c', '--coverage', action='store_true', dest='coverage',
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -630,7 +630,8 @@ def matplotlib_fname():
     'text.fontweight':  'font.weight',
     'text.fontsize':    'font.size',
     'tick.size' :       'tick.major.size',
-    'svg.embed_char_paths' : 'svg.fonttype'
+    'svg.embed_char_paths' : 'svg.fonttype',
+    'savefig.extension' : 'savefig.format'
     }
 
 _deprecated_ignore_map = {
@@ -908,13 +909,7 @@ def use(arg, warn=True):
     """
     Set the matplotlib backend to one of the known backends.
 
-    The argument is case-insensitive.  For the Cairo backend,
-    the argument can have an extension to indicate the type of
-    output.  Example:
-
-        use('cairo.pdf')
-
-    will specify a default of pdf output generated by Cairo.
+    The argument is case-insensitive.
 
     .. note::
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1922,10 +1922,9 @@ def _print_method(*args, **kwargs):
 
             return _print_method
 
-        if (format not in self.filetypes or
-            not hasattr(self, method_name)):
-            formats = self.filetypes.keys()
-            formats.sort()
+        formats = self.get_supported_filetypes()
+        if (format not in formats or not hasattr(self, method_name)):
+            formats = sorted(formats)
             raise ValueError(
                 'Format "%s" is not supported.\n'
                 'Supported formats: '
@@ -1965,7 +1964,6 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
         *format*
             when set, forcibly set the file format to save to
 
-
         *bbox_inches*
             Bbox in inches. Only the given portion of the figure is
             saved. If 'tight', try to figure out the tight bbox of
@@ -1981,6 +1979,7 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
 
         """
         if format is None:
+            # get format from filename, or from backend's default filetype
             if cbook.is_string_like(filename):
                 format = os.path.splitext(filename)[1][1:]
             if format is None or format == '':
@@ -2080,16 +2079,11 @@ def print_figure(self, filename, dpi=None, facecolor='w', edgecolor='w',
 
     def get_default_filetype(self):
         """
-        Get the default savefig file format as specified in
-        rcParams['savefig.format']. If not supported, return 'png'.
-        Returned string excludes period. Overridden in backends that
-        only support a single file type.
+        Get the default savefig file format as specified in rcParam
+        ``savefig.format``. Returned string excludes period. Overridden
+        in backends that only support a single file type.
         """
-        default = rcParams['savefig.format']
-        if default in self.get_supported_filetypes():
-            return default
-        else:
-            return 'png'
+        return rcParams['savefig.format']
 
     def set_window_title(self, title):
         """
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1110,8 +1110,7 @@ def savefig(self, *args, **kwargs):
             If *format* is *None* and *fname* is a string, the output
             format is deduced from the extension of the filename. If
             the filename has no extension, the value of the rc parameter
-            ``savefig.extension`` is used. If that value is 'auto',
-            the backend determines the extension.
+            ``savefig.format`` is used.
 
             If *fname* is not a string, remember to specify *format* to
             ensure that the correct backend is used.
@@ -1163,11 +1162,6 @@ def savefig(self, *args, **kwargs):
 
         kwargs.setdefault('dpi', rcParams['savefig.dpi'])
 
-        extension = rcParams['savefig.extension']
-        if args and is_string_like(args[0]) and '.' not in os.path.splitext(args[0])[-1] and extension != 'auto':
-            fname = args[0] + '.' + extension
-            args = (fname,) + args[1:]
-
         transparent = kwargs.pop('transparent', False)
         if transparent:
             kwargs.setdefault('facecolor', 'none')
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -251,6 +251,9 @@ def validate_font_properties(s):
     'silent', 'helpful', 'debug', 'debug-annoying',
     ])
 
+def deprecate_savefig_extension(value):
+    warnings.warn("savefig.extension is deprecated.  Use savefig.format instead.")
+
 validate_savefig_format = ValidateInStrings('savefig_format',
                                             ['png', 'ps', 'pdf', 'svg'],
                                             ignorecase=True)
@@ -546,7 +549,7 @@ def __call__(self, s):
     'savefig.facecolor'   : ['w', validate_color],  # facecolor; white
     'savefig.edgecolor'   : ['w', validate_color],  # edgecolor; white
     'savefig.orientation' : ['portrait', validate_orientation],  # edgecolor; white
-    'savefig.extension'   : ['auto', str],          # what to add to extensionless filenames
+    'savefig.extension'   : ['png', deprecate_savefig_extension], # what to add to extensionless filenames
     'savefig.format'      : ['png', validate_savefig_format],
 
     'tk.window_focus'    : [False, validate_bool],  # Maintain shell focus for TkAgg
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -347,7 +347,6 @@ text.hinting_factor : 8 # Specifies the amount of softness for hinting in the
 #savefig.dpi       : 100      # figure dots per inch
 #savefig.facecolor : white    # figure facecolor when saving
 #savefig.edgecolor : white    # figure edgecolor when saving
-#savefig.extension : auto     # what extension to use for savefig('foo'), or 'auto'
 #savefig.format    : png      # png, ps, pdf, svg
 
 # tk backend params
