Merge remote-tracking branch 'matplotlib/v2.x'

Conflicts:
	lib/matplotlib/pyplot.py
	  - kept imports from 2.x.  There was some style clean up
	    on the master branch, but added imports on 2.x
	  - re-ran boilerplate.py with this code pre-commit

Author: tacaswell

boilerplate.py

@@ -50,15 +50,19 @@
 @_autogen_docstring(Axes.%(func)s)
 def %(func)s(%(argspec)s):
     %(ax)s = gca()
-    # allow callers to override the hold state by passing hold=True|False
-    %(washold)s = %(ax)s.ishold()
+    # Deprecated: allow callers to override the hold state
+    # by passing hold=True|False
+    %(washold)s = %(ax)s._hold
 %(sethold)s
     if hold is not None:
-        %(ax)s.hold(hold)
+        %(ax)s._hold = hold
+        from matplotlib.cbook import mplDeprecation
+        warnings.warn("The 'hold' keyword argument is deprecated since 2.0.",
+                      mplDeprecation)
     try:
         %(ret)s = %(ax)s.%(func)s(%(call)s)
     finally:
-        %(ax)s.hold(%(washold)s)
+        %(ax)s._hold = %(washold)s
 %(mappable)s
     return %(ret)s
 """

doc/api/api_changes.rst

@@ -22,7 +22,6 @@ Color of Axes
 The ``axisbg`` and ``axis_bgcolor`` properties on ``Axes`` have been
 deprecated in favor of ``facecolor``.
 
-
 GTK and GDK backends deprecated
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The GDK and GTK backends have been deprecated. These obsolete backends
@@ -41,6 +40,16 @@ CocoaAgg backend removed
 ~~~~~~~~~~~~~~~~~~~~~~~~
 The deprecated and not fully functional CocoaAgg backend has been removed.
 
+'hold' functionality deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The 'hold' keyword argument and all functions and methods related
+to it are deprecated, along with the 'axes.hold' `rcParams` entry.
+The behavior will remain consistent with the default ``hold=True``
+state that has long been in place.  Instead of using a function
+or keyword argument (``hold=False``) to change that behavior,
+explicitly clear the axes or figure as needed prior to subsequent
+plotting commands.
+
 
 `Artist.update` has return value
 --------------------------------

doc/sphinxext/gen_gallery.py

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# -*- coding: utf-8 -*-
 import codecs
 import os
 import re
@@ -14,7 +14,7 @@
 multiimage = re.compile('(.*?)(_\d\d){1,2}')
 
 # generate a thumbnail gallery of examples
-gallery_template = """\
+gallery_template = u"""\
 {{% extends "layout.html" %}}
 {{% set title = "Thumbnail gallery" %}}
 
@@ -35,7 +35,7 @@
 {{% endblock %}}
 """
 
-header_template = """\
+header_template = u"""\
 <div class="section" id="{section}">
 <h4>
     {title}<a class="headerlink" href="#{section}" title="Permalink to this headline">¶</a>
@@ -48,7 +48,7 @@
 </figure>
 """
 
-toc_template = """\
+toc_template = u"""\
 <li><a class="reference internal" href="#{section}">{title}</a></li>"""
 
 
@@ -133,10 +133,10 @@ def gen_gallery(app, doctree):
             warnings.warn("No thumbnails were found in %s" % subdir)
 
         # Close out the <div> opened up at the top of this loop
-        rows.append("</div>")
+        rows.append(u"</div>")
 
-    content = gallery_template.format(toc='\n'.join(toc_rows),
-                                      gallery='\n'.join(rows))
+    content = gallery_template.format(toc=u'\n'.join(toc_rows),
+                                      gallery=u'\n'.join(rows))
 
     # Only write out the file if the contents have actually changed.
     # Otherwise, this triggers a full rebuild of the docs

examples/pylab_examples/contour_image.py

@@ -29,7 +29,8 @@
 norm = cm.colors.Normalize(vmax=abs(Z).max(), vmin=-abs(Z).max())
 cmap = cm.PRGn
 
-plt.figure()
+fig = plt.figure()
+fig.subplots_adjust(hspace=0.3)
 
 
 plt.subplot(2, 2, 1)
@@ -46,42 +47,38 @@
 # contour separately; don't try to change the edgecolor or edgewidth
 # of the polygons in the collections returned by contourf.
 # Use levels output from previous call to guarantee they are the same.
-cset2 = plt.contour(X, Y, Z, cset1.levels,
-                colors='k',
-                hold='on')
+
+cset2 = plt.contour(X, Y, Z, cset1.levels, colors='k')
+
 # We don't really need dashed contour lines to indicate negative
 # regions, so let's turn them off.
+
 for c in cset2.collections:
     c.set_linestyle('solid')
 
 # It is easier here to make a separate call to contour than
 # to set up an array of colors and linewidths.
 # We are making a thick green line as a zero contour.
 # Specify the zero level as a tuple with only 0 in it.
-cset3 = plt.contour(X, Y, Z, (0,),
-                colors='g',
-                linewidths=2,
-                hold='on')
+
+cset3 = plt.contour(X, Y, Z, (0,), colors='g', linewidths=2)
 plt.title('Filled contours')
 plt.colorbar(cset1)
-#hot()
 
 
 plt.subplot(2, 2, 2)
 
 plt.imshow(Z, extent=extent, cmap=cmap, norm=norm)
 v = plt.axis()
-plt.contour(Z, levels, hold='on', colors='k',
-        origin='upper', extent=extent)
+plt.contour(Z, levels, colors='k', origin='upper', extent=extent)
 plt.axis(v)
 plt.title("Image, origin 'upper'")
 
 plt.subplot(2, 2, 3)
 
 plt.imshow(Z, origin='lower', extent=extent, cmap=cmap, norm=norm)
 v = plt.axis()
