Address documentation and smaller issues raised by @pelson in matplotlib#1426.

mdboom · mdboom · commit 2f9c99202e17 · 2013-01-04T15:30:11.000-05:00
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -523,6 +523,9 @@ class Animation(object):
     '''
     def __init__(self, fig, event_source=None, blit=False):
         self._fig = fig
+        # Disables blitting for backends that don't support it.  This
+        # allows users to request it if available, but still have a
+        # fallback that works if it is not.
         self._blit = blit and fig.canvas.supports_blit
 
         # These are the basics of the animation.  The frame sequence represents
diff --git a/lib/matplotlib/backends/backend_webagg.py b/lib/matplotlib/backends/backend_webagg.py
@@ -3,9 +3,9 @@
 """
 from __future__ import division, print_function
 
-import cStringIO
 import datetime
 import errno
+import io
 import json
 import os
 import random
@@ -104,10 +104,23 @@ class FigureCanvasWebAgg(backend_agg.FigureCanvasAgg):
 
     def __init__(self, *args, **kwargs):
         backend_agg.FigureCanvasAgg.__init__(self, *args, **kwargs)
-        self.png_buffer = cStringIO.StringIO()
-        self.png_is_old = True
-        self.force_full = True
-        self.pending_draw = None
+
+        # A buffer to hold the PNG data for the last frame.  This is
+        # retained so it can be resent to each client without
+        # regenerating it.
+        self._png_buffer = io.BytesIO()
+
+        # Set to True when the renderer contains data that is newer
+        # than the PNG buffer.
+        self._png_is_old = True
+
+        # Set to True by the `refresh` message so that the next frame
+        # sent to the clients will be a full frame.
+        self._force_full = True
+
+        # Set to True when a drawing is in progress to prevent redraw
+        # messages from piling up.
+        self._pending_draw = None
 
     def show(self):
         # show the figure window
@@ -117,7 +130,7 @@ def draw(self):
         # TODO: Do we just queue the drawing here?  That's what Gtk does
         renderer = self.get_renderer()
 
-        self.png_is_old = True
+        self._png_is_old = True
 
         backend_agg.RendererAgg.lock.acquire()
         try:
@@ -128,67 +141,75 @@ def draw(self):
             self.manager.refresh_all()
 
     def draw_idle(self):
-        if self.pending_draw is None:
+        if self._pending_draw is None:
             ioloop = tornado.ioloop.IOLoop.instance()
-            self.pending_draw = ioloop.add_timeout(
+            self._pending_draw = ioloop.add_timeout(
                 datetime.timedelta(milliseconds=50),
                 self._draw_idle_callback)
 
     def _draw_idle_callback(self):
         try:
             self.draw()
         finally:
-            self.pending_draw = None
+            self._pending_draw = None
 
     def get_diff_image(self):
-        if self.png_is_old:
+        if self._png_is_old:
+            # The buffer is created as type uint32 so that entire
+            # pixels can be compared in one numpy call, rather than
+            # needing to compare each plane separately.
             buffer = np.frombuffer(
-                self.renderer.buffer_rgba(), dtype=np.uint32)
-            buffer = buffer.reshape(
-                (self.renderer.height, self.renderer.width))
+                self._renderer.buffer_rgba(), dtype=np.uint32)
+            buffer.shape = (
+                self._renderer.height, self._renderer.width)
 
-            if not self.force_full:
+            if not self._force_full:
                 last_buffer = np.frombuffer(
-                    self.last_renderer.buffer_rgba(), dtype=np.uint32)
-                last_buffer = last_buffer.reshape(
-                    (self.renderer.height, self.renderer.width))
+                    self._last_renderer.buffer_rgba(), dtype=np.uint32)
+                last_buffer.shape = (
+                    self._renderer.height, self._renderer.width)
 
                 diff = buffer != last_buffer
                 output = np.where(diff, buffer, 0)
             else:
                 output = buffer
 
-            self.png_buffer.reset()
-            self.png_buffer.truncate()
+            # Clear out the PNG data buffer rather than recreating it
+            # each time.  This reduces the number of memory
+            # (de)allocations.
+            self._png_buffer.truncate()
+            self._png_buffer.seek(0)
+
             # TODO: We should write a new version of write_png that
             # handles the differencing inline
             _png.write_png(
                 output.tostring(),
                 output.shape[1], output.shape[0],
-                self.png_buffer)
+                self._png_buffer)
 
-            self.renderer, self.last_renderer = \
-              self.last_renderer, self.renderer
-            self.force_full = False
-            self.png_is_old = False
-        return self.png_buffer.getvalue()
+            # Swap the renderer frames
+            self._renderer, self._last_renderer = \
+              self._last_renderer, self._renderer
+            self._force_full = False
+            self._png_is_old = False
+        return self._png_buffer.getvalue()
 
     def get_renderer(self):
         l, b, w, h = self.figure.bbox.bounds
         key = w, h, self.figure.dpi
         try:
-            self._lastKey, self.renderer
+            self._lastKey, self._renderer
         except AttributeError:
             need_new_renderer = True
         else:
             need_new_renderer = (self._lastKey != key)
 
         if need_new_renderer:
-            self.renderer = backend_agg.RendererAgg(w, h, self.figure.dpi)
-            self.last_renderer = backend_agg.RendererAgg(w, h, self.figure.dpi)
+            self._renderer = backend_agg.RendererAgg(w, h, self.figure.dpi)
+            self._last_renderer = backend_agg.RendererAgg(w, h, self.figure.dpi)
             self._lastKey = key
 
-        return self.renderer
+        return self._renderer
 
     def handle_event(self, event):
         type = event['type']
@@ -201,8 +222,10 @@ def handle_event(self, event):
             # off by 1
             button = event['button'] + 1
 
-            # The right mouse button pops up a context menu, which doesn't
-            # work very well, so use the middle mouse button instead
+            # The right mouse button pops up a context menu, which
+            # doesn't work very well, so use the middle mouse button
+            # instead.  It doesn't seem that it's possible to disable
+            # the context menu in recent versions of Chrome.
             if button == 2:
                 button = 3
 
@@ -223,7 +246,7 @@ def handle_event(self, event):
             # TODO: Be more suspicious of the input
             getattr(self.toolbar, event['name'])()
         elif type == 'refresh':
-            self.force_full = True
+            self._force_full = True
             self.draw_idle()
 
     def send_event(self, event_type, **kwargs):
@@ -248,9 +271,6 @@ def __init__(self, canvas, num):
 
         self.web_sockets = set()
 
-        self.canvas = canvas
-        self.num = num
-
         self.toolbar = self._get_toolbar(canvas)
 
     def show(self):
@@ -279,16 +299,9 @@ def resize(self, w, h):
 
 
 class NavigationToolbar2WebAgg(backend_bases.NavigationToolbar2):
-    toolitems = (
-        ('Home', 'Reset original view', 'home', 'home'),
-        ('Back', 'Back to  previous view', 'back', 'back'),
-        ('Forward', 'Forward to next view', 'forward', 'forward'),
-        (None, None, None, None),
-        ('Pan', 'Pan axes with left mouse, zoom with right', 'move', 'pan'),
-        ('Zoom', 'Zoom to rectangle', 'zoom_to_rect', 'zoom'),
-        (None, None, None, None),
+    toolitems = list(backend_bases.NavigationToolbar2.toolitems[:6]) + [
         ('Download', 'Download plot', 'filesave', 'download')
-        )
+        ]
 
     def _init_toolbar(self):
         self.message = ''
@@ -331,7 +344,7 @@ def get(self, fignum):
                 tpl = fd.read()
 
             fignum = int(fignum)
-            manager = Gcf().get_fig_manager(fignum)
+            manager = Gcf.get_fig_manager(fignum)
 
             t = tornado.template.Template(tpl)
             self.write(t.generate(
@@ -341,7 +354,7 @@ def get(self, fignum):
     class Download(tornado.web.RequestHandler):
         def get(self, fignum, format):
             self.fignum = int(fignum)
-            manager = Gcf().get_fig_manager(self.fignum)
+            manager = Gcf.get_fig_manager(self.fignum)
 
             # TODO: Move this to a central location
             mimetypes = {
@@ -357,25 +370,25 @@ def get(self, fignum, format):
 
             self.set_header('Content-Type', mimetypes.get(format, 'binary'))
 
-            buffer = cStringIO.StringIO()
+            buffer = io.BytesIO()
             manager.canvas.print_figure(buffer, format=format)
             self.write(buffer.getvalue())
 
     class WebSocket(tornado.websocket.WebSocketHandler):
         def open(self, fignum):
             self.fignum = int(fignum)
-            manager = Gcf().get_fig_manager(self.fignum)
+            manager = Gcf.get_fig_manager(self.fignum)
             manager.add_web_socket(self)
             l, b, w, h = manager.canvas.figure.bbox.bounds
             manager.resize(w, h)
             self.on_message('{"type":"refresh"}')
 
         def on_close(self):
-            Gcf().get_fig_manager(self.fignum).remove_web_socket(self)
+            Gcf.get_fig_manager(self.fignum).remove_web_socket(self)
 
         def on_message(self, message):
             message = json.loads(message)
-            canvas = Gcf().get_fig_manager(self.fignum).canvas
+            canvas = Gcf.get_fig_manager(self.fignum).canvas
             canvas.handle_event(message)
 
         def send_event(self, event_type, **kwargs):
@@ -384,7 +397,7 @@ def send_event(self, event_type, **kwargs):
             self.write_message(json.dumps(payload))
 
         def send_image(self):
-            canvas = Gcf().get_fig_manager(self.fignum).canvas
+            canvas = Gcf.get_fig_manager(self.fignum).canvas
             diff = canvas.get_diff_image()
             self.write_message(diff, binary=True)
 
@@ -416,8 +429,11 @@ def initialize(cls):
 
         app = cls()
 
+        # This port selection algorithm is borrowed, more or less
+        # verbatim, from IPython.
         def random_ports(port, n):
-            """Generate a list of n random ports near the given port.
+            """
+            Generate a list of n random ports near the given port.
 
             The first 5 ports will be sequential, and the remaining n-5 will be
             randomly selected in the range [port-2*n, port+2*n].
@@ -429,8 +445,7 @@ def random_ports(port, n):
 
         success = None
         cls.port = rcParams['webagg.port']
-        # TODO: Configure port_retrues
-        for port in random_ports(cls.port, 50):
+        for port in random_ports(cls.port, rcParams['webagg.port_retries']):
             try:
                 app.listen(port)
             except socket.error as e:
diff --git a/lib/matplotlib/backends/web_static/index.html b/lib/matplotlib/backends/web_static/index.html
@@ -7,7 +7,8 @@
      onkeydown="key_event(event, 'key_press')"
      onkeyup="key_event(event, 'key_release')">
     <div id="mpl-div">
-      <canvas id="mpl-canvas" width="800" height="600"
+      <canvas id="mpl-canvas"
+              class="mpl-canvas"
               onmousedown="mouse_event(event, 'button_press')"
               onmouseup="mouse_event(event, 'button_release')"
               onmousemove="mouse_event(event, 'motion_notify')">
diff --git a/lib/matplotlib/backends/web_static/mpl.css b/lib/matplotlib/backends/web_static/mpl.css
@@ -1,13 +1,18 @@
+.mpl-canvas {
+    width:800px;
+    height:600px;
+}
+
 .mpl-message {
     float:right;
     vertical-align:text-center;
 }
 
 .mpl-toolbar-spacer {
-    padding:8px
+    padding:8px;
 }
 
 .mpl-toolbar-button {
-    padding:0px
-    margin:0px
+    padding:0px;
+    margin:0px;
 }
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -20,7 +20,7 @@
 from matplotlib.colors import is_color_like
 
 #interactive_bk = ['gtk', 'gtkagg', 'gtkcairo', 'fltkagg', 'qtagg', 'qt4agg',
-#                  'tkagg', 'wx', 'wxagg', 'cocoaagg', 'web']
+#                  'tkagg', 'wx', 'wxagg', 'cocoaagg', 'webagg']
 # The capitalized forms are needed for ipython at present; this may
 # change for later versions.
 
@@ -389,6 +389,7 @@ def __call__(self, s):
     'backend.qt4'       : ['PyQt4', validate_qt4],
     'webagg.port'       : [8888, validate_int],
     'webagg.open_in_browser' : [True, validate_bool],
+    'webagg.port_retries' : [50, validate_int],
     'toolbar'           : ['toolbar2', validate_toolbar],
     'datapath'          : [None, validate_path_exists],   # handled by _get_data_path_cached
     'interactive'       : [False, validate_bool],
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -41,9 +41,13 @@ backend      : %(backend)s
 # "pyqt" and "pyside".  The "pyqt" setting has the side effect of
 # forcing the use of Version 2 API for QString and QVariant.
 
-# The port to use for the web server in the WebAgg backend
+# The port to use for the web server in the WebAgg backend.
 # webagg.port : 8888
 
+# If webagg.port is unavailable, a number of other random ports will
+# be tried until one that is available is found.
+# webagg.port_retries : 50
+
 # When True, open the webbrowser to the plot that is shown
 # webagg.open_in_browser : True
 
diff --git a/setup.py b/setup.py
@@ -48,7 +48,8 @@
      check_for_qt, check_for_qt4, check_for_pyside, check_for_cairo, \
      check_provide_pytz, check_provide_dateutil,\
      check_for_dvipng, check_for_ghostscript, check_for_latex, \
-     check_for_pdftops, options, build_png, build_tri, check_provide_six
+     check_for_pdftops, options, build_png, build_tri, check_provide_six, \
+     check_for_tornado
 
 
 packages = [
@@ -197,6 +198,7 @@ def chop_package(fname):
 check_for_qt4()
 check_for_pyside()
 check_for_cairo()
+check_for_tornado()
 
 print_raw("")
 print_raw("OPTIONAL DATE/TIMEZONE DEPENDENCIES")
diff --git a/setupext.py b/setupext.py
@@ -454,6 +454,16 @@ def check_for_cairo():
         print_status("Cairo", cairo.version)
         return True
 
+def check_for_tornado():
+    try:
+        import tornado
+    except ImportError:
+        print_status("Tornado (webagg)", "no")
+        return False
+    else:
+        print_status("Tornado (webagg)", tornado.version)
+        return True
+
 def check_provide_pytz():
     if options['provide_pytz'] is True:
         print_status("pytz", "matplotlib will provide")
