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

Skip to content

new MatplotlibDeprecationWarning class (against 1.2.x) #1596

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.

Sign up for GitHub

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

Merged
mdboom merged 2 commits into from
Dec 18, 2012
Merged

new MatplotlibDeprecationWarning class (against 1.2.x) #1596

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10351b3
new MatplotlibDeprecationWarning class
ivanov Dec 5, 2012
929d359
import new deprecation class as mplDeprecation
ivanov Dec 17, 2012
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
Next Next commit
new MatplotlibDeprecationWarning class 
In light of the fact that Python builtin DeprecationWarnings are ignored
by default as of Python 2.7 (see link below), this class was put in to
allow for the signaling of deprecation, but via UserWarnings which are
not ignored by default.

http://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x

Prior to this commit:

```
In [1]: %pylab

Welcome to pylab, a matplotlib-based Python environment [backend: agg].
For more information, type 'help(pylab)'.

In [2]: mlab.liaupunov([1,2], np.diff)
Out[2]: 0.0
```

After this commit:
```
In [1]: %pylab

Welcome to pylab, a matplotlib-based Python environment [backend: agg].
For more information, type 'help(pylab)'.

In [2]: mlab.liaupunov([1,2], np.diff)
/home/pi/.local/lib/python2.7/site-packages/matplotlib/mlab.py:1212:
MatplotlibDeprecationWarning: This does not belong in matplotlib and
will be removed
  mDeprecation) # 2009/06/13
Out[2]: 0.0
```
  • Loading branch information
@ivanov
ivanov committed Dec 14, 2012
commit 10351b33e3f4ca9200ce9832e05735e94bb290c1
10 changes: 10 additions & 0 deletions CHANGELOG
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
2012-12-05 Added MatplotlibDeprecationWarning class for signaling deprecation.
Matplotlib developers can use this class as follows:

from matplotlib import MatplotlibDeprecationWarning as mDeprecation

In light of the fact that Python builtin DeprecationWarnings are
ignored by default as of Python 2.7, this class was put in to allow
for the signaling of deprecation, but via UserWarnings which are
not ignored by default. - PI

2012-08-11 Fix path-closing bug in patches.Polygon, so that regardless
of whether the path is the initial one or was subsequently
set by set_xy(), get_xy() will return a closed path if and
Expand Down
14 changes: 14 additions & 0 deletions lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,20 @@
if not hasattr(sys, 'argv'): # for modpython
sys.argv = ['modpython']


class MatplotlibDeprecationWarning(UserWarning):
"""
A class for issuing deprecation warnings for Matplotlib users.

In light of the fact that Python builtin DeprecationWarnings are ignored
by default as of Python 2.7 (see link below), this class was put in to
allow for the signaling of deprecation, but via UserWarnings which are not
ignored by default.

http://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x
"""
pass

"""
Manage user customizations through a rc file.

Expand Down
42 changes: 21 additions & 21 deletions lib/matplotlib/axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import matplotlib.ticker as mticker
import matplotlib.transforms as mtransforms
import matplotlib.tri as mtri
from matplotlib import MatplotlibDeprecationWarning as mDeprecation
Copy link
Copy Markdown
Member

@mdboom mdboom Dec 17, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of renaming the variable here -- it makes it less clear what's happening in the lines below.

Copy link
Copy Markdown
Member

@dmcdougall dmcdougall Dec 17, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps something a little more verbose? mplDeprecationWarning?

Copy link
Copy Markdown
Member Author

@ivanov ivanov Dec 17, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does just mplDeprecation seem ok? The reason is that it's either being used in code like warnings.warn("message", mplDeprecationWarning) and we then have the word warn written three times on one line, but there are other places where this class is being raised as an exception, so it's not just being used to warn, but actually to throw an error.

I was using mDeprecation because I thought we have that as a convention for prepending an m for matplotlib internal imports (axes.py, axis.py, collections.py and contour.py utilize this for matplotlib module imports)

Copy link
Copy Markdown
Member

@mdboom mdboom Dec 17, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but in those cases, the m stands for module, which was the source of my confusion about this, at least. I think mplDeprecation would be fine and is a reasonable compromise.

Copy link
Copy Markdown
Member

@dmcdougall dmcdougall Dec 17, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mplDeprecation is fine by me!

from matplotlib.container import BarContainer, ErrorbarContainer, StemContainer

iterable = cbook.iterable
Expand Down Expand Up @@ -150,8 +151,7 @@ def set_default_color_cycle(clist):

"""
rcParams['axes.color_cycle'] = clist
warnings.warn("Set rcParams['axes.color_cycle'] directly",
DeprecationWarning)
warnings.warn("Set rcParams['axes.color_cycle'] directly", mDeprecation)


