Merge pull request #11287 from anntzer/mouseoverset

anntzer · web-flow · commit ead2ff897461 · 2018-07-01T08:57:09.000+02:00
Maintain artist addition order in Axes.mouseover_set.
diff --git a/doc/api/next_api_changes/2018-02-26-AL-removals.rst b/doc/api/next_api_changes/2018-02-26-AL-removals.rst
@@ -1,3 +1,12 @@
+Modified APIs
+-------------
+
+The following APIs have been modified:
+
+- ``Axes.mouseover_set`` is now a frozenset, and deprecated.  Directly
+  manipulate the artist's ``.mouseover`` attribute to change their mouseover
+  status.
+
 Removal of deprecated APIs
 --------------------------
 
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -148,7 +148,7 @@ def remove(self):
             _ax_flag = False
             if hasattr(self, 'axes') and self.axes:
                 # remove from the mouse hit list
-                self.axes.mouseover_set.discard(self)
+                self.axes._mouseover_set.discard(self)
                 # mark the axes as stale
                 self.axes.stale = True
                 # decouple the artist from the axes
@@ -1028,9 +1028,9 @@ def mouseover(self, val):
         ax = self.axes
         if ax:
             if val:
-                ax.mouseover_set.add(self)
+                ax._mouseover_set.add(self)
             else:
-                ax.mouseover_set.discard(self)
+                ax._mouseover_set.discard(self)
 
 
 class ArtistInspector(object):
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -12,8 +12,8 @@
 import matplotlib
 
 from matplotlib import cbook, rcParams
-from matplotlib.cbook import (_check_1d, _string_to_bool, iterable,
-                              index_of, get_label)
+from matplotlib.cbook import (
+    _OrderedSet, _check_1d, _string_to_bool, iterable, index_of, get_label)
 from matplotlib import docstring
 import matplotlib.colors as mcolors
 import matplotlib.lines as mlines
@@ -907,7 +907,7 @@ def _set_artist_props(self, a):
 
         a.axes = self
         if a.mouseover:
-            self.mouseover_set.add(a)
+            self._mouseover_set.add(a)
 
     def _gen_axes_patch(self):
         """
@@ -1022,7 +1022,7 @@ def cla(self):
         self.tables = []
         self.artists = []
         self.images = []
-        self.mouseover_set = set()
+        self._mouseover_set = _OrderedSet()
         self._current_image = None  # strictly for pyplot via _sci, _gci
         self.legend_ = None
         self.collections = []  # collection.Collection instances
@@ -1089,6 +1089,11 @@ def cla(self):
 
         self.stale = True
 
+    @property
+    @cbook.deprecated("3.0")
+    def mouseover_set(self):
+        return frozenset(self._mouseover_set)
+
     def clear(self):
         """Clear the axes."""
         self.cla()
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2707,7 +2707,7 @@ def mouse_move(self, event):
             except (ValueError, OverflowError):
                 pass
             else:
-                artists = [a for a in event.inaxes.mouseover_set
+                artists = [a for a in event.inaxes._mouseover_set
                            if a.contains(event) and a.get_visible()]
 
                 if artists:
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -337,7 +337,7 @@ def send_message(self, event):
             except (ValueError, OverflowError):
                 pass
             else:
-                artists = [a for a in event.inaxes.mouseover_set
+                artists = [a for a in event.inaxes._mouseover_set
                            if a.contains(event) and a.get_visible()]
 
                 if artists:
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -2047,3 +2047,24 @@ def _warn_external(message, category=None):
             break
         frame = frame.f_back
     warnings.warn(message, category, stacklevel)
+
+
+class _OrderedSet(collections.MutableSet):
+    def __init__(self):
+        self._od = collections.OrderedDict()
+
+    def __contains__(self, key):
+        return key in self._od
+
+    def __iter__(self):
+        return iter(self._od)
+
+    def __len__(self):
+        return len(self._od)
+
+    def add(self, key):
+        self._od.pop(key, None)
+        self._od[key] = None
+
+    def discard(self, key):
+        self._od.pop(key, None)
diff --git a/lib/matplotlib/tests/test_artist.py b/lib/matplotlib/tests/test_artist.py
@@ -185,8 +185,8 @@ def test_remove():
     assert not ax.stale
     assert not ln.stale
 
-    assert im in ax.mouseover_set
-    assert ln not in ax.mouseover_set
+    assert im in ax._mouseover_set
+    assert ln not in ax._mouseover_set
     assert im.axes is ax
 
     im.remove()
@@ -196,7 +196,7 @@ def test_remove():
         assert art.axes is None
         assert art.figure is None
 
-    assert im not in ax.mouseover_set
+    assert im not in ax._mouseover_set
     assert fig.stale
     assert ax.stale
 
