matplotlib · NelleV · Jan 7, 2013 · Jan 7, 2013 · Jan 8, 2013 · Jan 8, 2013
diff --git a/CHANGELOG b/CHANGELOG
@@ -6,10 +6,11 @@
 
 2013-01-16 Till Stensitzki added a baseline feature to stackplot
 
+2013-01-09 Deprecated the cbook module in favor of a private, not publicly
+	   documentation module utils.
 2012-12-22 Added classes for interpolation within triangular grids
            (LinearTriInterpolator) and to find the triangles in which points
            lie (TrapezoidMapTriFinder) to matplotlib.tri module. - IMT
-
 2012-12-05 Added MatplotlibDeprecationWarning class for signaling deprecation.
            Matplotlib developers can use this class as follows:
 

diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -26,6 +26,7 @@ Changes in 1.3.x
 
 * The `~matplotlib.mpl` module is now deprecated. Those who relied on this
   module should transition to simply using `import matplotlib as mpl`.
+* The module ``cbook`` is deprecated and will be removed in 1.5.x.
 
 Changes in 1.2.x
 ================

diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -21,7 +21,6 @@
    axes_api.rst
    axis_api.rst
    index_backend_api.rst
-   cbook_api.rst
    cm_api.rst
    collections_api.rst
    colorbar_api.rst

diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -48,7 +48,7 @@ Style
     import numpy.ma as ma
     import matplotlib as mpl
     from matplotlib import pyplot as plt
-    import matplotlib.cbook as cbook
+    import matplotlib.utils as utils
     import matplotlib.collections as mcol
     import matplotlib.patches as mpatches
 
@@ -257,8 +257,8 @@ distributed with matplotlib in the
 `lib/matplotlib/mpl-data/sample_data/` directory.  Then in your
 example code you can load it into a file handle with::
 
-    import matplotlib.cbook as cbook
-    fh = cbook.get_sample_data('mydata.dat')
+    import matplotlib.utils as utils
+    fh = utils.get_sample_data('mydata.dat')
 
 .. _new-pyplot-function:
 

diff --git a/doc/mpl_toolkits/axes_grid/figures/demo_colorbar_of_inset_axes.py b/doc/mpl_toolkits/axes_grid/figures/demo_colorbar_of_inset_axes.py
@@ -4,7 +4,7 @@
 from mpl_toolkits.axes_grid.colorbar import colorbar
 
 def get_demo_image():
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     import numpy as np
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)

diff --git a/doc/mpl_toolkits/axes_grid/figures/simple_rgb.py b/doc/mpl_toolkits/axes_grid/figures/simple_rgb.py
@@ -4,7 +4,7 @@
 
 def get_demo_image():
     import numpy as np
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/doc/users/recipes.rst b/doc/users/recipes.rst
@@ -87,7 +87,7 @@ gracefully, and here are some tricks to help you work around them.
 We'll load up some sample date data which contains datetime.date
 objects in a numpy record array::
 
-  In [63]: datafile = cbook.get_sample_data('goog.npy')
+  In [63]: datafile = utils.get_sample_data('goog.npy')
 
   In [64]: r = np.load(datafile).view(np.recarray)
 
@@ -116,8 +116,8 @@ you will see that the x tick labels are all squashed together.
 .. plot::
    :context:
 
-   import matplotlib.cbook as cbook
-   datafile = cbook.get_sample_data('goog.npy')
+   import matplotlib.utils as utils 
+   datafile = utils.get_sample_data('goog.npy')
    r = np.load(datafile).view(np.recarray)
    plt.figure()
    plt.plot(r.date, r.close)
@@ -175,10 +175,10 @@ right.
    import matplotlib.pyplot as plt
    import numpy as np
 
-   import matplotlib.cbook as cbook
+   import matplotlib.utils as utils 
 
    # load up some sample financial data
-   datafile = cbook.get_sample_data('goog.npy')
+   datafile = utils.get_sample_data('goog.npy')
    r = np.load(datafile).view(np.recarray)
 
    # create two subplots with the shared x and y axes

diff --git a/examples/animation/old_animation/draggable_legend.py b/examples/animation/old_animation/draggable_legend.py
@@ -16,7 +16,7 @@
 
 
 from matplotlib._png import read_png
-from matplotlib.cbook import get_sample_data
+from matplotlib.utils import get_sample_data
 
 from matplotlib.offsetbox import OffsetImage, AnnotationBbox
 

diff --git a/examples/api/date_demo.py b/examples/api/date_demo.py
@@ -15,7 +15,7 @@
 import numpy as np
 import matplotlib.pyplot as plt
 import matplotlib.dates as mdates
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils 
 
 years    = mdates.YearLocator()   # every year
 months   = mdates.MonthLocator()  # every month
@@ -25,7 +25,7 @@
 # open, close, volume, adj_close from the mpl-data/example directory.
 # The record array stores python datetime.date as an object array in
 # the date column
-datafile = cbook.get_sample_data('goog.npy')
+datafile = utils.get_sample_data('goog.npy')
 r = np.load(datafile).view(np.recarray)
 
 fig = plt.figure()

diff --git a/examples/api/date_index_formatter.py b/examples/api/date_index_formatter.py
@@ -7,10 +7,10 @@
 import numpy as np
 import matplotlib.pyplot as plt
 import matplotlib.mlab as mlab
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils 
 import matplotlib.ticker as ticker
 
-datafile = cbook.get_sample_data('aapl.csv', asfileobj=False)
+datafile = utils.get_sample_data('aapl.csv', asfileobj=False)
 print ('loading %s' % datafile)
 r = mlab.csv2rec(datafile)
 

diff --git a/examples/api/watermark_image.py b/examples/api/watermark_image.py
@@ -4,11 +4,11 @@
 from __future__ import print_function
 import numpy as np
 import matplotlib
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 import matplotlib.image as image
 import matplotlib.pyplot as plt
 
-datafile = cbook.get_sample_data('logo2.png', asfileobj=False)
+datafile = utils.get_sample_data('logo2.png', asfileobj=False)
 print ('loading %s' % datafile)
 im = image.imread(datafile)
 im[:,:,-1] = 0.5  # set the alpha channel

diff --git a/examples/axes_grid/demo_axes_divider.py b/examples/axes_grid/demo_axes_divider.py
@@ -2,7 +2,7 @@
 
 def get_demo_image():
     import numpy as np
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/examples/axes_grid/demo_axes_grid.py b/examples/axes_grid/demo_axes_grid.py
@@ -3,7 +3,7 @@
 
 def get_demo_image():
     import numpy as np
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/examples/axes_grid/demo_axes_grid2.py b/examples/axes_grid/demo_axes_grid2.py
@@ -3,7 +3,7 @@
 import numpy as np
 
 def get_demo_image():
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/examples/axes_grid/demo_axes_rgb.py b/examples/axes_grid/demo_axes_rgb.py
@@ -4,7 +4,7 @@
 from mpl_toolkits.axes_grid1.axes_rgb import make_rgb_axes, RGBAxes
 
 def get_demo_image():
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/examples/axes_grid/demo_curvelinear_grid.py b/examples/axes_grid/demo_curvelinear_grid.py
@@ -2,7 +2,7 @@
 #from matplotlib.path import Path
 
 import matplotlib.pyplot as plt
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils 
 
 from  mpl_toolkits.axisartist.grid_helper_curvelinear import GridHelperCurveLinear
 from mpl_toolkits.axisartist import Subplot
@@ -109,7 +109,7 @@ def curvelinear_test2(fig):
     # note that ax2.transData == tr + ax1.transData
     # Anthing you draw in ax2 will match the ticks and grids of ax1.
     ax1.parasites.append(ax2)
