TYP: Added typing to __eq__ functions (#29818)

Author: ShaharNaveh

pandas/_libs/tslibs/offsets.pyx

@@ -328,7 +328,7 @@ class _BaseOffset:
     def __setattr__(self, name, value):
         raise AttributeError("DateOffset objects are immutable.")
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         if isinstance(other, str):
             try:
                 # GH#23524 if to_offset fails, we are dealing with an

pandas/core/arrays/sparse/dtype.py

@@ -90,7 +90,7 @@ def __hash__(self):
         # __eq__, so we explicitly do it here.
         return super().__hash__()
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         # We have to override __eq__ to handle NA values in _metadata.
         # The base class does simple == checks, which fail for NA.
         if isinstance(other, str):

pandas/core/dtypes/dtypes.py

@@ -765,7 +765,7 @@ def __hash__(self) -> int:
         # TODO: update this.
         return hash(str(self))
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         if isinstance(other, str):
             return other == self.name
 
@@ -904,7 +904,7 @@ def __hash__(self) -> int:
         # make myself hashable
         return hash(str(self))
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         if isinstance(other, str):
             return other == self.name or other == self.name.title()
 
@@ -1077,7 +1077,7 @@ def __hash__(self) -> int:
         # make myself hashable
         return hash(str(self))
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         if isinstance(other, str):
             return other.lower() in (self.name.lower(), str(self).lower())
         elif not isinstance(other, IntervalDtype):

pandas/core/indexes/frozen.py

@@ -77,7 +77,7 @@ def __radd__(self, other):
             other = list(other)
         return self.__class__(other + list(self))
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         if isinstance(other, (tuple, FrozenList)):
             other = list(other)
         return super().__eq__(other)

pandas/io/pytables.py

@@ -2092,7 +2092,7 @@ def __repr__(self) -> str:
             )
         )
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         """ compare 2 col items """
         return all(
             getattr(self, a, None) == getattr(other, a, None)

pandas/io/stata.py

@@ -859,7 +859,7 @@ def __repr__(self) -> str:
         # not perfect :-/
         return "{cls}({obj})".format(cls=self.__class__, obj=self)
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         return (
             isinstance(other, self.__class__)
             and self.string == other.string

pandas/tests/indexing/test_indexing.py

@@ -595,7 +595,7 @@ def __str__(self) -> str:
 
             __repr__ = __str__
 
-            def __eq__(self, other):
+            def __eq__(self, other) -> bool:
                 return self.value == other.value
 
             def view(self):

pandas/tests/scalar/timestamp/test_comparisons.py

@@ -179,8 +179,8 @@ def __gt__(self, o):
         def __ge__(self, o):
             return True
 
-        def __eq__(self, o):
-            return isinstance(o, Inf)
+        def __eq__(self, other) -> bool:
+            return isinstance(other, Inf)
 
     inf = Inf()
     timestamp = Timestamp("2018-11-30")

pandas/tests/series/test_ufunc.py

@@ -282,7 +282,7 @@ def __add__(self, other):
             other = getattr(other, "value", other)
             return type(self)(self.value + other)
 
-        def __eq__(self, other):
+        def __eq__(self, other) -> bool:
             return type(other) is Thing and self.value == other.value
 
         def __repr__(self) -> str:

pandas/tests/test_algos.py

@@ -767,7 +767,7 @@ def test_same_object_is_in(self):
         # with similar behavior, then we at least should
         # fall back to usual python's behavior: "a in [a] == True"
         class LikeNan:
-            def __eq__(self, other):
+            def __eq__(self, other) -> bool:
                 return False
 
             def __hash__(self):