Ticket #7981: trac-7981-save_ignores_preset_plotting_options.patch

sage/plot/animate.py

@@ -80 +80 @@
     
         sage: animate([plot(sin, -1,1)], xmin=0, ymin=0)._Animation__kwds['xmin']
         0
+        
+    We check that Trac #7981 is fixed::
+    
+        sage: animate([plot(sin(x + float(k), (0, 2*pi), ymin=-5, ymax=5))
+        ...            for k in srange(0,2*pi,0.3)]).show() # optional
     """
     def __init__(self, v, **kwds):
         r"""

sage/plot/plot.py

@@ -315 +315 @@
 ## imported in functions, so it only gets started if it is actually
 ## going to be used.
 
+ALLOWED_EXTENSIONS = ['.eps', '.pdf', '.png', '.ps', '.sobj', '.svg']
 DEFAULT_FIGSIZE=(6, 3.70820393249937)
 DEFAULT_DPI = 100
 EMBEDDED_MODE = False
@@ -1717 +1718 @@
         # This option should not be passed on to save().
         linkmode = kwds.pop('linkmode', False)
 
-        options = {}
-        options.update(self.SHOW_OPTIONS)
-        options.update(self._extra_kwds)
-        options.update(kwds)
-
         if DOCTEST_MODE:
-            options.pop('filename')
-            self.save(DOCTEST_MODE_FILE, **options)
+            kwds.pop('filename', None)
+            self.save(DOCTEST_MODE_FILE, **kwds)
         elif EMBEDDED_MODE:
-            if options['filename'] is None:
-                options['filename'] = sage.misc.misc.graphics_filename()
-            self.save(**options)
+            kwds.setdefault('filename', sage.misc.misc.graphics_filename()) 
+            self.save(**kwds)
             if linkmode == True:
-                return "<img src='cell://%s'>" % options['filename']
+                return "<img src='cell://%s'>" % kwds['filename']
             else:
-                html("<img src='cell://%s'>" % options['filename'])
+                html("<img src='cell://%s'>" % kwds['filename'])
         else:
-            if options['filename'] is None:
-                options['filename'] = sage.misc.misc.tmp_filename() + '.png'
-            self.save(**options)
-            os.system('%s %s 2>/dev/null 1>/dev/null &' % \
-                (sage.misc.viewer.browser(), options['filename']))
+            kwds.setdefault('filename', sage.misc.misc.tmp_filename() + '.png')
+            self.save(**kwds)
+            os.system('%s %s 2>/dev/null 1>/dev/null &'
+                      % (sage.misc.viewer.browser(), kwds['filename']))
 
     def xmin(self, xmin=None):
         """
@@ -2346 +2340 @@
 
         #subplot.autoscale_view(tight=True) 
         return figure
-
-    def save(self, filename=None, dpi=DEFAULT_DPI, savenow=True, *args, **kwds):
+        
+    # ALLOWED_EXTENSIONS is the list of recognized formats.
+    # filename argument is written explicitly so that it can be used as a 
+    # positional one, which is a very likely usage for this function.
+    def save(self, filename=None, **kwds):
         r"""
-        Save the graphics to an image file of type: PNG, PS, EPS, SVG,
-        SOBJ, depending on the file extension you give the filename.
-        Extension types can be: ``.png``, ``.ps``,
-        ``.eps``, ``.svg``, and
-        ``.sobj`` (for a Sage object you can load later).
-        
+        Save the graphics to an image file.
+       
+        INPUT:
+        
+        - ``filename`` -- a string (default: autogenerated), the filename and
+          the image format given by the extension, which can be one of the
+          following:
+         
+            * ``.eps``,
+           
+            * ``.pdf``,
+           
+            * ``.png``,
+           
+            * ``.ps``,
+           
+            * ``.sobj`` (for a Sage object you can load later),
+            
+            * ``.svg``,
+           
+            * empty extension will be treated as ``.sobj``.
+           
+        All other keyword arguments will be passed to the plotter.
+        
+        OUTPUT:
+        
+        - none.        
 
         EXAMPLES::
         