class _process_plot_var_args(object):
Expand Down Expand Up @@ -1376,11 +1376,11 @@ def get_child_artists(self):

.. deprecated:: 0.98
"""
raise DeprecationWarning('Use get_children instead')
raise mDeprecation('Use get_children instead')

def get_frame(self):
"""Return the axes Rectangle frame"""
warnings.warn('use ax.patch instead', DeprecationWarning)
warnings.warn('use ax.patch instead', mDeprecation)
return self.patch

def get_legend(self):
Expand Down Expand Up @@ -3112,13 +3112,13 @@ def connect(self, s, func):
disconnect to disconnect from the axes event

"""
raise DeprecationWarning('use the callbacks CallbackRegistry instance '
'instead')
raise mDeprecation('use the callbacks CallbackRegistry instance '
'instead')

def disconnect(self, cid):
"""disconnect from the Axes event."""
raise DeprecationWarning('use the callbacks CallbackRegistry instance '
'instead')
raise mDeprecation('use the callbacks CallbackRegistry instance '
'instead')

def get_children(self):
"""return a list of child artists"""
Expand Down Expand Up @@ -3167,10 +3167,10 @@ def pick(self, *args):
each child artist will fire a pick event if mouseevent is over
the artist and the artist has picker set
"""
if len(args)>1:
raise DeprecationWarning('New pick API implemented -- '
'see API_CHANGES in the src distribution')
martist.Artist.pick(self,args[0])
if len(args) > 1:
raise mDeprecation('New pick API implemented -- '
'see API_CHANGES in the src distribution')
martist.Artist.pick(self, args[0])

def __pick(self, x, y, trans=None, among=None):
"""
Expand Down Expand Up @@ -3730,9 +3730,9 @@ def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
.. plot:: mpl_examples/pylab_examples/hline_demo.py
"""
if kwargs.get('fmt') is not None:
raise DeprecationWarning('hlines now uses a '
'collections.LineCollection and not a '
'list of Line2D to draw; see API_CHANGES')
raise mDeprecation('hlines now uses a '
'collections.LineCollection and not a '
'list of Line2D to draw; see API_CHANGES')

# We do the conversion first since not all unitized data is uniform
# process the unit information
Expand Down Expand Up @@ -3810,9 +3810,9 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
"""

if kwargs.get('fmt') is not None:
raise DeprecationWarning('vlines now uses a '
'collections.LineCollection and not a '
'list of Line2D to draw; see API_CHANGES')
raise mDeprecation('vlines now uses a '
'collections.LineCollection and not a '
'list of Line2D to draw; see API_CHANGES')

self._process_unit_info(xdata=x, ydata=[ymin, ymax], kwargs=kwargs)

Expand Down Expand Up @@ -6086,7 +6086,7 @@ def scatter(self, x, y, s=20, c='b', marker='o', cmap=None, norm=None,
edgecolors = 'none'
warnings.warn(
'''replace "faceted=False" with "edgecolors='none'"''',
DeprecationWarning) #2008/04/18
mDeprecation) # 2008/04/18

sym = None
symstyle = 0
Expand Down Expand Up @@ -7999,7 +7999,7 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,


if kwargs.get('width') is not None:
raise DeprecationWarning(
raise mDeprecation(
'hist now uses the rwidth to give relative width '
'and not absolute width')

Expand Down Expand Up @@ -8715,7 +8715,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
"""
if precision is None:
precision = 0
warnings.DeprecationWarning("Use precision=0 instead of None")
warnings.warn("Use precision=0 instead of None", mDeprecation)
# 2008/10/03
if marker is None and markersize is None and hasattr(Z, 'tocoo'):
marker = 's'
Expand Down
3 changes: 2 additions & 1 deletion lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
import matplotlib.tight_bbox as tight_bbox
import matplotlib.textpath as textpath
from matplotlib.path import Path
from matplotlib import MatplotlibDeprecationWarning as mDeprecation

try:
from PIL import Image
Expand Down Expand Up @@ -2274,7 +2275,7 @@ def start_event_loop_default(self,timeout=0):
"""
str = "Using default event loop until function specific"
str += " to this GUI is implemented"
warnings.warn(str,DeprecationWarning)
warnings.warn(str, mDeprecation)

if timeout <= 0: timeout = np.inf
timestep = 0.01
Expand Down
4 changes: 3 additions & 1 deletion lib/matplotlib/backends/backend_qt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
import sys
import warnings

from matplotlib import MatplotlibDeprecationWarning as mDeprecation

warnings.warn("QT3-based backends are deprecated and will be removed after"
" the v1.2.x release. Use the equivalent QT4 backend instead.",
DeprecationWarning)
mDeprecation)

