Updated nbagg backend to mimic savefig defaults, *not* interactive ones.

pelson · pelson · commit a23c9a304bb6 · 2014-09-22T12:19:44.000+01:00
diff --git a/lib/matplotlib/backends/backend_nbagg.py b/lib/matplotlib/backends/backend_nbagg.py
@@ -1,5 +1,6 @@
 """Interactive figures in the IPython notebook"""
 from base64 import b64encode
+from contextlib import contextmanager
 import json
 import io
 import os
@@ -10,11 +11,14 @@
 from IPython.display import display, Javascript, HTML
 from IPython.kernel.comm import Comm
 
+from matplotlib import rcParams
 from matplotlib.figure import Figure
+from matplotlib.backends import backend_agg
 from matplotlib.backends.backend_webagg_core import (FigureManagerWebAgg,
                                                      FigureCanvasWebAggCore,
                                                      NavigationToolbar2WebAgg)
-from matplotlib.backend_bases import ShowBase, NavigationToolbar2, TimerBase
+from matplotlib.backend_bases import (ShowBase, NavigationToolbar2,
+                                      TimerBase, FigureCanvasBase)
 
 
 class Show(ShowBase):
@@ -36,6 +40,25 @@ def __call__(self, block=None):
 show = Show()
 
 
+@contextmanager
+def savefig_background(figure):
+    """Implement the savefig background color logic."""
+    orig_facecolor = figure.patch.get_facecolor()
+    orig_edgecolor = figure.patch.get_edgecolor()
+
+    if rcParams['savefig.transparent']:
+        figure.patch.set_facecolor('none')
+        figure.patch.set_edgecolor('none')
+    else:
+        figure.patch.set_facecolor(rcParams['savefig.facecolor'])
+        figure.patch.set_edgecolor(rcParams['savefig.edgecolor'])
+
+    yield
+
+    figure.patch.set_facecolor(orig_facecolor)
+    figure.patch.set_edgecolor(orig_edgecolor)
+
+
 def draw_if_interactive():
     from matplotlib import is_interactive
     import matplotlib._pylab_helpers as pylab_helpers
@@ -179,6 +202,26 @@ class FigureCanvasNbAgg(FigureCanvasWebAggCore):
     def new_timer(self, *args, **kwargs):
         return TimerTornado(*args, **kwargs)
 
+    def start_event_loop(self, timeout):
+        FigureCanvasBase.start_event_loop_default(self, timeout)
+
+    def stop_event_loop(self):
+        FigureCanvasBase.stop_event_loop_default(self)
+
+    def draw(self):
+        renderer = self.get_renderer()
+
+        self._png_is_old = True
+
+        backend_agg.RendererAgg.lock.acquire()
+        try:
+            with savefig_background(self.figure):
+                self.figure.draw(renderer)
+        finally:
+            backend_agg.RendererAgg.lock.release()
+            # Swap the frames
+            self.manager.refresh_all()
+
 
 def new_figure_manager(num, *args, **kwargs):
     """
diff --git a/lib/matplotlib/backends/web_backend/nbagg_uat.ipynb b/lib/matplotlib/backends/web_backend/nbagg_uat.ipynb
@@ -1,7 +1,7 @@
 {
  "metadata": {
   "name": "",
-  "signature": "sha256:9a73a15660e6912c6bcfaf7c9e8247503738ce5d590a34e08789c2e16de93080"
+  "signature": "sha256:bdd1e05f7e181c8ffb90423b07f7badc827c8f51d2b6ca8c06ce6715789c70e7"
  },
  "nbformat": 3,
  "nbformat_minor": 0,
@@ -92,7 +92,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "print matplotlib.backends.backend_nbagg.connection_info()"
+      "print(matplotlib.backends.backend_nbagg.connection_info())"
      ],
      "language": "python",
      "metadata": {},
@@ -354,9 +354,38 @@
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "### UAT ?? - Keyboard shortcuts in IPython after close of figure (Current known bug)\n",
-      "### UAT ?? - Race condition to show means that \"run all\" ends up collapsing some figures into one (Current known bug)"
+      "### UAT 14 - Keyboard shortcuts in IPython after close of figure\n",
+      "\n",
+      "After closing the previous figure (with the close button above the figure) the IPython keyboard shortcuts should still function.\n",
+      "\n",
+      "### UAT 15 - Savefig colors\n",
+      "\n",
+      "The nbagg backend should honour savefig colors - not the GUI values. The plot below should produce a figure with a yellow background - there should be no green or red in the plot."
      ]
+    },
+    {
+     "cell_type": "code",
+     "collapsed": false,
+     "input": [
+      "import matplotlib\n",
+      "matplotlib.rcParams.update({'figure.facecolor': 'red',\n",
+      "                            'patch.facecolor': 'green',\n",
+      "                            'savefig.facecolor': 'yellow'})\n",
+      "plt.figure()\n",
+      "plt.plot([3, 2, 1])\n",
+      "plt.show()"
+     ],
+     "language": "python",
+     "metadata": {},
+     "outputs": []
+    },
+    {
+     "cell_type": "code",
+     "collapsed": false,
+     "input": [],
+     "language": "python",
+     "metadata": {},
+     "outputs": []
     }
    ],
    "metadata": {}
