Remove deprecated toolkit colorbar implementation.

Author: QuLogic

doc/api/next_api_changes/removals/18747-ES.rst

@@ -47,6 +47,11 @@ method now always uses the renderer instance cached on the `.Figure`.
 
 ``axes_grid1``
 ~~~~~~~~~~~~~~
+The ``mpl_toolkits.axes_grid1.colorbar`` module and its colorbar implementation
+have been removed in favor of :mod:`matplotlib.colorbar`. Additionally:
+
 - The *locator* parameter to ``colorbar()`` has been removed in favor of its
   synonym *ticks* (which already existed previously, and is consistent with
   :mod:`matplotlib.colorbar`).
+- The ``mpl_toolkits.legacy_colorbar`` rcParam has no effect and also has been
+  removed.

doc/api/toolkits/axes_grid1.rst

@@ -29,7 +29,6 @@ See :ref:`axes_grid1_users-guide-index` for a guide on the usage of axes_grid1.
    axes_grid1.axes_grid
    axes_grid1.axes_rgb
    axes_grid1.axes_size
-   axes_grid1.colorbar
    axes_grid1.inset_locator
    axes_grid1.mpl_axes
    axes_grid1.parasite_axes

examples/axes_grid1/demo_axes_grid.py

@@ -11,9 +11,6 @@
 from mpl_toolkits.axes_grid1 import ImageGrid
 
 
-plt.rcParams["mpl_toolkits.legacy_colorbar"] = False
-
-
 def get_demo_image():
     z = cbook.get_sample_data("axes_grid/bivariate_normal.npy", np_load=True)
     # z is a numpy array of 15x15

examples/axes_grid1/demo_axes_grid2.py

@@ -13,9 +13,6 @@
 from mpl_toolkits.axes_grid1 import ImageGrid
 
 
-plt.rcParams["mpl_toolkits.legacy_colorbar"] = False
-
-
 def add_inner_title(ax, title, loc, **kwargs):
     from matplotlib.offsetbox import AnchoredText
     from matplotlib.patheffects import withStroke

examples/axes_grid1/demo_edge_colorbar.py

@@ -12,9 +12,6 @@
 from mpl_toolkits.axes_grid1 import AxesGrid
 
 
-plt.rcParams["mpl_toolkits.legacy_colorbar"] = False
-
-
 def get_demo_image():
     z = cbook.get_sample_data("axes_grid/bivariate_normal.npy", np_load=True)
     # z is a numpy array of 15x15

lib/matplotlib/__init__.py

@@ -569,6 +569,7 @@ def gen_candidates():
 # rcParams deprecated; some can manually be mapped to another key.
 # Values are tuples of (version, new_name_or_None).
 _deprecated_ignore_map = {
+    'mpl_toolkits.legacy_colorbar': ('3.4', None),
 }
 
 # rcParams deprecated; can use None to suppress warnings; remain actually

lib/matplotlib/rcsetup.py

@@ -1441,8 +1441,6 @@ def _convert_validator_spec(key, conv):
      # Additional arguments for convert movie writer (using pipes)
     "animation.convert_args": validate_stringlist,
 
-    "mpl_toolkits.legacy_colorbar": validate_bool,
-
     # Classic (pre 2.0) compatibility mode
     # This is used for things that are hard to make backward compatible
     # with a sane rcParam alone.  This does *not* turn on classic mode

lib/mpl_toolkits/axes_grid/colorbar.py

@@ -4,7 +4,7 @@
 import numpy as np
 
 import matplotlib as mpl
-from matplotlib import _api, cbook, ticker
+from matplotlib import _api, cbook
 from matplotlib.gridspec import SubplotSpec
 
 from .axes_divider import Size, SubplotDivider, Divider
@@ -32,27 +32,10 @@ def colorbar(self, mappable, *, ticks=None, **kwargs):
         else:
             orientation = "vertical"
 
-        if mpl.rcParams["mpl_toolkits.legacy_colorbar"]:
-            cbook.warn_deprecated(
-                "3.2", message="Since %(since)s, mpl_toolkits's own colorbar "
-                "implementation is deprecated; it will be removed "
-                "%(removal)s.  Set the 'mpl_toolkits.legacy_colorbar' rcParam "
-                "to False to use Matplotlib's default colorbar implementation "
-                "and suppress this deprecation warning.")
-            if ticks is None:
-                ticks = ticker.MaxNLocator(5)  # For backcompat.
-            from .colorbar import Colorbar
-            cb = Colorbar(
-                self, mappable, orientation=orientation, ticks=ticks, **kwargs)
-            self._cbid = mappable.callbacksSM.connect(
-                'changed', cb.update_normal)
-            mappable.colorbar = cb
-            self._locator = cb.cbar_axis.get_major_locator()
-        else:
-            cb = mpl.colorbar.Colorbar(
-                self, mappable, orientation=orientation, ticks=ticks, **kwargs)
-            self._cbid = mappable.colorbar_cid  # deprecated.
-            self._locator = cb.locator  # deprecated.
+        cb = mpl.colorbar.Colorbar(
+            self, mappable, orientation=orientation, ticks=ticks, **kwargs)
+        self._cbid = mappable.colorbar_cid  # deprecated in 3.3.
+        self._locator = cb.locator  # deprecated in 3.3.
 
         self._config_axes()
         return cb