import matplotlib
from matplotlib import verbose
Expand Down
15 changes: 8 additions & 7 deletions lib/matplotlib/backends/backend_wx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

import numpy as np

from matplotlib import MatplotlibDeprecationWarning as mDeprecation

# Debugging settings here...
# Debug level set here. If the debug level is less than 5, information
Expand Down Expand Up @@ -792,7 +793,7 @@ def Printer_Init(self):

Deprecated.
"""
warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
self.printerData = wx.PrintData()
self.printerData.SetPaperId(wx.PAPER_LETTER)
self.printerData.SetPrintMode(wx.PRINT_MODE_PRINTER)
Expand All @@ -806,7 +807,7 @@ def Printer_Init(self):

def _get_printerData(self):
if self._printerData is None:
warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
self._printerData = wx.PrintData()
self._printerData.SetPaperId(wx.PAPER_LETTER)
self._printerData.SetPrintMode(wx.PRINT_MODE_PRINTER)
Expand All @@ -815,7 +816,7 @@ def _get_printerData(self):

def _get_printerPageData(self):
if self._printerPageData is None:
warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
self._printerPageData= wx.PageSetupDialogData()
self._printerPageData.SetMarginBottomRight((25,25))
self._printerPageData.SetMarginTopLeft((25,25))
Expand All @@ -834,7 +835,7 @@ def Printer_Setup(self, event=None):
dmsg = """Width of output figure in inches.
The current aspect ratio will be kept."""

warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
dlg = wx.Dialog(self, -1, 'Page Setup for Printing' , (-1,-1))
df = dlg.GetFont()
df.SetWeight(wx.NORMAL)
Expand Down Expand Up @@ -897,7 +898,7 @@ def Printer_Setup2(self, event=None):
Deprecated.
"""

warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
if hasattr(self, 'printerData'):
data = wx.PageSetupDialogData()
data.SetPrintData(self.printerData)
Expand All @@ -921,7 +922,7 @@ def Printer_Preview(self, event=None):

Deprecated.
"""
warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
po1 = PrintoutWx(self, width=self.printer_width,
margin=self.printer_margin)
po2 = PrintoutWx(self, width=self.printer_width,
Expand All @@ -947,7 +948,7 @@ def Printer_Print(self, event=None):

Deprecated.
"""
warnings.warn("Printer* methods will be removed", DeprecationWarning)
warnings.warn("Printer* methods will be removed", mDeprecation)
pdd = wx.PrintDialogData()
# SetPrintData for 2.4 combatibility
pdd.SetPrintData(self.printerData)
Expand Down
15 changes: 8 additions & 7 deletions lib/matplotlib/cbook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from weakref import ref, WeakKeyDictionary

import matplotlib
from matplotlib import MatplotlibDeprecationWarning as mDeprecation

import numpy as np
import numpy.ma as ma
Expand Down Expand Up @@ -281,7 +282,7 @@ def __init__(self, *args):
warnings.warn(
'CallbackRegistry no longer requires a list of callback types.'
' Ignoring arguments',
DeprecationWarning)
mDeprecation)
self.callbacks = dict()
self._cid = 0
self._func_cid_map = {}
Expand Down Expand Up @@ -1676,7 +1677,7 @@ def less_simple_linear_interpolation(x, y, xi, extrap=False):
# deprecated from cbook in 0.98.4
warnings.warn('less_simple_linear_interpolation has been moved to '
'matplotlib.mlab -- please import it from there',
DeprecationWarning)
mDeprecation)
import matplotlib.mlab as mlab
return mlab.less_simple_linear_interpolation(x, y, xi, extrap=extrap)

Expand All @@ -1688,7 +1689,7 @@ def vector_lengths(X, P=2.0, axis=None):
"""
# deprecated from cbook in 0.98.4
warnings.warn('vector_lengths has been moved to matplotlib.mlab -- '
'please import it from there', DeprecationWarning)
'please import it from there', mDeprecation)
import matplotlib.mlab as mlab
return mlab.vector_lengths(X, P=2.0, axis=axis)

Expand All @@ -1700,7 +1701,7 @@ def distances_along_curve(X):
"""
# deprecated from cbook in 0.98.4
warnings.warn('distances_along_curve has been moved to matplotlib.mlab '
'-- please import it from there', DeprecationWarning)
'-- please import it from there', mDeprecation)
import matplotlib.mlab as mlab
return mlab.distances_along_curve(X)

Expand All @@ -1712,7 +1713,7 @@ def path_length(X):
"""
# deprecated from cbook in 0.98.4
warnings.warn('path_length has been moved to matplotlib.mlab '
'-- please import it from there', DeprecationWarning)
'-- please import it from there', mDeprecation)
import matplotlib.mlab as mlab
return mlab.path_length(X)

Expand All @@ -1724,7 +1725,7 @@ def is_closed_polygon(X):
"""
# deprecated from cbook in 0.98.4
warnings.warn('is_closed_polygon has been moved to matplotlib.mlab '
'-- please import it from there', DeprecationWarning)
'-- please import it from there', mDeprecation)
import matplotlib.mlab as mlab
return mlab.is_closed_polygon(X)

Expand All @@ -1736,7 +1737,7 @@ def quad2cubic(q0x, q0y, q1x, q1y, q2x, q2y):
"""
# deprecated from cbook in 0.98.4
warnings.warn('quad2cubic has been moved to matplotlib.mlab -- please '
'import it from there', DeprecationWarning)
'import it from there', mDeprecation)
import matplotlib.mlab as mlab
return mlab.quad2cubic(q0x, q0y, q1x, q1y, q2x, q2y)

Expand Down
3 changes: 2 additions & 1 deletion lib/matplotlib/legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
from matplotlib.offsetbox import DraggableOffsetBox

from matplotlib.container import ErrorbarContainer, BarContainer, StemContainer
from matplotlib import MatplotlibDeprecationWarning as mDeprecation
import legend_handler


Expand Down Expand Up @@ -278,7 +279,7 @@ def __init__(self, parent, handles, labels,
# counter part is None.
if localdict[k] is not None and localdict[v] is None:
warnings.warn("Use '%s' instead of '%s'." % (v, k),
DeprecationWarning)
mDeprecation)
setattr(self, v, localdict[k] * axessize_fontsize)
continue

Expand Down
8 changes: 5 additions & 3 deletions lib/matplotlib/mlab.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@
import numpy as np
ma = np.ma
from matplotlib import verbose
from matplotlib import MatplotlibDeprecationWarning as mDeprecation

import matplotlib.cbook as cbook
from matplotlib import docstring
Expand Down Expand Up @@ -1207,7 +1208,8 @@ def liaupunov(x, fprime):
It also seems that this function's name is badly misspelled.
"""

warnings.warn("This does not belong in matplotlib and will be removed", DeprecationWarning) # 2009/06/13
warnings.warn("This does not belong in matplotlib and will be removed",
mDeprecation) # 2009/06/13

return np.mean(np.log(np.absolute(fprime(x))))

Expand Down Expand Up @@ -1339,7 +1341,7 @@ def save(fname, X, fmt='%.18e',delimiter=' '):
for comma-separated values.
"""

warnings.warn("use numpy.savetxt", DeprecationWarning) # 2009/06/13
warnings.warn("use numpy.savetxt", mDeprecation) # 2009/06/13

if cbook.is_string_like(fname):
if fname.endswith('.gz'):
Expand Down Expand Up @@ -1426,7 +1428,7 @@ def load(fname,comments='#',delimiter=None, converters=None,skiprows=0,
Exercises many of these options.
"""

warnings.warn("use numpy.loadtxt", DeprecationWarning) # 2009/06/13
warnings.warn("use numpy.loadtxt", mDeprecation) # 2009/06/13

if converters is None: converters = {}
fh = cbook.to_filehandle(fname)
Expand Down
Loading