Add ability to compare API objects

This commit adds correct equality checks for most of the API objects.
This allows, for example, to check if two `User` instances points to
the same user by simply comparing them (`user1 == user2`).

Author: Pietro Albini

botogram/objects/base.py

@@ -18,6 +18,7 @@ class BaseObject:
     required = {}
     optional = {}
     replace_keys = {}
+    _check_equality_ = None
 
     def __init__(self, data, api=None):
         # Prevent receiving strange types
@@ -53,6 +54,17 @@ def __init__(self, data, api=None):
         if api is not None:
             self.set_api(api)
 
+    def __eq__(self, other):
+        to_check = self._check_equality_
+
+        if to_check is None:
+            return id(self) == id(other)
+
+        if not isinstance(other, self.__class__):
+            return False
+
+        return getattr(self, to_check) == getattr(other, to_check)
+
     def set_api(self, api):
         """Change the API instance"""
         self._api = api

botogram/objects/chats.py

@@ -27,6 +27,7 @@ class User(BaseObject, mixins.ChatMixin):
         "last_name": str,
         "username": str,
     }
+    _check_equality_ = "id"
 
     @property
     def name(self):
@@ -90,6 +91,7 @@ class Chat(BaseObject, mixins.ChatMixin):
         "first_name": str,
         "last_name": str,
     }
+    _check_equality_ = "id"
 
     @property
     def name(self):

botogram/objects/media.py

@@ -24,6 +24,7 @@ class PhotoSize(BaseObject, mixins.FileMixin):
     optional = {
         "file_size": int,
     }
+    _check_equality_ = "file_id"
 
 
 class Photo(mixins.FileMixin):
@@ -61,6 +62,9 @@ def __init__(self, data, api=None):
         for attr in attrs:
             setattr(self, attr, getattr(self.biggest, attr))
 
+    def __eq__(self, other):
+        return isinstance(other, Photo) and self.sizes == other.sizes
+
     def set_api(self, api):
         """Change the API instance"""
         self._api = api
@@ -94,6 +98,7 @@ class Audio(BaseObject, mixins.FileMixin):
         "mime_type": str,
         "file_size": int,
     }
+    _check_equality_ = "file_id"
 
 
 class Voice(BaseObject, mixins.FileMixin):
@@ -110,6 +115,7 @@ class Voice(BaseObject, mixins.FileMixin):
         "mime_type": str,
         "file_size": int,
     }
+    _check_equality_ = "file_id"
 
 
 class Document(BaseObject, mixins.FileMixin):
@@ -127,6 +133,7 @@ class Document(BaseObject, mixins.FileMixin):
         "mime_type": str,
         "file_size": int,
     }
+    _check_equality_ = "file_id"
 
 
 class Sticker(BaseObject, mixins.FileMixin):
@@ -145,6 +152,7 @@ class Sticker(BaseObject, mixins.FileMixin):
         "emoji": str,
         "file_size": int,
     }
+    _check_equality_ = "file_id"
 
 
 class Video(BaseObject, mixins.FileMixin):
@@ -164,6 +172,7 @@ class Video(BaseObject, mixins.FileMixin):
         "mime_type": str,
         "file_size": int,
     }
+    _check_equality_ = "file_id"
 
 
 class Contact(BaseObject):
@@ -180,6 +189,7 @@ class Contact(BaseObject):
         "last_name": str,
         "user_id": int,
     }
+    _check_equality_ = "phone_number"
 
 
 class Location(BaseObject):
@@ -192,3 +202,8 @@ class Location(BaseObject):
         "longitude": float,
         "latitude": float,
     }
+
+    def __eq__(self, other):
+        return isinstance(other, Location) and \
+            self.longitude == other.longitude and \
+            self.latitude == other.latitude

botogram/objects/messages.py

@@ -66,6 +66,17 @@ def __init__(self, data, api=None, message=None):
 
         self._message = message
 
+    def __eq__(self, other):
+        if not isinstance(other, ParsedTextEntity):
+            return False
+
+        # Don't do custom equality if no message object is attached
+        if self._message is None or other._message is None:
+            return id(self) == id(other)
+
+        return self._message.message_id == other._message.message_id and \
+            self._offset == other._offset and self._length == other._length
+
     def __str__(self):
         return self.text
 
@@ -174,6 +185,10 @@ def __init__(self, data, api=None, message=None):
 
         self.set_message(message)
 
+    def __eq__(self, other):
+        return isinstance(other, ParsedText) and \
+            self._entities == other._entities
+
     def __repr__(self):
         return '<ParsedText %s>' % repr(self._calculate_entities())
 
@@ -313,6 +328,7 @@ def from_(self):
         "forward_from": "_forward_from",
         "forward_from_chat": "_forward_from_chat",
     }
+    _check_equality_ = "message_id"
 
     def __init__(self, data, api=None):
         super().__init__(data, api)

botogram/objects/updates.py

@@ -23,6 +23,7 @@ class Update(BaseObject):
     optional = {
         "message": Message
     }
+    _check_equality_ = "update_id"
 
 
 # Shortcut for the Updates type

docs/changelog.rst

@@ -51,6 +51,7 @@ New features
 * Every method which sends something to a chat now returns the sent
   :py:class:`~botogram.Message`
 * Multiple instances of the same bot are now properly handled (as errors)
+* It's now possible to correctly compare API objects
 
 Changes
 -------