Merge pull request #7330 from QuLogic/fix-svg-close

dopplershift · web-flow · commit 92da7f63fc68 · 2016-10-27T10:09:40.000-06:00
[MRG] Fix several SVG closing issues
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -582,6 +582,13 @@ def __init__(self, fig, rect,
             right=rcParams['ytick.right'] and rcParams['ytick.major.right'],
             which='major')
 
+    def __getstate__(self):
+        # The renderer should be re-created by the figure, and then cached at
+        # that point.
+        state = super(_AxesBase, self).__getstate__()
+        state['_cachedRenderer'] = None
+        return state
+
     def __setstate__(self, state):
         self.__dict__ = state
         # put the _remove_method back on all artists contained within the axes
diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -1189,49 +1189,64 @@ class FigureCanvasSVG(FigureCanvasBase):
 
     def print_svg(self, filename, *args, **kwargs):
         if is_string_like(filename):
-            fh_to_close = svgwriter = io.open(filename, 'w', encoding='utf-8')
-        elif is_writable_file_like(filename):
-            if not isinstance(filename, io.TextIOBase):
-                if six.PY3:
-                    svgwriter = io.TextIOWrapper(filename, 'utf-8')
-                else:
-                    svgwriter = codecs.getwriter('utf-8')(filename)
+            with io.open(filename, 'w', encoding='utf-8') as svgwriter:
+                return self._print_svg(filename, svgwriter, **kwargs)
+
+        if not is_writable_file_like(filename):
+            raise ValueError("filename must be a path or a file-like object")
+
+        svgwriter = filename
+        filename = getattr(svgwriter, 'name', '')
+        if not isinstance(filename, six.string_types):
+            filename = ''
+
+        if not isinstance(svgwriter, io.TextIOBase):
+            if six.PY3:
+                svgwriter = io.TextIOWrapper(svgwriter, 'utf-8')
             else:
-                svgwriter = filename
-            fh_to_close = None
+                svgwriter = codecs.getwriter('utf-8')(svgwriter)
+            detach = True
         else:
-            raise ValueError("filename must be a path or a file-like object")
-        return self._print_svg(filename, svgwriter, fh_to_close, **kwargs)
+            detach = False
+
+        result = self._print_svg(filename, svgwriter, **kwargs)
+
+        # Detach underlying stream from wrapper so that it remains open in the
+        # caller.
+        if detach:
+            if six.PY3:
+                svgwriter.detach()
+            else:
+                svgwriter.reset()
+                svgwriter.stream = io.BytesIO()
+
+        return result
 
     def print_svgz(self, filename, *args, **kwargs):
         if is_string_like(filename):
-            fh_to_close = gzipwriter = gzip.GzipFile(filename, 'w')
-            svgwriter = io.TextIOWrapper(gzipwriter, 'utf-8')
+            options = dict(filename=filename)
         elif is_writable_file_like(filename):
-            fh_to_close = gzipwriter = gzip.GzipFile(fileobj=filename, mode='w')
-            svgwriter = io.TextIOWrapper(gzipwriter, 'utf-8')
+            options = dict(fileobj=filename)
         else:
             raise ValueError("filename must be a path or a file-like object")
-        return self._print_svg(filename, svgwriter, fh_to_close)
-
-    def _print_svg(self, filename, svgwriter, fh_to_close=None, **kwargs):
-        try:
-            image_dpi = kwargs.pop("dpi", 72)
-            self.figure.set_dpi(72.0)
-            width, height = self.figure.get_size_inches()
-            w, h = width*72, height*72
-
-            _bbox_inches_restore = kwargs.pop("bbox_inches_restore", None)
-            renderer = MixedModeRenderer(
-                self.figure,
-                width, height, image_dpi, RendererSVG(w, h, svgwriter, filename, image_dpi),
-                bbox_inches_restore=_bbox_inches_restore)
-
-            self.figure.draw(renderer)
-            renderer.finalize()
-        finally:
-            if fh_to_close is not None:
-                svgwriter.close()
+
+        with gzip.GzipFile(mode='w', **options) as gzipwriter:
+            return self.print_svg(gzipwriter)
+
+    def _print_svg(self, filename, svgwriter, **kwargs):
+        image_dpi = kwargs.pop("dpi", 72)
+        self.figure.set_dpi(72.0)
+        width, height = self.figure.get_size_inches()
+        w, h = width*72, height*72
+
+        _bbox_inches_restore = kwargs.pop("bbox_inches_restore", None)
+        renderer = MixedModeRenderer(
+            self.figure,
+            width, height, image_dpi, RendererSVG(w, h, svgwriter, filename, image_dpi),
+            bbox_inches_restore=_bbox_inches_restore)
+
+        self.figure.draw(renderer)
+        renderer.finalize()
 
     def get_default_filetype(self):
         return 'svg'
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -278,8 +278,6 @@ def __init__(self, ax, loc=None, bbox=None, **kwargs):
 
         self.set_clip_on(False)
 
-        self._cachedRenderer = None
-
     def add_cell(self, row, col, *args, **kwargs):
         """ Add a cell to the table. """
         xy = (0, 0)
@@ -310,10 +308,9 @@ def draw(self, renderer):
         # Need a renderer to do hit tests on mouseevent; assume the last one
         # will do
         if renderer is None:
-            renderer = self._cachedRenderer
+            renderer = self.figure._cachedRenderer
         if renderer is None:
             raise RuntimeError('No renderer defined')
-        self._cachedRenderer = renderer
 
         if not self.get_visible():
             return
@@ -350,8 +347,9 @@ def contains(self, mouseevent):
 
         # TODO: Return index of the cell containing the cursor so that the user
         # doesn't have to bind to each one individually.
-        if self._cachedRenderer is not None:
-            boxes = [self._cells[pos].get_window_extent(self._cachedRenderer)
+        renderer = self.figure._cachedRenderer
+        if renderer is not None:
+            boxes = [self._cells[pos].get_window_extent(renderer)
                      for pos in six.iterkeys(self._cells)
                      if pos[0] >= 0 and pos[1] >= 0]
             bbox = Bbox.union(boxes)
