Merge pull request #23 from pythonplayer123/improve-tags

improved tags

Author: junepark678

.github/workflows/lint.yml

@@ -20,7 +20,7 @@ jobs:
       uses: actions/setup-python@v4
       id: cp311
       with:
-        python-version: 3.11
+        python-version: 3.12
 
     - name: Cache Dependencies
       uses: actions/cache@v3
@@ -34,8 +34,11 @@ jobs:
       run: |
         pip install .[dev]
 
-    - name: Run Linter
-      run: pylint src
+    - uses: chartboost/ruff-action@v1
+
+    - uses: chartboost/ruff-action@v1
+      with:
+        args: 'format --check'
 
     - name: Run mypy
       run: mypy src/SideBot

pyproject.toml

@@ -9,7 +9,7 @@ readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
     "discord.py>=2.3.2",
-    "psycopg2==2.9.9",
+    "asyncpg>=0.29.0",
 ]
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -18,11 +18,11 @@ classifiers = [
 
 [project.optional-dependencies]
 dev = [
-    "build",
-    "pylint",
-    "mypy",
-    "ruff",
-    "types-psycopg2",
+    "build>=1.2.1",
+    "pylint>=3.1.0",
+    "asyncpg-stubs>=0.29.1",
+    "mypy>=1.9.0",
+    "ruff>=0.3.7",
     "pyannotate>=1.2.0",
 ]
 

ruff.toml

@@ -37,7 +37,7 @@ target-version = "py311"
 [lint]
 # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
 select = ["ALL"]
-ignore = ["N999", "ANN101", "ANN102"]
+ignore = ["N999", "ANN101", "ANN102", "ANN401", "PLR0913"]
 
 # Allow fix for all enabled rules (when `--fix`) is provided.
 fixable = ["ALL"]

src/SideBot/__init__.py

@@ -5,11 +5,13 @@
 import pathlib
 import typing
 
+import asyncpg
 import discord
-import psycopg2
 from discord.ext import commands
 from discord.ext.commands import AutoShardedBot, Bot, when_mentioned_or
 
+from .utils import ButtonLink, DiscordUser
+
 
 class SideBot(Bot):
     """Custom SideBot class to simplify start up."""
@@ -22,15 +24,17 @@ def __init__(self, config: dict[str, str]) -> None:
 
         intents = discord.Intents.all()
 
-        super().__init__(command_prefix=when_mentioned_or("##"), intents=intents)
+        super().__init__(
+            command_prefix=when_mentioned_or("##"),
+            intents=intents,
+        )
 
         self.owner_id = int(self.config["OWNER"])
         self.conf_cogs = self.config["COGS"].split(",")
-        self.connection = self.setup_connection()
 
-    def setup_connection(self) -> psycopg2.extensions.connection:
+    async def setup_connection(self) -> asyncpg.Connection:
         """Set up the database connection."""
-        return psycopg2.connect(self.config["DATABASE_URL"])
+        return await asyncpg.connect(self.config["DATABASE_URL"])
 
     async def setup_hook(self) -> None:
         """Set up cogs and app commands."""
@@ -43,12 +47,36 @@ async def setup_hook(self) -> None:
     async def on_ready(self) -> None:
         """Handle bot ready status."""
         if self.user:
-            self.logger.info("Logged in as %s (ID: %s)", self.user, self.user.id)
+            self.logger.info(
+                "Logged in as %s (ID: %s)",
+                self.user,
+                self.user.id,
+            )
+            self.connection: asyncpg.Connection = await self.setup_connection()
+
+            await self.connection.set_type_codec(
+                "discorduser",
+                encoder=DiscordUser.to_tuple,
+                decoder=DiscordUser.from_tuple,
+                format="tuple",
+            )
+
+            await self.connection.set_type_codec(
+                "buttonlink",
+                encoder=ButtonLink.to_tuple,
+                decoder=ButtonLink.from_tuple,
+                format="tuple",
+            )
+
         else:
             self.logger.error("Error getting user")
 
     # pylint: disable=W0221
-    async def on_command_error(self, ctx: commands.Context[Bot | AutoShardedBot], error: Exception) -> None:
+    async def on_command_error(
+        self,
+        ctx: commands.Context[Bot | AutoShardedBot],
+        error: Exception,
+    ) -> None:
         """Handle unhandled command errors."""
         self.logger.error(ctx)
         self.logger.error(error)
@@ -61,8 +89,8 @@ def run(
     ) -> None:
         """Run the bot with the given token."""
         if token:
-            return super().run(token, root_logger=True, *args, **kwargs)
-        return super().run(self.__tok, root_logger=True, *args, **kwargs)
+            return super().run(token, *args, root_logger=True, **kwargs)
+        return super().run(self.__tok, *args, root_logger=True, **kwargs)
 
     @classmethod
     def from_env(cls, path: str = ".env") -> "SideBot":

src/SideBot/cogs/admin.py

@@ -5,7 +5,7 @@
 
 import discord
 from discord import Interaction, Member, Message, TextChannel
-from discord.app_commands import default_permissions, command, describe, errors
+from discord.app_commands import command, default_permissions, describe, errors
 from discord.ext import tasks
 from discord.ext.commands import Bot
 
@@ -81,7 +81,12 @@ def __init__(self, bot: Bot, channels_max: int = 4) -> None:
     @describe(count="Amount of messages to delete")
     @describe(member="The member to delete the messages from")
     @default_permissions(manage_messages=True)
-    async def clean(self, inter: Interaction, count: int, member: Member | None = None) -> None:
+    async def clean(
+        self,
+        inter: Interaction,
+        count: int,
+        member: Member | None = None,
+    ) -> None:
         """Clean `count` messages from optional `member` in the channel it's used."""
         if not isinstance(inter.channel, TextChannel):
             return await inter.response.send_message(
@@ -106,7 +111,11 @@ async def clean(self, inter: Interaction, count: int, member: Member | None = No
         return None
 
     @clean.error
-    async def app_command_error(self, inter: Interaction, err: errors.AppCommandError) -> None:
+    async def app_command_error(
+        self,
+        inter: Interaction,
+        err: errors.AppCommandError,
+    ) -> None:
         """Handle app command errors."""
         if isinstance(err, errors.MissingPermissions):
             return await inter.response.send_message(
@@ -131,7 +140,12 @@ async def on_message(self, message: Message) -> None:
             self.spammers.append(
                 SpamUser(
                     message.author.id,
-                    [SpamChannel(message.channel.id, [SpamMessage(message.id)])],
+                    [
+                        SpamChannel(
+                            message.channel.id,
+                            [SpamMessage(message.id)],
+                        ),
+                    ],
                 ),
             )
             return

src/SideBot/cogs/developer.py

@@ -30,7 +30,10 @@ def __init__(self, bot: Bot) -> None:
         super().__init__(bot)
         self.description = "This is for ny only"
 
-    async def cog_before_invoke(self, ctx: commands.Context[Bot | AutoShardedBot]) -> None:
+    async def cog_before_invoke(
+        self,
+        ctx: commands.Context[Bot | AutoShardedBot],
+    ) -> None:
         """Delete text command messages."""
         try:
             await ctx.message.delete()
@@ -48,13 +51,19 @@ async def load(self, inter: Interaction, cog: str) -> None:
         """Load `cog`'s extension into the bot."""
         try:
             await self.bot.load_extension(f"SideBot.cogs.{cog}")
-            return await inter.response.send_message(f"Loaded {cog}!", ephemeral=True)
+            return await inter.response.send_message(
+                f"Loaded {cog}!",
+                ephemeral=True,
+            )
         except (ExtensionAlreadyLoaded, ExtensionNotFound) as err:
             if isinstance(err, ExtensionAlreadyLoaded):
                 msg = f"{cog} is already loaded!"
             else:
                 msg = f"{cog} could not be found!"
-            return await inter.response.send_message(f"{msg}\n{err}", ephemeral=True)
+            return await inter.response.send_message(
+                f"{msg}\n{err}",
+                ephemeral=True,
+            )
         except Exception as err:  # pylint: disable=W0718 # noqa: BLE001
             return await inter.response.send_message(
                 f"Failed to load {cog}!\n{err}",
@@ -71,7 +80,10 @@ async def unload(self, inter: Interaction, cog: str) -> None:
             )
         try:
             await self.bot.unload_extension(f"SideBot.cogs.{cog}")
-            return await inter.response.send_message(f"Unloaded {cog}!", ephemeral=True)
+            return await inter.response.send_message(
+                f"Unloaded {cog}!",
+                ephemeral=True,
+            )
         except ExtensionNotLoaded:
             return await inter.response.send_message(
                 f"Failed to unload non-loaded {cog}!",
@@ -85,7 +97,10 @@ async def reload(self, inter: Interaction, cog: str) -> None:
         """Reload `cog`'s extension file."""
         try:
             await self.bot.reload_extension(f"SideBot.cogs.{cog}")
-            return await inter.response.send_message(f"Reloaded {cog}!", ephemeral=True)
+            return await inter.response.send_message(
+                f"Reloaded {cog}!",
+                ephemeral=True,
+            )
         except (ExtensionNotLoaded, ExtensionNotFound) as err:
             if isinstance(err, ExtensionNotLoaded):
                 msg = f"Cannot reload {cog}! Did you forget to /load it?"
@@ -142,12 +157,19 @@ async def sync(
             else:
                 ret += 1
 
-        await ctx.send(f"Synced the tree to {ret}/{len(guilds)}.", delete_after=5)
+        await ctx.send(
+            f"Synced the tree to {ret}/{len(guilds)}.",
+            delete_after=5,
+        )
 
     @load.error
     @unload.error
     @reload.error
-    async def app_command_error(self, inter: Interaction, err: errors.AppCommandError) -> None:
+    async def app_command_error(
+        self,
+        inter: Interaction,
+        err: errors.AppCommandError,
+    ) -> None:
         """Handle app command errors."""
         if isinstance(err, errors.CheckFailure):
             if self.bot.owner_id != inter.user.id: