Fix __eq__ and __ne__. (#3765)

Author: lukesneeringer

packages/google-cloud-bigtable/google/cloud/bigtable/cluster.py

@@ -159,7 +159,7 @@ def name(self):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         # NOTE: This does not compare the configuration values, such as
         #       the serve_nodes. Instead, it only compares
         #       identifying values instance, cluster ID and client. This is
@@ -170,7 +170,7 @@ def __eq__(self, other):
                 other._instance == self._instance)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     def reload(self):
         """Reload the metadata for this cluster."""

packages/google-cloud-bigtable/google/cloud/bigtable/column_family.py

@@ -39,9 +39,6 @@ class GarbageCollectionRule(object):
         don't support that feature and instead support via native classes.
     """
 
-    def __ne__(self, other):
-        return not self.__eq__(other)
-
 
 class MaxVersionsGCRule(GarbageCollectionRule):
     """Garbage collection limiting the number of versions of a cell.
@@ -55,9 +52,12 @@ def __init__(self, max_num_versions):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.max_num_versions == self.max_num_versions
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the garbage collection rule to a protobuf.
 
@@ -79,9 +79,12 @@ def __init__(self, max_age):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.max_age == self.max_age
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the garbage collection rule to a protobuf.
 
@@ -104,9 +107,12 @@ def __init__(self, rules):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.rules == self.rules
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the union into a single GC rule as a protobuf.
 
@@ -130,9 +136,12 @@ def __init__(self, rules):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.rules == self.rules
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the intersection into a single GC rule as a protobuf.
 
@@ -190,13 +199,13 @@ def name(self):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.column_family_id == self.column_family_id and
                 other._table == self._table and
                 other.gc_rule == self.gc_rule)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     def to_pb(self):
         """Converts the column family to a protobuf.

packages/google-cloud-bigtable/google/cloud/bigtable/instance.py

@@ -180,7 +180,7 @@ def name(self):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         # NOTE: This does not compare the configuration values, such as
         #       the display_name. Instead, it only compares
         #       identifying values instance ID and client. This is
@@ -191,7 +191,7 @@ def __eq__(self, other):
                 other._client == self._client)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     def reload(self):
         """Reload the metadata for this instance."""

packages/google-cloud-bigtable/google/cloud/bigtable/row_data.py

@@ -58,13 +58,13 @@ def from_pb(cls, cell_pb):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.value == self.value and
                 other.timestamp == self.timestamp and
                 other.labels == self.labels)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
 
 class PartialCellData(object):
@@ -126,12 +126,12 @@ def __init__(self, row_key):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other._row_key == self._row_key and
                 other._cells == self._cells)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     def to_dict(self):
         """Convert the cells to a dictionary.
@@ -211,11 +211,11 @@ def __init__(self, response_iterator):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other._response_iterator == self._response_iterator
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     @property
     def state(self):

packages/google-cloud-bigtable/google/cloud/bigtable/row_filters.py

@@ -32,9 +32,6 @@ class RowFilter(object):
         This class is a do-nothing base class for all row filters.
     """
 
-    def __ne__(self, other):
-        return not self.__eq__(other)
-
 
 class _BoolFilter(RowFilter):
     """Row filter that uses a boolean flag.
@@ -48,9 +45,12 @@ def __init__(self, flag):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.flag == self.flag
 
+    def __ne__(self, other):
+        return not self == other
+
 
 class SinkFilter(_BoolFilter):
     """Advanced row filter to skip parent filters.
@@ -124,9 +124,12 @@ def __init__(self, regex):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.regex == self.regex
 
+    def __ne__(self, other):
+        return not self == other
+
 
 class RowKeyRegexFilter(_RegexFilter):
     """Row filter for a row key regular expression.
@@ -173,9 +176,12 @@ def __init__(self, sample):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.sample == self.sample
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the row filter to a protobuf.
 
@@ -257,12 +263,12 @@ def __init__(self, start=None, end=None):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.start == self.start and
                 other.end == self.end)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     def to_pb(self):
         """Converts the :class:`TimestampRange` to a protobuf.
@@ -292,9 +298,12 @@ def __init__(self, range_):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.range_ == self.range_
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the row filter to a protobuf.
 
@@ -367,13 +376,16 @@ def __init__(self, column_family_id, start_column=None, end_column=None,
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.column_family_id == self.column_family_id and
                 other.start_column == self.start_column and
                 other.end_column == self.end_column and
                 other.inclusive_start == self.inclusive_start and
                 other.inclusive_end == self.inclusive_end)
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the row filter to a protobuf.
 
@@ -485,12 +497,15 @@ def __init__(self, start_value=None, end_value=None,
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.start_value == self.start_value and
                 other.end_value == self.end_value and
                 other.inclusive_start == self.inclusive_start and
                 other.inclusive_end == self.inclusive_end)
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the row filter to a protobuf.
 
@@ -533,9 +548,12 @@ def __init__(self, num_cells):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.num_cells == self.num_cells
 
+    def __ne__(self, other):
+        return not self == other
+
 
 class CellsRowOffsetFilter(_CellCountFilter):
     """Row filter to skip cells in a row.
@@ -631,9 +649,12 @@ def __init__(self, label):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.label == self.label
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the row filter to a protobuf.
 
@@ -661,9 +682,12 @@ def __init__(self, filters=None):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return other.filters == self.filters
 
+    def __ne__(self, other):
+        return not self == other
+
 
 class RowFilterChain(_FilterCombination):
     """Chain of row filters.
@@ -748,11 +772,14 @@ def __init__(self, base_filter, true_filter=None, false_filter=None):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.base_filter == self.base_filter and
                 other.true_filter == self.true_filter and
                 other.false_filter == self.false_filter)
 
+    def __ne__(self, other):
+        return not self == other
+
     def to_pb(self):
         """Converts the row filter to a protobuf.
 

packages/google-cloud-bigtable/google/cloud/bigtable/table.py

@@ -142,12 +142,12 @@ def row(self, row_key, filter_=None, append=False):
 
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
-            return False
+            return NotImplemented
         return (other.table_id == self.table_id and
                 other._instance == self._instance)
 
     def __ne__(self, other):
-        return not self.__eq__(other)
+        return not self == other
 
     def create(self, initial_split_keys=None, column_families=()):
         """Creates this table.

packages/google-cloud-bigtable/tests/unit/test_column_family.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 import unittest
 
+import mock
+
 
 class TestMaxVersionsGCRule(unittest.TestCase):
 
@@ -29,8 +30,8 @@ def _make_one(self, *args, **kwargs):
 
     def test___eq__type_differ(self):
         gc_rule1 = self._make_one(10)
-        gc_rule2 = object()
-        self.assertNotEqual(gc_rule1, gc_rule2)
+        self.assertNotEqual(gc_rule1, object())
+        self.assertEqual(gc_rule1, mock.ANY)
 
     def test___eq__same_value(self):
         gc_rule1 = self._make_one(2)