Remove mplDeprecation which is just an alias to MatplotlibDeprecationWarning

timhoffm · timhoffm · commit 0a35d2adfd31 · 2018-05-16T07:46:19.000+02:00
diff --git a/doc/api/next_api_changes/2018-05-16-TH.rst b/doc/api/next_api_changes/2018-05-16-TH.rst
@@ -0,0 +1,7 @@
+``matplotlib.cbook.deprecation.mplDeprecation`` is deprecated
+`````````````````````````````````````````````````````````````
+
+:class:`matplotlib.cbook.deprecation.mplDeprecation` will be removed in
+future versions. It is just an for
+:class:`matplotlib.cbook.deprecation.MatplotlibDeprecationWarning`.
+Please use the :class:`~.MatplotlibDeprecationWarning` directly if neccessary.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -142,7 +142,7 @@
 # definitions, so it is safe to import from it here.
 from . import cbook
 from matplotlib.cbook import (
-    mplDeprecation, dedent, get_label, sanitize_sequence)
+    MatplotlibDeprecationWarning, dedent, get_label, sanitize_sequence)
 from matplotlib.rcsetup import defaultParams, validate_backend, cycler
 
 import numpy
@@ -858,24 +858,24 @@ def __setitem__(self, key, val):
             if key in _deprecated_map:
                 alt_key, alt_val, inverse_alt = _deprecated_map[key]
                 warnings.warn(self.msg_depr % (key, alt_key),
-                              mplDeprecation)
+                              MatplotlibDeprecationWarning)
                 key = alt_key
                 val = alt_val(val)
             elif key in _deprecated_set and val is not None:
                 if key.startswith('backend'):
                     warnings.warn(self.msg_backend_obsolete.format(key),
-                                  mplDeprecation)
+                                  MatplotlibDeprecationWarning)
                 else:
                     warnings.warn(self.msg_depr_set % key,
-                                  mplDeprecation)
+                                  MatplotlibDeprecationWarning)
             elif key in _deprecated_ignore_map:
                 alt = _deprecated_ignore_map[key]
                 warnings.warn(self.msg_depr_ignore % (key, alt),
-                              mplDeprecation)
+                              MatplotlibDeprecationWarning)
                 return
             elif key in _obsolete_set:
                 warnings.warn(self.msg_obsolete % (key, ),
-                              mplDeprecation)
+                              MatplotlibDeprecationWarning)
                 return
             try:
                 cval = self.validate[key](val)
@@ -892,18 +892,18 @@ def __getitem__(self, key):
         if key in _deprecated_map:
             alt_key, alt_val, inverse_alt = _deprecated_map[key]
             warnings.warn(self.msg_depr % (key, alt_key),
-                          mplDeprecation)
+                          MatplotlibDeprecationWarning)
             key = alt_key
 
         elif key in _deprecated_ignore_map:
             alt = _deprecated_ignore_map[key]
             warnings.warn(self.msg_depr_ignore % (key, alt),
-                          mplDeprecation)
+                          MatplotlibDeprecationWarning)
             key = alt
 
         elif key in _obsolete_set:
             warnings.warn(self.msg_obsolete % (key, ),
-                          mplDeprecation)
+                          MatplotlibDeprecationWarning)
             return None
 
         val = dict.__getitem__(self, key)
@@ -1052,7 +1052,7 @@ def _rc_params_in_file(fname, fail_on_error=False):
         elif key in _deprecated_ignore_map:
             warnings.warn('%s is deprecated. Update your matplotlibrc to use '
                           '%s instead.' % (key, _deprecated_ignore_map[key]),
-                          mplDeprecation)
+                          MatplotlibDeprecationWarning)
 
         else:
             print("""
@@ -1087,7 +1087,7 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):
 
     iter_params = defaultParams.items()
     with warnings.catch_warnings():
-        warnings.simplefilter("ignore", mplDeprecation)
+        warnings.simplefilter("ignore", MatplotlibDeprecationWarning)
         config = RcParams([(key, default) for key, (default, _) in iter_params
                            if key not in _all_deprecated])
     config.update(config_from_file)
@@ -1128,7 +1128,7 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):
 rcParamsOrig = rcParams.copy()
 
 with warnings.catch_warnings():
-    warnings.simplefilter("ignore", mplDeprecation)
+    warnings.simplefilter("ignore", MatplotlibDeprecationWarning)
     rcParamsDefault = RcParams([(key, default) for key, (default, converter) in
                                 defaultParams.items()
                                 if key not in _all_deprecated])
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -34,7 +34,7 @@
 import matplotlib.transforms as mtransforms
 import matplotlib.tri as mtri
 from matplotlib.cbook import (
-    mplDeprecation, warn_deprecated, STEP_LOOKUP_MAP, iterable,
+    MatplotlibDeprecationWarning, warn_deprecated, STEP_LOOKUP_MAP, iterable,
     safe_first_element)
 from matplotlib.container import BarContainer, ErrorbarContainer, StemContainer
 from matplotlib.axes._base import _AxesBase, _process_plot_format
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1335,7 +1335,7 @@ def set_adjustable(self, adjustable, share=False):
         """
         if adjustable == 'box-forced':
             warnings.warn("The 'box-forced' keyword argument is deprecated"
-                          " since 2.2.", cbook.mplDeprecation)
+                          " since 2.2.", cbook.MatplotlibDeprecationWarning)
         if adjustable not in ('box', 'datalim', 'box-forced'):
             raise ValueError("argument must be 'box', or 'datalim'")
         if share:
diff --git a/lib/matplotlib/axes/_subplots.py b/lib/matplotlib/axes/_subplots.py
@@ -4,7 +4,6 @@
 from matplotlib import docstring
 import matplotlib.artist as martist
 from matplotlib.axes._axes import Axes
-from matplotlib.cbook import mplDeprecation
 from matplotlib.gridspec import GridSpec, SubplotSpec
 import matplotlib._layoutbox as layoutbox
 
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -31,8 +31,8 @@
 import numpy as np
 
 import matplotlib
-from .deprecation import deprecated, warn_deprecated
-from .deprecation import mplDeprecation, MatplotlibDeprecationWarning
+from .deprecation import (
+    deprecated, warn_deprecated, MatplotlibDeprecationWarning)
 
 
 @deprecated("3.0")
diff --git a/lib/matplotlib/cbook/deprecation.py b/lib/matplotlib/cbook/deprecation.py
@@ -18,6 +18,7 @@ class MatplotlibDeprecationWarning(UserWarning):
 
 
 mplDeprecation = MatplotlibDeprecationWarning
+"""mplDeprecation is deprecated. Use MatplotlibDeprecationWarning instead."""
 
 
 def _generate_deprecation_message(
@@ -100,7 +101,7 @@ def warn_deprecated(
     """
     message = _generate_deprecation_message(
         since, message, name, alternative, pending, obj_type, removal=removal)
-    warnings.warn(message, mplDeprecation, stacklevel=2)
+    warnings.warn(message, MatplotlibDeprecationWarning, stacklevel=2)
 
 
 def deprecated(since, message='', name='', alternative='', pending=False,
@@ -205,7 +206,7 @@ def finalize(wrapper, new_doc):
             removal=removal)
 
         def wrapper(*args, **kwargs):
-            warnings.warn(message, mplDeprecation, stacklevel=2)
+            warnings.warn(message, MatplotlibDeprecationWarning, stacklevel=2)
             return func(*args, **kwargs)
 
         old_doc = textwrap.dedent(old_doc or '').strip('\n')
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -23,7 +23,7 @@
 from matplotlib import _pylab_helpers, tight_layout, rcParams
 from matplotlib.transforms import Bbox
 import matplotlib._layoutbox as layoutbox
-from matplotlib.cbook import mplDeprecation
+from matplotlib.cbook import MatplotlibDeprecationWarning
 
 _log = logging.getLogger(__name__)
 
@@ -266,7 +266,7 @@ def get_subplot_params(self, figure=None, fig=None):
         """
         if fig is not None:
             warnings.warn("the 'fig' kwarg is deprecated "
-                          "use 'figure' instead", mplDeprecation)
+                          "use 'figure' instead", MatplotlibDeprecationWarning)
         if figure is None:
             figure = fig
 
@@ -356,7 +356,7 @@ def get_subplot_params(self, figure=None, fig=None):
         """
         if fig is not None:
             warnings.warn("the 'fig' kwarg is deprecated "
-                          "use 'figure' instead", mplDeprecation)
+                          "use 'figure' instead", MatplotlibDeprecationWarning)
         if figure is None:
             figure = fig
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2127,9 +2127,9 @@ def plotfile(fname, cols=(0,), plotfuncs=None,
 
     if plotfuncs is None:
         plotfuncs = dict()
-    from matplotlib.cbook import mplDeprecation
+    from matplotlib.cbook import MatplotlibDeprecationWarning
     with warnings.catch_warnings():
-        warnings.simplefilter('ignore', mplDeprecation)
+        warnings.simplefilter('ignore', MatplotlibDeprecationWarning)
         r = mlab.csv2rec(fname, comments=comments, skiprows=skiprows,
                          checkrows=checkrows, delimiter=delimiter, names=names)
 
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -23,7 +23,8 @@
 import re
 
 from matplotlib import cbook
-from matplotlib.cbook import mplDeprecation, deprecated, ls_mapper
+from matplotlib.cbook import (
+    MatplotlibDeprecationWarning, deprecated, ls_mapper)
 from matplotlib.fontconfig_pattern import parse_fontconfig_pattern
 from matplotlib.colors import is_color_like
 
diff --git a/lib/matplotlib/tests/test_cycles.py b/lib/matplotlib/tests/test_cycles.py
@@ -1,7 +1,6 @@
 import warnings
 
 from matplotlib.testing.decorators import image_comparison
-from matplotlib.cbook import MatplotlibDeprecationWarning
 import matplotlib.pyplot as plt
 import numpy as np
 import pytest
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -174,7 +174,6 @@
 from matplotlib import rcParams
 from matplotlib import cbook
 from matplotlib import transforms as mtransforms
-from matplotlib.cbook import mplDeprecation
 
 import warnings
 
