Merge pull request #477 from efiring/findobj_no_duplicate

efiring · efiring · commit 6055d8a3503f · 2011-09-18T12:54:52.000-07:00
findobj: add kwarg to prevent duplicates in output. Closes issue #475.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -728,21 +728,25 @@ def set(self, **kwargs):
             ret.extend( [func(v)] )
         return ret
 
-    def findobj(self, match=None):
+    def findobj(self, match=None, include_self=True):
         """
         pyplot signature:
-          findobj(o=gcf(), match=None)
+          findobj(o=gcf(), match=None, include_self=True)
 
         Recursively find all :class:matplotlib.artist.Artist instances
         contained in self.
 
         *match* can be
 
-          - None: return all objects contained in artist (including artist)
+          - None: return all objects contained in artist.
+
+          - function with signature ``boolean = match(artist)``
+            used to filter matches
 
-          - function with signature ``boolean = match(artist)`` used to filter matches
+          - class instance: eg Line2D.  Only return artists of class type.
 
-          - class instance: eg Line2D.  Only return artists of class type
+        If *include_self* is True (default), include self in the list to be
+        checked for a match.
 
         .. plot:: mpl_examples/pylab_examples/findobj_demo.py
         """
@@ -755,17 +759,18 @@ def matchfunc(x):
         elif callable(match):
             matchfunc = match
         else:
-            raise ValueError('match must be None, an matplotlib.artist.Artist subclass, or a callable')
-
+            raise ValueError('match must be None, a matplotlib.artist.Artist subclass, or a callable')
 
         artists = []
 
         for c in self.get_children():
             if matchfunc(c):
                 artists.append(c)
-            artists.extend([thisc for thisc in c.findobj(matchfunc) if matchfunc(thisc)])
+            artists.extend([thisc for thisc in
+                                c.findobj(matchfunc, include_self=False)
+                                                     if matchfunc(thisc)])
 
-        if matchfunc(self):
+        if include_self and matchfunc(self):
             artists.append(self)
         return artists
 
