Merge pull request #20314 from greglucas/cbar-deps

QuLogic · web-flow · commit 62735372eea8 · 2021-05-27T00:06:08.000-04:00
MAINT: Removing deprecated colorbar functions.
diff --git a/doc/api/next_api_changes/removals/20314-GL.rst b/doc/api/next_api_changes/removals/20314-GL.rst
@@ -0,0 +1,11 @@
+Colorbar related removals
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``Colorbar.on_mappable_changed()`` and ``Colorbar.update_bruteforce()`` have
+been removed, you can use ``Colorbar.update_normal()`` instead.
+
+``ColorbarBase`` only takes a single positional argument now, the ``Axes`` to
+create it in, with all other options required to be keyword arguments.
+
+The warning for keyword arguments that were overridden by the mappable
+is now removed.
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -389,8 +389,7 @@ class ColorbarBase:
 
     n_rasterize = 50  # rasterize solids if number of colors >= n_rasterize
 
-    @_api.make_keyword_only("3.3", "cmap")
-    def __init__(self, ax, cmap=None,
+    def __init__(self, ax, *, cmap=None,
                  norm=None,
                  alpha=None,
                  values=None,
@@ -1141,19 +1140,6 @@ def _short_axis(self):
         return self.ax.yaxis
 
 
-def _add_disjoint_kwargs(d, **kwargs):
-    """
-    Update dict *d* with entries in *kwargs*, which must be absent from *d*.
-    """
-    for k, v in kwargs.items():
-        if k in d:
-            _api.warn_deprecated(
-                "3.3", message=f"The {k!r} parameter to Colorbar has no "
-                "effect because it is overridden by the mappable; it is "
-                "deprecated since %(since)s and will be removed %(removal)s.")
-        d[k] = v
-
-
 class Colorbar(ColorbarBase):
     """
     This class connects a `ColorbarBase` to a `~.cm.ScalarMappable`
@@ -1171,18 +1157,15 @@ def __init__(self, ax, mappable, **kwargs):
             mappable.autoscale_None()
 
         self.mappable = mappable
-        _add_disjoint_kwargs(kwargs, cmap=mappable.cmap, norm=mappable.norm)
+        kwargs.update({"cmap": mappable.cmap, "norm": mappable.norm})
 
         if isinstance(mappable, contour.ContourSet):
             cs = mappable
-            _add_disjoint_kwargs(
-                kwargs,
-                alpha=cs.get_alpha(),
-                boundaries=cs._levels,
-                values=cs.cvalues,
-                extend=cs.extend,
-                filled=cs.filled,
-            )
+            kwargs.update({"alpha": cs.get_alpha(),
+                           "boundaries": cs._levels,
+                           "values": cs.cvalues,
+                           "extend": cs.extend,
+                           "filled": cs.filled})
             kwargs.setdefault(
                 'ticks', ticker.FixedLocator(cs.levels, nbins=10))
             super().__init__(ax, **kwargs)
@@ -1192,24 +1175,13 @@ def __init__(self, ax, mappable, **kwargs):
             if getattr(mappable.cmap, 'colorbar_extend', False) is not False:
                 kwargs.setdefault('extend', mappable.cmap.colorbar_extend)
             if isinstance(mappable, martist.Artist):
-                _add_disjoint_kwargs(kwargs, alpha=mappable.get_alpha())
+                kwargs.update({"alpha": mappable.get_alpha()})
             super().__init__(ax, **kwargs)
 
         mappable.colorbar = self
         mappable.colorbar_cid = mappable.callbacksSM.connect(
             'changed', self.update_normal)
 
-    @_api.deprecated("3.3", alternative="update_normal")
-    def on_mappable_changed(self, mappable):
-        """
-        Update this colorbar to match the mappable's properties.
-
-        Typically this is automatically registered as an event handler
-        by :func:`colorbar_factory` and should not be called manually.
-        """
-        _log.debug('colorbar mappable changed')
-        self.update_normal(mappable)
-
     def add_lines(self, CS, erase=True):
         """
         Add the lines from a non-filled `~.contour.ContourSet` to the colorbar.
@@ -1257,47 +1229,6 @@ def update_normal(self, mappable):
                 self.add_lines(CS)
         self.stale = True
 
-    @_api.deprecated("3.3", alternative="update_normal")
-    def update_bruteforce(self, mappable):
-        """
-        Destroy and rebuild the colorbar.  This is
-        intended to become obsolete, and will probably be
-        deprecated and then removed.  It is not called when
-        the pyplot.colorbar function or the Figure.colorbar
-        method are used to create the colorbar.
-        """
-        # We are using an ugly brute-force method: clearing and
-        # redrawing the whole thing.  The problem is that if any
-        # properties have been changed by methods other than the
-        # colorbar methods, those changes will be lost.
-        self.ax.cla()
-        self.locator = None
-        self.formatter = None
-
-        # clearing the axes will delete outline, patch, solids, and lines:
-        for spine in self.ax.spines.values():
-            spine.set_visible(False)
-        self.outline = self.ax.spines['outline'] = _ColorbarSpine(self.ax)
-        self.patch = mpatches.Polygon(
-            np.empty((0, 2)),
-            color=mpl.rcParams['axes.facecolor'], linewidth=0.01, zorder=-1)
-        self.ax.add_artist(self.patch)
-        self.solids = None
-        self.lines = []
-        self.update_normal(mappable)
-        self.draw_all()
-        if isinstance(self.mappable, contour.ContourSet):
-            CS = self.mappable
-            if not CS.filled:
-                self.add_lines(CS)
-            #if self.lines is not None:
-            #    tcolors = [c[0] for c in CS.tcolors]
-            #    self.lines.set_color(tcolors)
-        #Fixme? Recalculate boundaries, ticks if vmin, vmax have changed.
-        #Fixme: Some refactoring may be needed; we should not
-        # be recalculating everything if there was a simple alpha
-        # change.
-
     def remove(self):
         """
         Remove this colorbar from the figure.