-plt.contour(Z, levels, hold='on', colors='k',
-        origin='lower', extent=extent)
+plt.contour(Z, levels, colors='k', origin='lower', extent=extent)
 plt.axis(v)
 plt.title("Image, origin 'lower'")
 
@@ -95,12 +92,11 @@
 # domain that is contoured does not extend beyond these pixel centers.
 im = plt.imshow(Z, interpolation='nearest', extent=extent, cmap=cmap, norm=norm)
 v = plt.axis()
-plt.contour(Z, levels, hold='on', colors='k',
-        origin='image', extent=extent)
+plt.contour(Z, levels, colors='k', origin='image', extent=extent)
 plt.axis(v)
 ylim = plt.get(plt.gca(), 'ylim')
 plt.setp(plt.gca(), ylim=ylim[::-1])
-plt.title("Image, origin from rc, reversed y-axis")
+plt.title("Origin from rc, reversed y-axis")
 plt.colorbar(im)
 
 plt.show()

examples/pylab_examples/contourf_demo.py

@@ -27,7 +27,6 @@
 interior = np.sqrt((X**2) + (Y**2)) < 0.5
 Z[interior] = np.ma.masked
 
-
 # We are using automatic selection of contour levels;
 # this is usually not such a good idea, because they don't
 # occur on nice boundaries, but we do it here for purposes
@@ -45,8 +44,7 @@
 
 CS2 = plt.contour(CS, levels=CS.levels[::2],
                   colors='r',
-                  origin=origin,
-                  hold='on')
+                  origin=origin)
 
 plt.title('Nonsense (3 masked regions)')
 plt.xlabel('word length anomaly')
@@ -97,6 +95,8 @@
 # cmap.set_bad("red")
 
 fig, axs = plt.subplots(2, 2)
+fig.subplots_adjust(hspace=0.3)
+
 for ax, extend in zip(axs.ravel(), extends):
     cs = ax.contourf(X, Y, Z, levels, cmap=cmap, extend=extend, origin=origin)
     fig.colorbar(cs, ax=ax, shrink=0.9)

examples/pylab_examples/layer_images.py

@@ -32,7 +32,6 @@ def func3(x, y):
 Z1.shape = (8, 8)  # chessboard
 im1 = plt.imshow(Z1, cmap=plt.cm.gray, interpolation='nearest',
                  extent=extent)
-plt.hold(True)
 
 Z2 = func3(X, Y)
 

examples/pylab_examples/scatter_masked.py

@@ -14,7 +14,7 @@
 r = np.sqrt(x*x + y*y)
 area1 = np.ma.masked_where(r < r0, area)
 area2 = np.ma.masked_where(r >= r0, area)
-plt.scatter(x, y, s=area1, marker='^', c=c, hold='on')
+plt.scatter(x, y, s=area1, marker='^', c=c)
 plt.scatter(x, y, s=area2, marker='o', c=c)
 # Show the boundary between the regions:
 theta = np.arange(0, np.pi/2, 0.01)

examples/pylab_examples/toggle_images.py

@@ -1,7 +1,7 @@
 """ toggle between two images by pressing "t"
 
 The basic idea is to load two images (they can be different shapes) and plot
-them to the same axes with hold "on".  Then, toggle the visible property of
+them to the same axes.  Then, toggle the visible property of
 them using keypress event handling
 
 If you want two images with different shapes to be plotted with the same
@@ -31,7 +31,7 @@
 # them to be resampled into the same axes space
 extent = (0, 1, 0, 1)
 im1 = plt.imshow(x1, extent=extent)
-im2 = plt.imshow(x2, extent=extent, hold=True)
+im2 = plt.imshow(x2, extent=extent)
 im2.set_visible(False)
 
 

examples/user_interfaces/embedding_in_qt4.py

@@ -33,12 +33,9 @@ class MyMplCanvas(FigureCanvas):
     def __init__(self, parent=None, width=5, height=4, dpi=100):
         fig = Figure(figsize=(width, height), dpi=dpi)
         self.axes = fig.add_subplot(111)
-        # We want the axes cleared every time plot() is called
-        self.axes.hold(False)
 
         self.compute_initial_figure()
 
-        #
         FigureCanvas.__init__(self, fig)
         self.setParent(parent)
 
@@ -75,7 +72,7 @@ def compute_initial_figure(self):
     def update_figure(self):
         # Build a list of 4 random integers between 0 and 10 (both inclusive)
         l = [random.randint(0, 10) for i in range(4)]
-
+        self.axes.cla()
         self.axes.plot([0, 1, 2, 3], l, 'r')
         self.draw()
 

examples/user_interfaces/embedding_in_qt5.py

@@ -32,12 +32,9 @@ class MyMplCanvas(FigureCanvas):
     def __init__(self, parent=None, width=5, height=4, dpi=100):
         fig = Figure(figsize=(width, height), dpi=dpi)
         self.axes = fig.add_subplot(111)
-        # We want the axes cleared every time plot() is called
-        self.axes.hold(False)
 
         self.compute_initial_figure()
 
-        #
         FigureCanvas.__init__(self, fig)
         self.setParent(parent)
 
@@ -74,7 +71,7 @@ def compute_initial_figure(self):
     def update_figure(self):
         # Build a list of 4 random integers between 0 and 10 (both inclusive)
         l = [random.randint(0, 10) for i in range(4)]
-
+        self.axes.cla()
         self.axes.plot([0, 1, 2, 3], l, 'r')
         self.draw()