-    intp = cbook.simple_linear_interpolation
+    intp = utils.simple_linear_interpolation
     ax2.plot(intp(np.array([0, 30]), 50),
              intp(np.array([10., 10.]), 50))
 

diff --git a/examples/axes_grid/demo_edge_colorbar.py b/examples/axes_grid/demo_edge_colorbar.py
@@ -3,7 +3,7 @@
 
 def get_demo_image():
     import numpy as np
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/examples/axes_grid/inset_locator_demo2.py b/examples/axes_grid/inset_locator_demo2.py
@@ -6,7 +6,7 @@
 import numpy as np
 
 def get_demo_image():
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     import numpy as np
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)

diff --git a/examples/axes_grid/simple_axesgrid2.py b/examples/axes_grid/simple_axesgrid2.py
@@ -3,7 +3,7 @@
 
 def get_demo_image():
     import numpy as np
-    from matplotlib.cbook import get_sample_data
+    from matplotlib.utils import get_sample_data
     f = get_sample_data("axes_grid/bivariate_normal.npy", asfileobj=False)
     z = np.load(f)
     # z is a numpy array of 15x15

diff --git a/examples/misc/developer_commit_history.py b/examples/misc/developer_commit_history.py
@@ -10,9 +10,9 @@
 """
 import os, datetime
 
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 
-todate = cbook.todate('%Y-%m-%d')
+todate = utils.todate('%Y-%m-%d')
 today = datetime.date.today()
 if not os.path.exists('log.txt'):
     print('You must place the "svn log" output into a file "log.txt"')

diff --git a/examples/misc/rc_traits.py b/examples/misc/rc_traits.py
@@ -7,7 +7,7 @@
 
 import sys, os, re
 import traits.api as traits
-from matplotlib.cbook import is_string_like
+from matplotlib.utils import is_string_like
 from matplotlib.artist import Artist
 
 doprint = True

diff --git a/examples/misc/rec_groupby_demo.py b/examples/misc/rec_groupby_demo.py
@@ -1,9 +1,9 @@
 from __future__ import print_function
 import numpy as np
 import matplotlib.mlab as mlab
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 
-datafile = cbook.get_sample_data('aapl.csv', asfileobj=False)
+datafile = utils.get_sample_data('aapl.csv', asfileobj=False)
 print('loading', datafile)
 r = mlab.csv2rec(datafile)
 r.sort()

diff --git a/examples/misc/rec_join_demo.py b/examples/misc/rec_join_demo.py
@@ -1,9 +1,9 @@
 from __future__ import print_function
 import numpy as np
 import matplotlib.mlab as mlab
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 
-datafile = cbook.get_sample_data('aapl.csv', asfileobj=False)
+datafile = utils.get_sample_data('aapl.csv', asfileobj=False)
 print('loading', datafile)
 r = mlab.csv2rec(datafile)
 

diff --git a/examples/misc/sample_data_demo.py b/examples/misc/sample_data_demo.py
@@ -3,7 +3,7 @@
 fetch it from github and cache it
 """
 from __future__ import print_function
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 import matplotlib.pyplot as plt
 fname = cbook.get_sample_data('ada.png', asfileobj=False)
 

diff --git a/examples/pylab_examples/centered_ticklabels.py b/examples/pylab_examples/centered_ticklabels.py
@@ -15,13 +15,13 @@
 import datetime
 import numpy as np
 import matplotlib
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 import matplotlib.dates as dates
 import matplotlib.ticker as ticker
 import matplotlib.pyplot as plt
 
 # load some financial data; apple's stock price
-fh = cbook.get_sample_data('aapl.npy.gz')
+fh = utils.get_sample_data('aapl.npy.gz')
 r = np.load(fh); fh.close()
 r = r[-250:]  # get the last 250 days
 

diff --git a/examples/pylab_examples/data_helper.py b/examples/pylab_examples/data_helper.py
@@ -2,7 +2,9 @@
 # Some functions to load a return data for the plot demos
 
 from numpy import fromstring, argsort, take, array, resize
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
+
+
 def get_two_stock_data():
     """
     load stock time and price data for two stocks The return values
@@ -11,8 +13,8 @@ def get_two_stock_data():
     """
     ticker1, ticker2 = 'INTC', 'AAPL'
 
-    file1 = cbook.get_sample_data('INTC.dat.gz')
-    file2 = cbook.get_sample_data('AAPL.dat.gz')
+    file1 = utils.get_sample_data('INTC.dat.gz')
+    file2 = utils.get_sample_data('AAPL.dat.gz')
     M1 = fromstring( file1.read(), '<d')
 
     M1 = resize(M1, (M1.shape[0]/2,2) )
@@ -39,7 +41,7 @@ class C: pass
     def get_ticker(ticker):
         vals = []
 
-        datafile = cbook.get_sample_data('%s.csv'%ticker, asfileobj=False)
+        datafile = utils.get_sample_data('%s.csv'%ticker, asfileobj=False)
 
         lines = open(datafile).readlines()
         for line in lines[1:]:

diff --git a/examples/pylab_examples/date_index_formatter.py b/examples/pylab_examples/date_index_formatter.py
@@ -12,10 +12,10 @@
 import numpy
 from matplotlib.mlab import csv2rec
 from pylab import figure, show
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils 
 from matplotlib.ticker import Formatter
 
-datafile = cbook.get_sample_data('msft.csv', asfileobj=False)
+datafile = utils.get_sample_data('msft.csv', asfileobj=False)
 print ('loading %s' % datafile)
 r = csv2rec(datafile)[-40:]
 

diff --git a/examples/pylab_examples/demo_annotation_box.py b/examples/pylab_examples/demo_annotation_box.py
@@ -1,7 +1,7 @@
 import matplotlib.pyplot as plt
 from matplotlib.offsetbox import TextArea, DrawingArea, OffsetImage, \
      AnnotationBbox
-from matplotlib.cbook import get_sample_data
+from matplotlib.utils import get_sample_data
 
 import numpy as np
 

diff --git a/examples/pylab_examples/demo_ribbon_box.py b/examples/pylab_examples/demo_ribbon_box.py
@@ -4,7 +4,7 @@
 
 from matplotlib._png import read_png
 import matplotlib.colors
-from matplotlib.cbook import get_sample_data
+from matplotlib.utils import get_sample_data
 
 class RibbonBox(object):
 

diff --git a/examples/pylab_examples/demo_text_path.py b/examples/pylab_examples/demo_text_path.py
@@ -11,7 +11,7 @@
 from matplotlib.offsetbox import AnnotationBbox,\
      AnchoredOffsetbox, AuxTransformBox
 
-from matplotlib.cbook import get_sample_data
+from matplotlib.utils import get_sample_data
 
 from matplotlib.text import TextPath
 

diff --git a/examples/pylab_examples/image_demo2.py b/examples/pylab_examples/image_demo2.py
@@ -2,11 +2,11 @@
 
 from __future__ import print_function
 from pylab import *
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 
 w, h = 512, 512
 
-datafile = cbook.get_sample_data('ct.raw.gz', asfileobj=True)
+datafile = utils.get_sample_data('ct.raw.gz', asfileobj=True)
 s = datafile.read()
 A = fromstring(s, uint16).astype(float)
 A *= 1.0/max(A)

diff --git a/examples/pylab_examples/image_demo3.py b/examples/pylab_examples/image_demo3.py
@@ -5,7 +5,7 @@
 except ImportError:
     raise SystemExit("PIL must be installed to run this example")
 
-import matplotlib.cbook as cbook
+import matplotlib.utils as utils
 
 datafile = cbook.get_sample_data('grace_hopper.jpg')
 lena = Image.open(datafile)