Thanks to visit codestin.com
Credit goes to github.com

Skip to content

WIP: Deprecation of the cbook module #1647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 16 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
1 change: 1 addition & 0 deletions doc/api/api_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
================
Expand Down
1 change: 0 additions & 1 deletion doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions doc/devel/coding_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/mpl_toolkits/axes_grid/figures/simple_rgb.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions doc/users/recipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/animation/old_animation/draggable_legend.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions examples/api/date_demo.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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()
Expand Down
4 changes: 2 additions & 2 deletions examples/api/date_index_formatter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions examples/api/watermark_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/demo_axes_divider.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/demo_axes_grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/demo_axes_grid2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/demo_axes_rgb.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/axes_grid/demo_curvelinear_grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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))

Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/demo_edge_colorbar.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/inset_locator_demo2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/axes_grid/simple_axesgrid2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/misc/developer_commit_history.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"')
Expand Down
2 changes: 1 addition & 1 deletion examples/misc/rc_traits.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/misc/rec_groupby_demo.py
Original file line number Diff line number Diff line change
@@ -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()
Expand Down
4 changes: 2 additions & 2 deletions examples/misc/rec_join_demo.py
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
2 changes: 1 addition & 1 deletion examples/misc/sample_data_demo.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions examples/pylab_examples/centered_ticklabels.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 6 additions & 4 deletions examples/pylab_examples/data_helper.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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) )
Expand All @@ -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:]:
Expand Down
4 changes: 2 additions & 2 deletions examples/pylab_examples/date_index_formatter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:]

Expand Down
2 changes: 1 addition & 1 deletion examples/pylab_examples/demo_annotation_box.py
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/pylab_examples/demo_ribbon_box.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
2 changes: 1 addition & 1 deletion examples/pylab_examples/demo_text_path.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions examples/pylab_examples/image_demo2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/pylab_examples/image_demo3.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading