import new deprecation class as mplDeprecation

Author: ivanov

CHANGELOG

@@ -1,7 +1,7 @@
 2012-12-05 Added MatplotlibDeprecationWarning class for signaling deprecation.
            Matplotlib developers can use this class as follows:
 
-           from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+           from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
            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

lib/matplotlib/axes.py

@@ -37,7 +37,7 @@
 import matplotlib.ticker as mticker
 import matplotlib.transforms as mtransforms
 import matplotlib.tri as mtri
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 from matplotlib.container import BarContainer, ErrorbarContainer, StemContainer
 
 iterable = cbook.iterable
@@ -1376,11 +1376,11 @@ def get_child_artists(self):
 
         .. deprecated:: 0.98
         """
-        raise mDeprecation('Use get_children instead')
+        raise mplDeprecation('Use get_children instead')
 
     def get_frame(self):
         """Return the axes Rectangle frame"""
-        warnings.warn('use ax.patch instead', mDeprecation)
+        warnings.warn('use ax.patch instead', mplDeprecation)
         return self.patch
 
     def get_legend(self):
@@ -3135,13 +3135,13 @@ def connect(self, s, func):
         disconnect to disconnect from the axes event
 
         """
-        raise mDeprecation('use the callbacks CallbackRegistry instance '
-                           'instead')
+        raise mplDeprecation('use the callbacks CallbackRegistry instance '
+                             'instead')
 
     def disconnect(self, cid):
         """disconnect from the Axes event."""
-        raise mDeprecation('use the callbacks CallbackRegistry instance '
-                           'instead')
+        raise mplDeprecation('use the callbacks CallbackRegistry instance '
+                             'instead')
 
     def get_children(self):
         """return a list of child artists"""
@@ -3192,8 +3192,8 @@ def pick(self, *args):
         the artist and the artist has picker set
         """
         if len(args) > 1:
-            raise mDeprecation('New pick API implemented -- '
-                               'see API_CHANGES in the src distribution')
+            raise mplDeprecation('New pick API implemented -- '
+                                 'see API_CHANGES in the src distribution')
         martist.Artist.pick(self, args[0])
 
     ### Labelling
@@ -3691,9 +3691,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 mDeprecation('hlines now uses a '
-                               'collections.LineCollection and not a '
-                               'list of Line2D to draw; see API_CHANGES')
+            raise mplDeprecation('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
@@ -3773,9 +3773,9 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
         """
 
         if kwargs.get('fmt') is not None:
-            raise mDeprecation('vlines now uses a '
-                               'collections.LineCollection and not a '
-                               'list of Line2D to draw; see API_CHANGES')
+            raise mplDeprecation('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)
 
@@ -6074,7 +6074,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'"''',
-                mDeprecation)  # 2008/04/18
+                mplDeprecation)  # 2008/04/18
 
         # to be API compatible
         if marker is None and not (verts is None):
@@ -8002,7 +8002,7 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
                 "orientation kwarg %s is not recognized" % orientation)
 
         if kwargs.get('width') is not None:
-            raise mDeprecation(
+            raise mplDeprecation(
                 'hist now uses the rwidth to give relative width '
                 'and not absolute width')
 
@@ -8735,7 +8735,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
         """
         if precision is None:
             precision = 0
-            warnings.warn("Use precision=0 instead of None", mDeprecation)
+            warnings.warn("Use precision=0 instead of None", mplDeprecation)
             # 2008/10/03
         if marker is None and markersize is None and hasattr(Z, 'tocoo'):
             marker = 's'

lib/matplotlib/backend_bases.py

@@ -48,7 +48,7 @@
 import matplotlib.tight_bbox as tight_bbox
 import matplotlib.textpath as textpath
 from matplotlib.path import Path
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 try:
     from PIL import Image
@@ -2307,7 +2307,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, mDeprecation)
+        warnings.warn(str, mplDeprecation)
 
         if timeout <= 0:
             timeout = np.inf

lib/matplotlib/backends/backend_qt.py

@@ -4,11 +4,11 @@
 import sys
 import warnings
 
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 warnings.warn("QT3-based backends are deprecated and will be removed after"
               " the v1.2.x release. Use the equivalent QT4 backend instead.",
-              mDeprecation)
+              mplDeprecation)
 
 import matplotlib
 from matplotlib import verbose

lib/matplotlib/backends/backend_wx.py

@@ -25,7 +25,7 @@
 
 import numpy as np
 
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 # Debugging settings here...
 # Debug level set here. If the debug level is less than 5, information
@@ -789,7 +789,7 @@ def Printer_Init(self):
 
         Deprecated.
         """
-        warnings.warn("Printer* methods will be removed", mDeprecation)
+        warnings.warn("Printer* methods will be removed", mplDeprecation)
         self.printerData = wx.PrintData()
         self.printerData.SetPaperId(wx.PAPER_LETTER)
         self.printerData.SetPrintMode(wx.PRINT_MODE_PRINTER)
@@ -803,7 +803,7 @@ def Printer_Init(self):
 
     def _get_printerData(self):
         if self._printerData is None:
-            warnings.warn("Printer* methods will be removed", mDeprecation)
+            warnings.warn("Printer* methods will be removed", mplDeprecation)
             self._printerData = wx.PrintData()
             self._printerData.SetPaperId(wx.PAPER_LETTER)
             self._printerData.SetPrintMode(wx.PRINT_MODE_PRINTER)
@@ -812,7 +812,7 @@ def _get_printerData(self):
 
     def _get_printerPageData(self):
         if self._printerPageData is None:
-            warnings.warn("Printer* methods will be removed", mDeprecation)
+            warnings.warn("Printer* methods will be removed", mplDeprecation)
             self._printerPageData= wx.PageSetupDialogData()
             self._printerPageData.SetMarginBottomRight((25,25))
             self._printerPageData.SetMarginTopLeft((25,25))
@@ -831,7 +831,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", mDeprecation)
+        warnings.warn("Printer* methods will be removed", mplDeprecation)
         dlg = wx.Dialog(self, -1, 'Page Setup for Printing' , (-1,-1))
         df = dlg.GetFont()
         df.SetWeight(wx.NORMAL)
@@ -894,7 +894,7 @@ def Printer_Setup2(self, event=None):
         Deprecated.
         """
 
-        warnings.warn("Printer* methods will be removed", mDeprecation)
+        warnings.warn("Printer* methods will be removed", mplDeprecation)
         if hasattr(self, 'printerData'):
             data = wx.PageSetupDialogData()
             data.SetPrintData(self.printerData)
@@ -918,7 +918,7 @@ def Printer_Preview(self, event=None):
 
         Deprecated.
         """
-        warnings.warn("Printer* methods will be removed", mDeprecation)
+        warnings.warn("Printer* methods will be removed", mplDeprecation)
         po1  = PrintoutWx(self, width=self.printer_width,
                           margin=self.printer_margin)
         po2  = PrintoutWx(self, width=self.printer_width,
@@ -944,7 +944,7 @@ def Printer_Print(self, event=None):
 
         Deprecated.
         """
-        warnings.warn("Printer* methods will be removed", mDeprecation)
+        warnings.warn("Printer* methods will be removed", mplDeprecation)
         pdd = wx.PrintDialogData()
         # SetPrintData for 2.4 combatibility
         pdd.SetPrintData(self.printerData)

lib/matplotlib/cbook.py

@@ -22,7 +22,7 @@
 from weakref import ref, WeakKeyDictionary
 
 import matplotlib
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 import numpy as np
 import numpy.ma as ma
@@ -282,7 +282,7 @@ def __init__(self, *args):
             warnings.warn(
                 'CallbackRegistry no longer requires a list of callback types.'
                 ' Ignoring arguments',
-                mDeprecation)
+                mplDeprecation)
         self.callbacks = dict()
         self._cid = 0
         self._func_cid_map = {}
@@ -1677,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',
-                  mDeprecation)
+                  mplDeprecation)
     import matplotlib.mlab as mlab
     return mlab.less_simple_linear_interpolation(x, y, xi, extrap=extrap)
 
@@ -1689,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', mDeprecation)
+                  'please import it from there', mplDeprecation)
     import matplotlib.mlab as mlab
     return mlab.vector_lengths(X, P=2.0, axis=axis)
 
@@ -1701,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', mDeprecation)
+                  '-- please import it from there', mplDeprecation)
     import matplotlib.mlab as mlab
     return mlab.distances_along_curve(X)
 
@@ -1713,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', mDeprecation)
+                  '-- please import it from there', mplDeprecation)
     import matplotlib.mlab as mlab
     return mlab.path_length(X)
 
@@ -1725,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', mDeprecation)
+                  '-- please import it from there', mplDeprecation)
     import matplotlib.mlab as mlab
     return mlab.is_closed_polygon(X)
 
@@ -1737,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', mDeprecation)
+                  'import it from there', mplDeprecation)
     import matplotlib.mlab as mlab
     return mlab.quad2cubic(q0x, q0y, q1x, q1y, q2x, q2y)
 

lib/matplotlib/legend.py

@@ -31,7 +31,7 @@
 from matplotlib.offsetbox import DraggableOffsetBox
 
 from matplotlib.container import ErrorbarContainer, BarContainer, StemContainer
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 import legend_handler
 
 
@@ -279,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),
-                              mDeprecation)
+                              mplDeprecation)
                 setattr(self, v, localdict[k] * axessize_fontsize)
                 continue
 

lib/matplotlib/mlab.py

@@ -148,7 +148,7 @@
 import numpy as np
 ma = np.ma
 from matplotlib import verbose
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 import matplotlib.cbook as cbook
 from matplotlib import docstring
@@ -1209,7 +1209,7 @@ def liaupunov(x, fprime):
     """
 
     warnings.warn("This does not belong in matplotlib and will be removed",
-                    mDeprecation) # 2009/06/13
+                  mplDeprecation) # 2009/06/13
 
     return np.mean(np.log(np.absolute(fprime(x))))
 
@@ -1341,7 +1341,7 @@ def save(fname, X, fmt='%.18e',delimiter=' '):
     for comma-separated values.
     """
 
-    warnings.warn("use numpy.savetxt", mDeprecation)  # 2009/06/13
+    warnings.warn("use numpy.savetxt", mplDeprecation)  # 2009/06/13
 
     if cbook.is_string_like(fname):
         if fname.endswith('.gz'):
@@ -1428,7 +1428,7 @@ def load(fname,comments='#',delimiter=None, converters=None,skiprows=0,
            Exercises many of these options.
     """
 
-    warnings.warn("use numpy.loadtxt", mDeprecation)  # 2009/06/13
+    warnings.warn("use numpy.loadtxt", mplDeprecation)  # 2009/06/13
 
     if converters is None: converters = {}
     fh = cbook.to_filehandle(fname)

lib/matplotlib/nxutils.py

@@ -1,7 +1,7 @@
 import warnings
 
 from matplotlib import path
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 def pnpoly(x, y, xyverts):
     """
@@ -20,7 +20,7 @@ def pnpoly(x, y, xyverts):
     warnings.warn(
         "nxutils is deprecated.  Use matplotlib.path.Path.contains_point"
         " instead.",
-        mDeprecation)
+        mplDeprecation)
 
     p = path.Path(xyverts)
     return p.contains_point(x, y)
@@ -45,7 +45,7 @@ def points_inside_poly(xypoints, xyverts):
     warnings.warn(
         "nxutils is deprecated.  Use matplotlib.path.Path.contains_points"
         " instead.",
-        mDeprecation)
+        mplDeprecation)
 
     p = path.Path(xyverts)
     return p.contains_points(xypoints)

lib/matplotlib/patches.py

@@ -12,7 +12,7 @@
 from matplotlib import docstring
 import matplotlib.transforms as transforms
 from matplotlib.path import Path
-from matplotlib import MatplotlibDeprecationWarning as mDeprecation
+from matplotlib import MatplotlibDeprecationWarning as mplDeprecation
 
 # these are not available for the object inspector until after the
 # class is built so we define an initial set here for the init
@@ -1275,7 +1275,7 @@ def __init__(self, xy, radius=5, **kwargs):
             import warnings
             warnings.warn('Circle is now scale free.  '
                           'Use CirclePolygon instead!',
-                          mDeprecation)
+                          mplDeprecation)
             kwargs.pop('resolution')
 
         self.radius = radius