Merge pull request #2597 from tacaswell/add_SubplotSpec__eq__

pelson · pelson · commit 3284b17b8598 · 2013-12-18T05:51:44.000-08:00
BUG: Add subplot spec  eq
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -1245,6 +1245,7 @@ def tk_window_focus():
     'matplotlib.tests.test_dates',
     'matplotlib.tests.test_delaunay',
     'matplotlib.tests.test_figure',
+    'matplotlib.tests.test_gridspec',
     'matplotlib.tests.test_image',
     'matplotlib.tests.test_legend',
     'matplotlib.tests.test_lines',
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -457,3 +457,19 @@ def get_topmost_subplotspec(self):
             return gridspec.get_topmost_subplotspec()
         else:
             return self
+
+    def __eq__(self, other):
+        # check to make sure other has the attributes
+        # we need to do the comparison
+        if not (hasattr(other, '_gridspec') and
+                hasattr(other, 'num1') and
+                hasattr(other, 'num2')):
+            return False
+        return all((self._gridspec == other._gridspec,
+                    self.num1 == other.num1,
+                    self.num2 == other.num2))
+
+    def __hash__(self):
+        return (hash(self._gridspec) ^
+                hash(self.num1) ^
+                hash(self.num2))
diff --git a/lib/matplotlib/tests/test_gridspec.py b/lib/matplotlib/tests/test_gridspec.py
@@ -0,0 +1,8 @@
+import matplotlib.gridspec as gridspec
+from nose.tools import assert_equal
+
+
+def test_equal():
+    gs = gridspec.GridSpec(2, 1)
+    assert_equal(gs[0, 0], gs[0, 0])
+    assert_equal(gs[:, 0], gs[:, 0])
