Easy specification of default output format for cairo backend

efiring · efiring · commit fac467e3af5b · 2007-07-06T04:35:48.000Z
svn path=/trunk/matplotlib/; revision=3467
diff --git a/examples/backend_driver.py b/examples/backend_driver.py
@@ -1,7 +1,18 @@
 #!/usr/bin/env python
 """
 This is used to drive many of the examples across the backends, for
-regression testing, and comparing backend efficiency
+regression testing, and comparing backend efficiency.
+
+The script takes one or more arguments specifying backends
+to be tested, e.g.
+
+    python backend_driver.py agg ps cairo.png cairo.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.
 """
 
 from __future__ import division
@@ -98,7 +109,11 @@ def drive(backend, python='python', switches = []):
 
     exclude = failbackend.get(backend, [])
     switchstring = ' '.join(switches)
-
+    # Strip off the format specifier, if any.
+    if backend.startswith('cairo'):
+        _backend = 'cairo'
+    else:
+        _backend = backend
     for fname in files:
         if fname in exclude:
             print '\tSkipping %s, known to fail on backend: %s'%backend
@@ -107,17 +122,13 @@ def drive(backend, python='python', switches = []):
         print '\tdriving %s %s' % (fname, switchstring)
         basename, ext = os.path.splitext(fname)
         outfile = basename + '_%s'%backend
-        # The following is temporary, until I put in a command-line
-        # argument to specify the output.
-        if backend.lower() == 'cairo':
-            outfile += '.png'
         tmpfile_name = '_tmp_%s.py' % basename
         tmpfile = file(tmpfile_name, 'w')
 
         tmpfile.writelines((
             'from __future__ import division\n',
             'import matplotlib\n',
-            'matplotlib.use("%s")\n' % backend,
+            'matplotlib.use("%s")\n' % _backend,
             'from pylab import savefig\n',
             ))
         for line in file(fname):
@@ -138,18 +149,19 @@ def drive(backend, python='python', switches = []):
         #os.system('%s %s %s' % (python, tmpfile_name, switchstring))
         os.remove(tmpfile_name)
 
-
 if __name__ == '__main__':
     times = {}
     default_backends = ['Agg', 'PS', 'SVG', 'Template']
     if sys.platform == 'win32':
         python = r'c:\Python24\python.exe'
     else:
         python = 'python'
+    all_backends = [b.lower() for b in mplbe.all_backends]
+    all_backends.extend(['cairo.png', 'cairo.ps', 'cairo.pdf', 'cairo.svg'])
     backends = []
     switches = []
     if sys.argv[1:]:
-        backends = [b for b in sys.argv[1:] if b in mplbe.all_backends]
+        backends = [b.lower() for b in sys.argv[1:] if b.lower() in all_backends]
         switches = [s for s in sys.argv[1:] if s.startswith('--')]
     if not backends:
         backends = default_backends
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -176,6 +176,7 @@
 import sys, os, tempfile
 
 from rcsetup import defaultParams, validate_backend, validate_toolbar
+from rcsetup import validate_cairo_format
 
 major, minor1, minor2, s, tmp = sys.version_info
 _python23 = major>=2 and minor1>=3
@@ -782,9 +783,12 @@ def rcdefaults():
 
 for s in sys.argv[1:]:
     if s.startswith('-d') and len(s) > 2:  # look for a -d flag
+        be_parts = s[2:].split('.')
         try:
-            name = validate_backend(s[2:].strip())
+            name = validate_backend(be_parts[0])
             rcParams['backend'] = name
+            if name == 'Cairo' and len(be_parts) > 1:
+                rcParams['cairo.format'] = validate_cairo_format(be_parts[1])
         except (KeyError, ValueError):
             pass
         # we don't want to assume all -d flags are backends, eg -debug
