Merge pull request #17749 from anntzer/custombboxtransmuter

timhoffm · web-flow · commit 56d4f69923d5 · 2020-06-28T12:24:55.000+02:00
Deprecate `FancyBboxPatch(..., boxstyle="custom", bbox_transmuter=...)`
diff --git a/doc/api/api_changes_3.4/deprecations.rst b/doc/api/api_changes_3.4/deprecations.rst
@@ -5,7 +5,14 @@ Deprecations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This parameter is considered internal and deprecated.
 
+
 Colorbar docstrings
 ~~~~~~~~~~~~~~~~~~~
 The following globals in :mod:`matplotlib.colorbar` are deprecated:
 ``colorbar_doc``, ``colormap_kw_doc``, ``make_axes_kw_doc``.
+
+``FancyBboxPatch(..., boxstyle="custom", bbox_transmuter=...)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In order to use a custom boxstyle, directly pass it as the *boxstyle* argument
+to `.FancyBboxPatch`.  This was previously already possible, and is consistent
+with custom arrow styles and connection styles.
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -3564,6 +3564,7 @@ def __str__(self):
         return s % (self._x, self._y, self._width, self._height)
 
     @docstring.dedent_interpd
+    @cbook._delete_parameter("3.4", "bbox_transmuter", alternative="boxstyle")
     def __init__(self, xy, width, height,
                  boxstyle="round", bbox_transmuter=None,
                  mutation_scale=1, mutation_aspect=1,
@@ -3616,6 +3617,10 @@ def __init__(self, xy, width, height,
         self._height = height
 
         if boxstyle == "custom":
+            cbook._warn_deprecated(
+                "3.4", message="Support for boxstyle='custom' is deprecated "
+                "since %(since)s and will be removed %(removal)s; directly "
+                "pass a boxstyle instance as the boxstyle parameter instead.")
             if bbox_transmuter is None:
                 raise ValueError("bbox_transmuter argument is needed with "
                                  "custom boxstyle")
@@ -3641,10 +3646,12 @@ def set_boxstyle(self, boxstyle=None, **kwargs):
 
         Parameters
         ----------
-        boxstyle : str
-            The name of the box style. Optionally, followed by a comma and a
-            comma-separated list of attributes. The attributes may
-            alternatively be passed separately as keyword arguments.
+        boxstyle : str or `matplotlib.patches.BoxStyle`
+            The style of the fancy box. This can either be a `.BoxStyle`
+            instance or a string of the style name and optionally comma
+            seprarated attributes (e.g. "Round, pad=0.2"). This string is
+            passed to `.BoxStyle` to construct a `.BoxStyle` object. See
+            there for a full documentation.
 
             The following box styles are available:
 
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -449,20 +449,12 @@ def set_bbox(self, rectprops):
             else:
                 if pad is None:
                     pad = 0.3
-
             # boxstyle could be a callable or a string
             if isinstance(boxstyle, str) and "pad" not in boxstyle:
                 boxstyle += ",pad=%0.2f" % pad
-
-            bbox_transmuter = props.pop("bbox_transmuter", None)
-
             self._bbox_patch = FancyBboxPatch(
-                                    (0., 0.),
-                                    1., 1.,
-                                    boxstyle=boxstyle,
-                                    bbox_transmuter=bbox_transmuter,
-                                    transform=IdentityTransform(),
-                                    **props)
+                (0, 0), 1, 1,
+                boxstyle=boxstyle, transform=IdentityTransform(), **props)
         else:
             self._bbox_patch = None
 
