Deprecate passing incorrect types to Axes.add_*.

QuLogic · QuLogic · commit ee229eacf806 · 2020-08-26T22:10:21.000-04:00
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -2027,6 +2027,20 @@ def has_data(self):
                                   mlines.Line2D, mpatches.Patch))
                    for a in self._children)
 
+    def _deprecate_noninstance(self, _name, _types, **kwargs):
+        """
+        For each *key, value* pair in *kwargs*, check that *value* is an
+        instance of one of *_types*; if not, raise an appropriate deprecation.
+        """
+        for key, value in kwargs.items():
+            if not isinstance(value, _types):
+                cbook.warn_deprecated(
+                    '3.4', name=_name,
+                    message=f'Passing argument *{key}* of unexpected type '
+                    f'{type(value).__qualname__} to %(name)s which only '
+                    f'accepts {_types} is deprecated since %(since)s and will '
+                    'become an error %(removal)s.')
+
     def add_artist(self, a):
         """
         Add an `~.Artist` to the Axes; return the artist.
@@ -2070,6 +2084,8 @@ def add_collection(self, collection, autolim=True):
         """
         Add a `~.Collection` to the Axes; return the collection.
         """
+        self._deprecate_noninstance('add_collection', mcoll.Collection,
+                                    collection=collection)
         label = collection.get_label()
         if not label:
             collection.set_label(f'_collection{len(self._children)}')
@@ -2093,6 +2109,7 @@ def add_image(self, image):
         """
         Add an `~.AxesImage` to the Axes; return the image.
         """
+        self._deprecate_noninstance('add_image', mimage.AxesImage, image=image)
         self._set_artist_props(image)
         if not image.get_label():
             image.set_label(f'_image{len(self._children)}')
@@ -2109,6 +2126,7 @@ def add_line(self, line):
         """
         Add a `.Line2D` to the Axes; return the line.
         """
+        self._deprecate_noninstance('add_line', mlines.Line2D, line=line)
         self._set_artist_props(line)
         if line.get_clip_path() is None:
             line.set_clip_path(self.patch)
@@ -2125,6 +2143,7 @@ def _add_text(self, txt):
         """
         Add a `~.Text` to the Axes; return the text.
         """
+        self._deprecate_noninstance('_add_text', mtext.Text, txt=txt)
         self._set_artist_props(txt)
         self._children.append(txt)
         txt._remove_method = self._children.remove
@@ -2179,6 +2198,7 @@ def add_patch(self, p):
         """
         Add a `~.Patch` to the Axes; return the patch.
         """
+        self._deprecate_noninstance('add_patch', mpatches.Patch, p=p)
         self._set_artist_props(p)
         if p.get_clip_path() is None:
             p.set_clip_path(self.patch)
@@ -2217,6 +2237,7 @@ def add_table(self, tab):
         """
         Add a `~.Table` to the Axes; return the table.
         """
+        self._deprecate_noninstance('add_table', mtable.Table, tab=tab)
         self._set_artist_props(tab)
         self._children.append(tab)
         tab.set_clip_path(self.patch)