diff --git a/lib/matplotlib/backends/backend_cairo.py b/lib/matplotlib/backends/backend_cairo.py
@@ -40,7 +40,7 @@ def _fn_name(): return sys._getframe(1).f_code.co_name
 from matplotlib.mathtext   import math_parse_s_ft2font
 import matplotlib.numerix as numx
 from matplotlib.transforms import Bbox
-
+from matplotlib import rcParams
 
 _debug = False
 #_debug = True
@@ -523,6 +523,9 @@ def print_figure(self, fo, dpi=150, facecolor='w', edgecolor='w',
         if format is None and isinstance (fo, basestring):
             # get format from filename extension
             format = os.path.splitext(fo)[1][1:]
+            if format == '':
+                format = rcParams['cairo.format']
+                fo = '%s.%s' % (fo, format)
 
         if format is not None:
             format = format.lower()
@@ -532,9 +535,10 @@ def print_figure(self, fo, dpi=150, facecolor='w', edgecolor='w',
         elif format in ('pdf', 'ps', 'svg'):
             self._save (fo, format, orientation, **kwargs)
         elif format == 'eps': # backend_ps for eps
+            warnings.warn('eps format is printed by ps backend, not cairo')
             from backend_ps import FigureCanvasPS  as FigureCanvas
             fc = FigureCanvas(self.figure)
-            fc.print_figure (filename, dpi, facecolor, edgecolor,
+            fc.print_figure (fo, dpi, facecolor, edgecolor,
                              orientation, **kwargs)
         else:
             warnings.warn('Format "%s" is not supported.\n'
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -184,6 +184,10 @@ def validate_fontsize(s):
     'silent', 'helpful', 'debug', 'debug-annoying',
     ])
 
+validate_cairo_format = ValidateInStrings('cairo_format',
+                            ['png', 'ps', 'pdf', 'svg'],
+                            ignorecase=True)
+
 validate_ps_papersize = ValidateInStrings('ps_papersize',[
     'auto', 'letter', 'legal', 'ledger',
     'a0', 'a1', 'a2','a3', 'a4', 'a5', 'a6', 'a7', 'a8', 'a9', 'a10',
@@ -211,16 +215,12 @@ def validate_ps_distiller(s):
 
 def validate_negative_linestyle_legacy(s):
     try:
-	res = validate_negative_linestyle(s)
-	return res
-    except:
-	try:
-	    dashes = validate_nseq_float(2)(s)
-    	    warnings.warn("Deprecated negative_linestyle specification; use 'solid' or 'dashed'")
-    	    return (0, dashes)  # (offset, (solid, blank))
-	except:
-    	    pass
-	raise
+        res = validate_negative_linestyle(s)
+        return res
+    except ValueError:
+        dashes = validate_nseq_float(2)(s)
+        warnings.warn("Deprecated negative_linestyle specification; use 'solid' or 'dashed'")
+        return (0, dashes)  # (offset, (solid, blank))
 
 class ValidateInterval:
     """
@@ -402,6 +402,7 @@ def __call__(self, s):
     'savefig.edgecolor'   : ['w', validate_color],  # edgecolor; white
     'savefig.orientation' : ['portrait', validate_orientation],  # edgecolor; white
 
+    'cairo.format'       : ['png', validate_cairo_format],
     'tk.window_focus'    : [False, validate_bool],  # Maintain shell focus for TkAgg
     'tk.pythoninspect'   : [False, validate_bool],  # Set PYTHONINSPECT
     'ps.papersize'       : ['letter', validate_ps_papersize], # Set the papersize/type
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -244,6 +244,8 @@ numerix      : %(numerix)s  # numpy, Numeric or numarray
 #savefig.facecolor : white    # figure facecolor when saving
 #savefig.edgecolor : white    # figure edgecolor when saving
 
+#cairo.format      : png      # png, ps, pdf, svg
+
 # tk backend params
 #tk.window_focus   : False    # Maintain shell focus for TkAgg
 #tk.pythoninspect  : False    # tk sets PYTHONINSEPCT
