Move cbook._suppress_matplotlib_deprecation_warning() from cbook to _api

Author: timhoffm

lib/matplotlib/__init__.py

@@ -104,7 +104,7 @@
 
 # cbook must import matplotlib only within function
 # definitions, so it is safe to import from it here.
-from . import cbook, docstring, rcsetup
+from . import _api, cbook, docstring, rcsetup
 from matplotlib.cbook import MatplotlibDeprecationWarning, sanitize_sequence
 from matplotlib.cbook import mplDeprecation  # deprecated
 from matplotlib.rcsetup import validate_backend, cycler
@@ -665,7 +665,7 @@ def __getitem__(self, key):
     def __repr__(self):
         class_name = self.__class__.__name__
         indent = len(class_name) + 1
-        with cbook._suppress_matplotlib_deprecation_warning():
+        with _api.suppress_matplotlib_deprecation_warning():
             repr_split = pprint.pformat(dict(self), indent=1,
                                         width=80 - indent).split('\n')
         repr_indented = ('\n' + ' ' * indent).join(repr_split)
@@ -676,7 +676,7 @@ def __str__(self):
 
     def __iter__(self):
         """Yield sorted list of keys."""
-        with cbook._suppress_matplotlib_deprecation_warning():
+        with _api.suppress_matplotlib_deprecation_warning():
             yield from sorted(dict.__iter__(self))
 
     def __len__(self):
@@ -840,10 +840,10 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):
     if not use_default_template:
         return config_from_file
 
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         config = RcParams({**rcParamsDefault, **config_from_file})
 
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         if config['datapath'] is None:
             config['datapath'] = _get_data_path()
         else:
@@ -874,7 +874,7 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):
 rcParams = RcParams()  # The global instance.
 dict.update(rcParams, dict.items(rcParamsDefault))
 dict.update(rcParams, _rc_params_in_file(matplotlib_fname()))
-with cbook._suppress_matplotlib_deprecation_warning():
+with _api.suppress_matplotlib_deprecation_warning():
     rcParamsOrig = RcParams(rcParams.copy())
     # This also checks that all rcParams are indeed listed in the template.
     # Assiging to rcsetup.defaultParams is left only for backcompat.
@@ -982,7 +982,7 @@ def rcdefaults():
     """
     # Deprecation warnings were already handled when creating rcParamsDefault,
     # no need to reemit them here.
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         from .style.core import STYLE_BLACKLIST
         rcParams.clear()
         rcParams.update({k: v for k, v in rcParamsDefault.items()
@@ -998,7 +998,7 @@ def rc_file_defaults():
     """
     # Deprecation warnings were already handled when creating rcParamsOrig, no
     # need to reemit them here.
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         from .style.core import STYLE_BLACKLIST
         rcParams.update({k: rcParamsOrig[k] for k in rcParamsOrig
                          if k not in STYLE_BLACKLIST})
