Merge pull request #192 from practical-python-org/bugfix/points-typing-issue

fix: Points cog typing issue

Author: Xarlos89

.env.example

@@ -8,4 +8,4 @@ ENVIRONMENT=dev #Lets us use just the one compose for both dev and prod
 
 # Logging
 LOGGING_LEVEL=20 
-STREAM_LOGS=FALSE
+STREAM_LOGS=FALSE

src/zorak/cogs/utility/points.py

@@ -8,6 +8,7 @@
 
 from zorak.utilities.cog_helpers._embeds import embed_leaderboard
 
+
 class Points(commands.Cog):
     """
     Handles automatic points based on activity.
@@ -41,14 +42,14 @@ async def on_message_delete(self, message: discord.Message):
         mod_log = await self.bot.fetch_channel(self.bot.server_settings.log_channel["mod_log"])
         await mod_log.send(f"1 Point removed from {message.author} for deleting a message.")
         self.bot.db_client.remove_points_from_user(message.author.id, 1)
-
-    # TODO: Fix the backup command.
-    # @commands.slash_command()
-    # @commands.has_any_role("Staff", "Owner", "Project Manager")
-    # async def backup_db(self, ctx):
-    #     """Backup the MongoDB instance."""
-    #     self.bot.db_client.backup_db()
-    #     await ctx.respond("Database backed up.")
+    #
+    # # TODO: Fix the backup command.
+    # # @commands.slash_command()
+    # # @commands.has_any_role("Staff", "Owner", "Project Manager")
+    # # async def backup_db(self, ctx):
+    # #     """Backup the MongoDB instance."""
+    # #     self.bot.db_client.backup_db()
+    # #     await ctx.respond("Database backed up.")
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
@@ -59,27 +60,29 @@ async def add_all_members_to_db(self, ctx):
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
-    async def add_points_to_user(self, ctx, mention: discord.Option[str], points: discord.Option[int]):
+    async def add_points_to_user(self, ctx, mention, points):
         """Add points to a user."""
         user = self.bot.get_user(int(mention.split("@")[1].split(">")[0]))
-        self.bot.db_client.add_points_to_user(user.id, points)
+        self.bot.db_client.add_points_to_user(user.id, int(points))
         mod_log = await self.bot.fetch_channel(self.bot.server_settings.log_channel["mod_log"])
-        await mod_log.send(f"{points} point{('s', '')[abs(points) == 1]} added to {mention} by {ctx.author}.")
-        await ctx.respond(f"{points} point{('s', '')[abs(points) == 1]} added to {mention}.")
+        await mod_log.send(f"{points} point{('s', '')[abs(int(points)) == 1]} added to {mention} by {ctx.author}.")
+        await ctx.respond(f"{points} point{('s', '')[abs(int(points)) == 1]} added to {mention}.")
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
-    async def add_points_to_all_users(self, ctx, points: discord.Option[int]):
+    async def add_points_to_all_users(self, ctx, points):
         """Add points to all users."""
-        self.bot.db_client.add_points_to_all_users(points)
+        self.bot.db_client.add_points_to_all_users(int(points))
         mod_log = await self.bot.fetch_channel(self.bot.server_settings.log_channel["mod_log"])
-        await mod_log.send(f"{points} point{('s', '')[abs(points) == 1]} added to all users by {ctx.author}.")
-        await ctx.respond(f"{points} point{('s', '')[abs(points) == 1]} added to all users.")
+        await mod_log.send(f"{points} point{('s', '')[abs(int(points)) == 1]} added to all users by {ctx.author}.")
+        await ctx.respond(f"{points} point{('s', '')[abs(int(points)) == 1]} added to all users.")
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
-    async def remove_points_from_user(self, ctx, mention: discord.Option[str], points: discord.Option[int]):
+    async def remove_points_from_user(self, ctx, mention, points):
         """Remove points from a user."""
+        mention = str(mention)
+        points = int(points)
         user = self.bot.get_user(int(mention.split("@")[1].split(">")[0]))
         self.bot.db_client.remove_points_from_user(user.id, points)
         mod_log = await self.bot.fetch_channel(self.bot.server_settings.log_channel["mod_log"])
@@ -88,17 +91,19 @@ async def remove_points_from_user(self, ctx, mention: discord.Option[str], point
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
-    async def remove_points_from_all_users(self, ctx, points: discord.Option[int]):
+    async def remove_points_from_all_users(self, ctx, points):
         """Remove points from all users."""
+        points = int(points)
         self.bot.db_client.remove_points_from_all_users(points)
         mod_log = await self.bot.fetch_channel(self.bot.server_settings.log_channel["mod_log"])
         await mod_log.send(f"{points} point{('s', '')[abs(points) == 1]} removed from all users by {ctx.author}.")
         await ctx.respond(f"{points} point{('s', '')[abs(points) == 1]} removed from all users.")
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
-    async def reset_points_for_user(self, ctx, mention: discord.Option[str]):
+    async def reset_points_for_user(self, ctx, mention):
         """Reset points for a user."""
+        mention = str(mention)
         user = self.bot.get_user(int(mention.split("@")[1].split(">")[0]))
         self.bot.db_client.set_user_points(user.id, 0)
         mod_log = await self.bot.fetch_channel(self.bot.server_settings.log_channel["mod_log"])
@@ -116,8 +121,9 @@ async def reset_points_for_all_users(self, ctx):
 
     @commands.slash_command()
     @commands.has_any_role("Staff", "Owner", "Project Manager")
-    async def get_points_for_user(self, ctx, mention: discord.Option[str]):
+    async def get_points_for_user(self, ctx, mention):
         """Get points for a user."""
+        mention = str(mention)
         user = self.bot.get_user(int(mention.split("@")[1].split(">")[0]))
         points = self.bot.db_client.get_user_points(user.id)
         await ctx.respond(f"{mention} has {points} point{('s', '')[abs(points) == 1]}.")
@@ -142,11 +148,11 @@ def is_staff(member_obj):
                 if not is_staff(member):
                     top10_no_staff.append((member, person['Points']))
 
-        embed = embed_leaderboard(top10_no_staff, self.bot.server_settings.server_info['name'], self.bot.server_settings.server_info['logo'])
+        embed = embed_leaderboard(top10_no_staff, self.bot.server_settings.server_info['name'],
+                                  self.bot.server_settings.server_info['logo'])
         await ctx.respond(embed=embed)
 
 
-
 def setup(bot):
     """required"""
     bot.add_cog(Points(bot))