-            sage: c = circle((1,1),1,color='red')
-            sage: filename=os.path.join(SAGE_TMP, 'test.png')
-            sage: c.save(filename, xmin=-1,xmax=3,ymin=-1,ymax=3)
-
-        To correct the aspect ratio of certain graphics, you can 
-        set the ``aspect_ratio`` to 1::
-        
-            sage: c.save(filename, aspect_ratio=1, xmin=-1, xmax=3, ymin=-1, ymax=3)
-
-        You could also just make the dimensions of the picture square
-        using ``figsize``::
-
-            sage: c.save(filename, figsize=[5,5], xmin=-1, xmax=3, ymin=-1, ymax=3)        
-
-        ::
-        
-            sage: point((-1,1),pointsize=30, color='red')
-
-        By default, the figure grows to include all of the graphics
-        and text, so the final image may not be exactly the figure
-        size you specified.
+            sage: c = circle((1,1), 1, color='red')
+            sage: filename = os.path.join(SAGE_TMP, 'test.png')
+            sage: c.save(filename, xmin=-1, xmax=3, ymin=-1, ymax=3)
+
+        To correct the aspect ratio of certain graphics, you can set the
+        ``aspect_ratio`` to 1::
+        
+            sage: c.save(filename, aspect_ratio=1,
+            ...          xmin=-1, xmax=3, ymin=-1, ymax=3)
+
+        You could also just make the dimensions of the picture square using
+        ``figsize``::
+
+            sage: c.save(filename, figsize=[5, 5],
+            ...          xmin=-1, xmax=3, ymin=-1, ymax=3)        
+
+        By default, the figure grows to include all of the graphics and text,
+        so the final image may not be exactly the figure size you specified.
         """
+        options = dict()
+        options.update(self.SHOW_OPTIONS)
+        options.update(self._extra_kwds)
+        options.update(kwds)
+        dpi = options.pop('dpi')
+        transparent = options.pop('transparent')
+        
+        if filename is None:
+            filename = options.pop('filename')
         if filename is None:
             filename = sage.misc.misc.graphics_filename()
-        try:
-            ext = os.path.splitext(filename)[1].lower()
-        except IndexError:
-            raise ValueError, "file extension must be either 'png', 'eps', 'svg' or 'sobj'"
-        
-        if ext == '' or ext == '.sobj':
+        ext = os.path.splitext(filename)[1].lower()
+        
+        if ext not in ALLOWED_EXTENSIONS:
+            raise ValueError("allowed file extensions for images are '"
+                             + "', '".join(ALLOWED_EXTENSIONS) + "'!")
+        elif ext in ['', '.sobj']:
             SageObject.save(self, filename)
-            return
-
-        if savenow:
-            options=dict()
-            options['transparent']=kwds.pop('transparent',False)
-            figure=self.matplotlib(*args, **kwds)
+        else:
+            figure = self.matplotlib(**options)
             # You can output in PNG, PS, EPS, PDF, or SVG format, depending on the file extension. 
             # matplotlib looks at the file extension to see what the renderer should be.
             # The default is FigureCanvasAgg for PNG's because this is by far the most
@@ -2402 +2422 @@
             # if the file extension is not '.png', then matplotlib will handle it.
             from matplotlib.backends.backend_agg import FigureCanvasAgg
             figure.set_canvas(FigureCanvasAgg(figure))
-
-            if ext in ['.eps', '.ps', '.pdf']:
-                if dpi is None:
-                    dpi = 72
-            elif ext == '.svg':
-                if dpi is None:
-                    dpi = 80
-            elif ext == '.png':
-                if dpi is None:
-                    dpi = 100
-            else:
-                raise ValueError, "file extension must be either 'png', 'ps, 'eps', 'pdf, 'svg' or 'sobj'"
-            figure.savefig(filename,dpi=dpi,bbox_inches='tight',**options)
+            figure.savefig(filename, dpi=dpi, bbox_inches='tight',
+                           transparent=transparent)
 
 
 _SelectiveFormatterClass = None