@@ -1023,7 +1023,7 @@ def rc_file(fname, *, use_default_template=True):
     """
     # Deprecation warnings were already handled in rc_params_from_file, no need
     # to reemit them here.
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         from .style.core import STYLE_BLACKLIST
         rc_from_file = rc_params_from_file(
             fname, use_default_template=use_default_template)

lib/matplotlib/cbook/__init__.py

@@ -35,8 +35,6 @@
     deprecated, warn_deprecated,
     _rename_parameter, _delete_parameter, _make_keyword_only,
     _deprecate_method_override, _deprecate_privatize_attribute,
-    suppress_matplotlib_deprecation_warning as
-    _suppress_matplotlib_deprecation_warning,
     MatplotlibDeprecationWarning, mplDeprecation)
 
 

lib/matplotlib/mathtext.py

@@ -384,7 +384,7 @@ def factory(cls, glue_type):
         return cls._types[glue_type]
 
 
-with cbook._suppress_matplotlib_deprecation_warning():
+with _api.suppress_matplotlib_deprecation_warning():
     GlueSpec._types = {k: GlueSpec(**v._asdict())
                        for k, v in _mathtext._GlueSpec._named.items()}
 

lib/matplotlib/style/core.py

@@ -19,7 +19,7 @@
 import warnings
 
 import matplotlib as mpl
-from matplotlib import cbook, rc_params_from_file, rcParamsDefault
+from matplotlib import _api, cbook, rc_params_from_file, rcParamsDefault
 
 _log = logging.getLogger(__name__)
 
@@ -106,7 +106,7 @@ def use(style):
         elif style == 'default':
             # Deprecation warnings were already handled when creating
             # rcParamsDefault, no need to reemit them here.
-            with cbook._suppress_matplotlib_deprecation_warning():
+            with _api.suppress_matplotlib_deprecation_warning():
                 _apply_style(rcParamsDefault, warn=False)
         elif style in library:
             _apply_style(library[style])

lib/matplotlib/testing/__init__.py

@@ -6,7 +6,7 @@
 import logging
 
 import matplotlib as mpl
-from matplotlib import cbook
+from matplotlib import _api
 
 _log = logging.getLogger(__name__)
 
@@ -37,7 +37,7 @@ def setup():
 
     mpl.use('Agg')
 
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         mpl.rcdefaults()  # Start with all defaults
 
     # These settings *must* be hardcoded for running the comparison tests and

lib/matplotlib/testing/conftest.py

@@ -1,7 +1,7 @@
 import pytest
 import sys
 import matplotlib
-from matplotlib import cbook
+from matplotlib import _api, cbook
 
 
 def pytest_configure(config):
@@ -79,7 +79,7 @@ def mpl_test_settings(request):
             style, = style_marker.args
 
         matplotlib.testing.setup()
-        with cbook._suppress_matplotlib_deprecation_warning():
+        with _api.suppress_matplotlib_deprecation_warning():
             if backend is not None:
                 # This import must come after setup() so it doesn't load the
                 # default backend prematurely.

lib/matplotlib/tests/test_axes.py

@@ -5664,7 +5664,7 @@ def test_ls_ds_conflict():
     # Passing the drawstyle with the linestyle is deprecated since 3.1.
     # We still need to test this until it's removed from the code.
     # But we don't want to see the deprecation warning in the test.
-    with matplotlib.cbook._suppress_matplotlib_deprecation_warning(), \
+    with matplotlib._api.suppress_matplotlib_deprecation_warning(), \
          pytest.raises(ValueError):
         plt.plot(range(32), linestyle='steps-pre:', drawstyle='steps-post')
 

lib/matplotlib/tests/test_cbook.py

@@ -329,14 +329,14 @@ def test_sanitize_sequence():
 @pytest.mark.parametrize('inp, kwargs_to_norm', fail_mapping)
 def test_normalize_kwargs_fail(inp, kwargs_to_norm):
     with pytest.raises(TypeError), \
-         cbook._suppress_matplotlib_deprecation_warning():
+         _api.suppress_matplotlib_deprecation_warning():
         cbook.normalize_kwargs(inp, **kwargs_to_norm)
 
 
 @pytest.mark.parametrize('inp, expected, kwargs_to_norm',
                          pass_mapping)
 def test_normalize_kwargs_pass(inp, expected, kwargs_to_norm):
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         # No other warning should be emitted.
         assert expected == cbook.normalize_kwargs(inp, **kwargs_to_norm)
 

lib/matplotlib/tests/test_mathtext.py

@@ -8,7 +8,7 @@
 import matplotlib as mpl
 from matplotlib.testing.decorators import check_figures_equal, image_comparison
 import matplotlib.pyplot as plt
-from matplotlib import cbook, mathtext
+from matplotlib import _api, mathtext
 
 
 # If test is removed, use None as placeholder
@@ -357,7 +357,7 @@ def test_math_to_image(tmpdir):
 
 
 def test_mathtext_to_png(tmpdir):
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         mt = mathtext.MathTextParser('bitmap')
         mt.to_png(str(tmpdir.join('example.png')), '$x^2$')
         mt.to_png(io.BytesIO(), '$x^2$')

lib/matplotlib/tests/test_rcparams.py

@@ -10,7 +10,7 @@
 import pytest
 
 import matplotlib as mpl
-from matplotlib import cbook
+from matplotlib import _api
 import matplotlib.pyplot as plt
 import matplotlib.colors as mcolors
 import numpy as np
@@ -125,7 +125,7 @@ def test_Bug_2543():
     # We filter warnings at this stage since a number of them are raised
     # for deprecated rcparams as they should. We don't want these in the
     # printed in the test suite.
-    with cbook._suppress_matplotlib_deprecation_warning():
+    with _api.suppress_matplotlib_deprecation_warning():
         with mpl.rc_context():
             _copy = mpl.rcParams.copy()
             for key in _copy: