Merge pull request #13 from A-Trash-Coder/master

Add a __eq__ and __ne__ to models Guild and User

flask_discord/models/guild.py

@@ -6,6 +6,15 @@
 class Guild(DiscordModelsBase):
     """Class representing discord Guild the user is part of.
 
+    Operations
+    ----------
+    x == y
+        Checks if two guild's are the same.
+    x != y
+        Checks if two guild's are not the same.
+    str(x)
+        Returns the guild's name.
+
     Attributes
     ----------
     id : int
@@ -35,6 +44,12 @@ def __init__(self, payload):
     def __str__(self):
         return self.name
 
+    def __eq__(self, guild):
+        return isinstance(guild, Guild) and guild.id == self.id
+
+    def __ne__(self, guild):
+        return not self.__eq__(guild)
+
     @property
     def icon_url(self):
         """A property returning direct URL to the guild's icon. Returns None if guild has no icon set."""

flask_discord/models/user.py

@@ -9,6 +9,16 @@
 class User(DiscordModelsBase):
     """Class representing Discord User.
 
+
+    Operations
+    ----------
+    x == y
+        Checks if two user's are the same.
+    x != y
+        Checks if two user's are not the same.
+    str(x)
+        Returns the user's name with discriminator.
+
     Attributes
     ----------
     id : int
@@ -78,6 +88,12 @@ def guilds(self, value):
     def __str__(self):
         return f"{self.name}#{self.discriminator}"
 
+    def __eq__(self, user):
+        return isinstance(user, User) and user.id == self.id
+
+    def __ne__(self, user):
+        return not self.__eq__(user)
+
     @property
     def name(self):
         """An alias to the username attribute."""