Merge branch '90-00-in-score'

Reviewed-on: #94
Reviewed-by: imcompiling <[email protected]>

.dockerignore

@@ -1,2 +1,5 @@
 .*
 Dockerfile
+LICENSE
+README.md
+renovate.json

.gitea/workflows/build_develop.yml

@@ -2,7 +2,11 @@ name: build_develop
 
 on:
   push:
-    branches: [main]
+    branches:
+      - "*"
+      - "!main"
+    paths-ignore:
+      - "README.md"
 
 jobs:
   build:
@@ -20,7 +24,9 @@ jobs:
           registry: gitea.cheezers.org
           username: imcompiling
           password: ${{ secrets.PASSWORD }}
+      - name: set env
+        run: echo "GIT_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
       - name: Build Docker Image
-        run: docker build -t gitea.cheezers.org/imcompiling/agon:develop .
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:${{env.GIT_BRANCH}} .
       - name: Push Docker Image
-        run: docker push gitea.cheezers.org/imcompiling/agon:develop
+        run: docker push gitea.cheezers.org/imcompiling/agon:${{env.GIT_BRANCH}}

.gitea/workflows/build_latest.yaml

@@ -0,0 +1,28 @@
+name: build_latest
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "README.md"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Docker
+        uses: https://github.com/papodaca/install-docker-action@v1
+      - name: Log into container registry
+        uses: docker/login-action@v3
+        with:
+          registry: gitea.cheezers.org
+          username: imcompiling
+          password: ${{ secrets.PASSWORD }}
+      - name: Build Docker Image
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:latest .
+      - name: Push Docker Image
+        run: docker push gitea.cheezers.org/imcompiling/agon:latest

.gitea/workflows/build_release.yml

@@ -23,8 +23,6 @@ jobs:
       - name: Set env
         run: echo "GIT_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
       - name: Build Docker Images
-        run: docker build -t gitea.cheezers.org/imcompiling/agon:latest -t gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}} .
+        run: docker build -t gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}} .
-      - name: Push Latest Image
-        run: docker push gitea.cheezers.org/imcompiling/agon:latest
       - name: Push Tagged Image
         run: docker push gitea.cheezers.org/imcompiling/agon:${{env.GIT_TAG}}

.gitignore

@@ -135,4 +135,4 @@ deleted_backups/
 highscores_data/
 TODO.txt
 sql_tester.py
-database.db
+/database

.vscode/launch.json

@@ -8,8 +8,8 @@
             "name": "Python: Module",
             "type": "debugpy",
             "request": "launch",
-            "module": "main",
+            "module": "agon",
             "justMyCode": true
         }
     ]
-}
+}

.vscode/settings.json

@@ -10,8 +10,8 @@
         "ondelete"
     ],
     "python.analysis.diagnosticSeverityOverrides": {
-        "reportOptionalMemberAccess": false,
+        "reportOptionalMemberAccess": "warning",
         "reportArgumentType": "information",
         "reportAttributeAccessIssue": "warning"
     }
-}
+}

Dockerfile

@@ -1,15 +1,15 @@
 FROM python:3.12.3-slim
 
 # install uv
-COPY --from=ghcr.io/astral-sh/uv:0.6.2 /uv /uvx /bin/
+COPY --from=ghcr.io/astral-sh/uv:0.6.12 /uv /uvx /bin/
 
 RUN apt-get update && apt-get -y upgrade && apt-get -y install sqlite3
 
 # Copy project to image
-ADD . /agon
+ADD . /home
 
 # Sync the project into a new environment, using the frozen lockfile
-WORKDIR /agon
+WORKDIR /home
 RUN uv sync --frozen --no-dev
 
-CMD ["uv", "run", "./main.py"]
+CMD ["uv", "run", "--frozen", "--no-dev", "-m", "agon"]

agon/__init__.py

@@ -0,0 +1 @@
+"""Empty init file for off_cooldown_bot module."""

agon/__main__.py

@@ -0,0 +1,14 @@
+"""Starts the app for agon."""
+
+import logging
+
+from .app import run
+
+nextcord_logger = logging.getLogger("nextcord")
+nextcord_logger.setLevel(logging.DEBUG)
+nextcord_handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
+nextcord_handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
+nextcord_logger.addHandler(nextcord_handler)
+
+if __name__ == "__main__":
+    run()

agon/app.py

@@ -1,23 +1,16 @@
 """Main file for Agon bot."""
 
-import logging
+import pathlib
-import os
 import sys
 
 import nextcord
 from nextcord.ext import commands
 
-from utilities import config
+from . import config
-from utilities.logger import agon_logger
+from .logger import agon_logger
-
-nextcord_logger = logging.getLogger("nextcord")
-nextcord_logger.setLevel(logging.DEBUG)
-nextcord_handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
-nextcord_handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
-nextcord_logger.addHandler(nextcord_handler)
 
 
-def main() -> None:
+def run() -> None:
     """Main function for bot."""
     min_python_version = (3, 12)
     if sys.version_info < min_python_version:
@@ -34,8 +27,8 @@ def main() -> None:
     )
 
     # Get the modules of all cogs whose directory structure is ./cogs/<module_name>
-    for folder in os.listdir("cogs"):
+    for folder in pathlib.Path("./agon/cogs").iterdir():
-        bot.load_extension(f"cogs.{folder}")
+        bot.load_extension(f"agon.cogs.{folder.name}")
 
     @bot.listen()
     async def on_ready() -> None:
@@ -47,7 +40,3 @@ def main() -> None:
 
     # Run Discord bot
     bot.run(config.DISCORD_TOKEN)
-
-
-if __name__ == "__main__":
-    main()

agon/cogs/commands/__init__.py

@@ -2,15 +2,15 @@
 
 from nextcord.ext import commands
 
-from cogs.commands.create import CreateCog
+from agon.cogs.commands.create import CreateCog
-from cogs.commands.delete import DeleteCog
+from agon.cogs.commands.delete import DeleteCog
-from cogs.commands.get import GetCog
+from agon.cogs.commands.get import GetCog
-from cogs.commands.help import HelpCog
+from agon.cogs.commands.help import HelpCog
-from cogs.commands.refresh import RefreshCog
+from agon.cogs.commands.refresh import RefreshCog
-from cogs.commands.set import SetCog
+from agon.cogs.commands.set import SetCog
-from cogs.commands.submission import SubmissionCog
+from agon.cogs.commands.submission import SubmissionCog
-from cogs.commands.update import UpdateCog
+from agon.cogs.commands.update import UpdateCog
-from cogs.commands.view import ViewCog
+from agon.cogs.commands.view import ViewCog
 
 
 # This function will be called when this extension is loaded.

agon/cogs/commands/create.py

@@ -6,9 +6,9 @@ from sqlalchemy import exc, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup
+from agon.database.models import Category, CategoryGroup
-from utilities.utils import MAX_LINE_LENGTH, autofill_groups, send_highscore_message
+from agon.utils import MAX_LINE_LENGTH, autofill_groups, send_highscore_message
 
 
 class CreateCog(commands.Cog, name="Create Cog"):
@@ -99,7 +99,7 @@ class CreateCog(commands.Cog, name="Create Cog"):
             min_value=1,
             max_value=30,
         ),
-        channel: nextcord.TextChannel | None = nextcord.SlashOption(
+        channel: nextcord.TextChannel | nextcord.Thread | None = nextcord.SlashOption(
             description="Channel to post Group in. If left empty, defaults to current channel.",
             required=False,
             default=None,

agon/cogs/commands/delete.py

@@ -6,9 +6,9 @@ from sqlalchemy import distinct, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup, Score
+from agon.database.models import Category, CategoryGroup, Score
-from utilities.utils import (
+from agon.utils import (
     autofill_categories,
     autofill_groups,
     autofill_users_in_group_category,
@@ -37,7 +37,7 @@ class DeleteCog(commands.Cog, name="Delete Cog"):
     async def channel_messages(
         self,
         interaction: nextcord.Interaction,
-        channel: nextcord.TextChannel | None = nextcord.SlashOption(
+        channel: nextcord.TextChannel | nextcord.Thread | None = nextcord.SlashOption(
             description="Channel to clear of messages.",
             required=False,
             default=None,
@@ -54,7 +54,7 @@ class DeleteCog(commands.Cog, name="Delete Cog"):
                 Is a SlashOption. Limited to text channels. Defaults to None.
         """
         if not channel:
-            if isinstance(interaction.channel, nextcord.TextChannel):
+            if isinstance(interaction.channel, nextcord.TextChannel | nextcord.Thread):
                 channel = interaction.channel
             else:
                 # This should never happen.

agon/cogs/commands/get.py

@@ -4,9 +4,9 @@ import nextcord
 from nextcord.ext import commands
 from sqlmodel import Session, col, select
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup
+from agon.database.models import Category, CategoryGroup
-from utilities.utils import autofill_categories, autofill_groups
+from agon.utils import autofill_categories, autofill_groups
 
 
 class GetCog(commands.Cog, name="Get command."):
@@ -37,21 +37,20 @@ class GetCog(commands.Cog, name="Get command."):
 
         Args:
             interaction (nextcord.Interaction):  Interaction that invoked the command.
-            group_id (str): String representation of Group id to register channel to. Is SlashOption.
+            group_id (str): String representation of Group id get information from. Is SlashOption.
-            category_id (str): String representation of Category id to register channel to. Is SlashOption.
+            category_id (str): String representation of Category id to get information from. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Group or Category was not found.", ephemeral=True)
                 return
 
             await interaction.response.send_message(
-                f"{category.name} is sorted in {'ascending' if category.is_ascending else 'descending'} order.",
+                f"**{category.name}** is sorted in **{'ascending' if category.is_ascending else 'descending'}** order.",
                 ephemeral=True,
             )
 
@@ -69,16 +68,15 @@ class GetCog(commands.Cog, name="Get command."):
 
         Args:
             interaction (nextcord.Interaction):  Interaction that invoked the command.
-            group_id (str): String representation of Group id to register channel to. Is SlashOption.
+            group_id (str): String representation of Group id get information from. Is SlashOption.
-            category_id (str): String representation of Category id to register channel to. Is SlashOption.
+            category_id (str): String representation of Category id to get information from. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Group or Category was not found.", ephemeral=True)
                 return
 
@@ -99,25 +97,76 @@ class GetCog(commands.Cog, name="Get command."):
 
         Args:
             interaction (nextcord.Interaction):  Interaction that invoked the command.
-            group_id (str): String representation of Group id to register channel to. Is SlashOption.
+            group_id (str): String representation of Group id get information from. Is SlashOption.
-            category_id (str): String representation of Category id to register channel to. Is SlashOption.
+            category_id (str): String representation of Category id to get information from. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Group or Category was not found.", ephemeral=True)
                 return
 
-            await interaction.response.send_message(f"{category.name} has a size of {category.size}.", ephemeral=True)
+            await interaction.response.send_message(
+                f"**{category.name}** has a size of **{category.size}**.", ephemeral=True
+            )
 
     @get.subcommand(description="Commands for getting group information.")
     async def group(self, interaction: nextcord.Interaction) -> None:
         """Parent slash subcommand for getting group information. Never called."""
 
+    @group.subcommand(description="Get the pad length of a group.")
+    async def pad_length(
+        self,
+        interaction: nextcord.Interaction,
+        group_id: str = nextcord.SlashOption(name="group", description="Group to get pad length of.", required=True),
+    ) -> None:
+        """
+        Command to view a group's pad length.
+
+        Args:
+            interaction (nextcord.Interaction):  Interaction that invoked the command.
+            group_id (str): String representation of Group id get information from. Is SlashOption.
+        """
+        stmt = select(CategoryGroup).where(col(CategoryGroup.id) == int(group_id))
+
+        with Session(engine) as session:
+            if (group := session.scalar(stmt)) is None:
+                await interaction.response.send_message("Group was not found.", ephemeral=True)
+                return
+
+            await interaction.response.send_message(
+                f"**{group.name}** has a pad length of **{group.pad_length}**.", ephemeral=True
+            )
+
+    @group.subcommand(description="Get the username length of a group.")
+    async def username_length(
+        self,
+        interaction: nextcord.Interaction,
+        group_id: str = nextcord.SlashOption(
+            name="group", description="Group to get username length of.", required=True
+        ),
+    ) -> None:
+        """
+        Command to view a group's username length.
+
+        Args:
+            interaction (nextcord.Interaction):  Interaction that invoked the command.
+            group_id (str): String representation of Group id get information from. Is SlashOption.
+        """
+        stmt = select(CategoryGroup).where(col(CategoryGroup.id) == int(group_id))
+
+        with Session(engine) as session:
+            if (group := session.scalar(stmt)) is None:
+                await interaction.response.send_message("Group was not found.", ephemeral=True)
+                return
+
+            await interaction.response.send_message(
+                f"**{group.name}** has a username length of **{group.username_length}**.", ephemeral=True
+            )
+
     @is_ascending.on_autocomplete("category_id")
     @is_validated.on_autocomplete("category_id")
     @size.on_autocomplete("category_id")
@@ -136,7 +185,9 @@ class GetCog(commands.Cog, name="Get command."):
 
     @is_ascending.on_autocomplete("group_id")
     @is_validated.on_autocomplete("group_id")
+    @pad_length.on_autocomplete("group_id")
     @size.on_autocomplete("group_id")
+    @username_length.on_autocomplete("group_id")
     async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str) -> None:
         """
         Sends results from autofill_groups back to group_output_channel for autocompletion of group_id.

agon/cogs/commands/refresh.py

@@ -6,9 +6,9 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import CategoryGroup
+from agon.database.models import CategoryGroup
-from utilities.utils import autofill_groups, send_highscore_message
+from agon.utils import autofill_groups, send_highscore_message
 
 
 class RefreshCog(commands.Cog, name="Refresh Cog"):

agon/cogs/commands/set.py

@@ -6,10 +6,10 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup, Guild
+from agon.database.models import Category, CategoryGroup, Guild
-from utilities.logger import agon_logger
+from agon.logger import agon_logger
-from utilities.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, send_highscore_message
+from agon.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, send_highscore_message
 
 
 class SetCog(commands.Cog, name="Set command."):
@@ -22,7 +22,7 @@ class SetCog(commands.Cog, name="Set command."):
     async def set(self, interaction: nextcord.Interaction) -> None:
         """Parent slash command for setting settings. Never called."""
 
-    @set.subcommand("Commands for editing a category.")
+    @set.subcommand(description="Commands for editing a category.")
     async def category(self, interaction: nextcord.Interaction) -> None:
         """Parent slash subcommand for setting category settings. Never called."""
 
@@ -46,31 +46,29 @@ class SetCog(commands.Cog, name="Set command."):
             size (int): Size to set. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Category or Group was not found.", ephemeral=True)
                 return
             category.size = size
-            # session.add(category) test if this is needed. SQLAlchemy can do the update without adding.
             session.commit()
 
             # Use the relationship to get group category is in.
-            group = category.category_group
+            if (group := category.category_group) is None:
-            if group is None:
                 agon_logger.warning(f"{category.name}:{category.id} group relationship was None.")
 
                 stmt = select(CategoryGroup).where(col(CategoryGroup.id) == group_id)
-                group = session.scalar(stmt)
+                if (group := session.scalar(stmt)) is None:
-                if group is None:
                     await interaction.response.send_message("Group was not found.", ephemeral=True)
                     return
 
             await send_highscore_message(session, interaction.guild, group)
-        await interaction.response.send_message(f"{category.name} size has been updated to {size}.", ephemeral=True)
+        await interaction.response.send_message(
+            f"**{category.name}** size has been updated to **{size}**.", ephemeral=True
+        )
 
     @category.subcommand(description="Update the is_ascending value for a category.")
     async def is_ascending(
@@ -94,32 +92,28 @@ class SetCog(commands.Cog, name="Set command."):
             ascending (bool): Boolean to set. Determines whether scores are sorted ascending or not. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Category or Group was not found.", ephemeral=True)
                 return
             category.is_ascending = ascending
-            # session.add(category) test if this is needed. SQLAlchemy can do the update without adding.
             session.commit()
 
             # Use the relationship to get group category is in.
-            group = category.category_group
+            if (group := category.category_group) is None:
-            if group is None:
                 agon_logger.warning(f"{category.name}:{category.id} group relationship was None.")
 
                 stmt = select(CategoryGroup).where(col(CategoryGroup.id) == group_id)
-                group = session.scalar(stmt)
+                if (group := session.scalar(stmt)) is None:
-                if group is None:
                     await interaction.response.send_message("Group was not found.", ephemeral=True)
                     return
 
             await send_highscore_message(session, interaction.guild, group)
         await interaction.response.send_message(
-            f"{category.name} is_ascending has been updated to {ascending}.", ephemeral=True
+            f"**{category.name}** is_ascending has been updated to **{ascending}**.", ephemeral=True
         )
 
     @category.subcommand(description="Update the is_validated value for a category.")
@@ -144,32 +138,19 @@ class SetCog(commands.Cog, name="Set command."):
             validated (bool): Boolean to set. Determines whether scores are validated or not. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Category or Group was not found.", ephemeral=True)
                 return
             category.is_validated = validated
-            # session.add(category) test if this is needed. SQLAlchemy can do the update without adding.
             session.commit()
 
-            # Use the relationship to get group category is in.
+            await interaction.response.send_message(
-            group = category.category_group
+                f"**{category.name}** is_validated has been updated to **{validated}**.", ephemeral=True
-            if group is None:
+            )
-                agon_logger.warning(f"{category.name}:{category.id} group relationship was None.")
-
-                stmt = select(CategoryGroup).where(col(CategoryGroup.id) == group_id)
-                group = session.scalar(stmt)
-                if group is None:
-                    await interaction.response.send_message("Group was not found.", ephemeral=True)
-                    return
-
-        await interaction.response.send_message(
-            f"{category.name} is_validated has been updated to {validated}.", ephemeral=True
-        )
 
     @category.subcommand(name="name", description="Change the name of a category.")
     async def category_name(
@@ -191,32 +172,30 @@ class SetCog(commands.Cog, name="Set command."):
             name (str): The name to update the category's name to. Is SlashOption.
         """
         stmt = (
-            select(Category).where(col(CategoryGroup.id) == int(group_id)).where(col(Category.id) == int(category_id))
+            select(Category).where(col(Category.group_id) == int(group_id)).where(col(Category.id) == int(category_id))
         )
 
         with Session(engine) as session:
-            category = session.scalar(stmt)
+            if (category := session.scalar(stmt)) is None:
-            if category is None:
                 await interaction.response.send_message("Category or Group was not found.", ephemeral=True)
                 return
             old_name = category.name
             category.name = name
-            # session.add(category) test if this is needed. SQLAlchemy can do the update without adding.
             session.commit()
 
             # Use the relationship to get group category is in.
-            group = category.category_group
+            if (group := category.category_group) is None:
-            if group is None:
                 agon_logger.warning(f"{category.name}:{category.id} group relationship was None.")
 
                 stmt = select(CategoryGroup).where(col(CategoryGroup.id) == group_id)
-                group = session.scalar(stmt)
+                if (group := session.scalar(stmt)) is None:
-                if group is None:
                     await interaction.response.send_message("Group was not found.", ephemeral=True)
                     return
 
             await send_highscore_message(session, interaction.guild, group)
-        await interaction.response.send_message(f"{old_name} has been updated to {category.name}.", ephemeral=True)
+        await interaction.response.send_message(
+            f"**{old_name}** has been updated to **{category.name}**.", ephemeral=True
+        )
 
     @set.subcommand(description="Commands for editing a group.")
     async def group(self, interaction: nextcord.Interaction) -> None:
@@ -240,8 +219,7 @@ class SetCog(commands.Cog, name="Set command."):
         stmt = select(CategoryGroup).where(col(CategoryGroup.id) == int(group_id))
 
         with Session(engine) as session:
-            group = session.scalar(stmt)
+            if (group := session.scalar(stmt)) is None:
-            if group is None:
                 await interaction.response.send_message("Group was not found.", ephemeral=True)
                 return
             old_name = group.name
@@ -250,7 +228,7 @@ class SetCog(commands.Cog, name="Set command."):
             session.commit()
 
             await send_highscore_message(session, interaction.guild, group)
-        await interaction.response.send_message(f"{old_name} has been updated to {group.name}.", ephemeral=True)
+        await interaction.response.send_message(f"**{old_name}** has been updated to **{group.name}**.", ephemeral=True)
 
     @group.subcommand(description="Registers the channel for a Group's messages.")
     async def output_channel(
@@ -273,6 +251,10 @@ class SetCog(commands.Cog, name="Set command."):
             channel (nextcord.abc.GuildChannel, optional): Channel to register.
                 Is a SlashOption. Limited to text channels, Defaults to None.
         """
+        if interaction.guild is None or interaction.channel is None:
+            agon_logger.warning("Set command was called with an interaction that had no guild or channel.")
+            return
+
         channel_id = interaction.channel.id if not channel else channel.id
 
         with Session(engine) as session:
@@ -281,9 +263,17 @@ class SetCog(commands.Cog, name="Set command."):
                 .where(col(CategoryGroup.guild_id) == interaction.guild_id)
                 .where(col(CategoryGroup.id) == int(group_id))
             )
-            group = session.scalar(stmt)
+            if (group := session.scalar(stmt)) is None:
-            group.ChannelId = channel_id
+                await interaction.response.send_message("Group or Category was not found.", ephemeral=True)
+                return
+            old_channel_id = group.channel_id
+            group.channel_id = channel_id
             session.commit()
+
+            old_channel = interaction.guild.get_channel(old_channel_id)
+            if old_channel and isinstance(old_channel, nextcord.TextChannel | nextcord.Thread) and group.message_id:
+                await old_channel.get_partial_message(group.message_id).delete()
+
         await interaction.send(f"Registered <#{channel_id}>.", ephemeral=True)
 
     @group.subcommand(
@@ -315,14 +305,14 @@ class SetCog(commands.Cog, name="Set command."):
                 .where(col(CategoryGroup.guild_id) == interaction.guild_id)
                 .where(col(CategoryGroup.id) == int(group_id))
             )
-            group = session.scalar(stmt)
+            if (group := session.scalar(stmt)) is None:
-            if group is None:
                 await interaction.response.send_message("Group was not found.", ephemeral=True)
                 return
-            group.PadLength = length
+
+            group.pad_length = length
             session.commit()
             await interaction.response.send_message(
-                f"Category pad length set to {length} for {group.name}", ephemeral=True
+                f"Category pad length set to **{length}** for **{group.name}**.", ephemeral=True
             )
             await send_highscore_message(session, interaction.guild, group)
 
@@ -351,7 +341,9 @@ class SetCog(commands.Cog, name="Set command."):
 
         with Session(engine) as session:
             stmt = select(Guild).where(col(Guild.id) == interaction.guild_id)
-            guild = session.scalar(stmt)
+            if (guild := session.scalar(stmt)) is None:
+                await interaction.response.send_message("Guild was not found.", ephemeral=True)
+                return
             guild.submission_channel = channel_id
             session.commit()
         await interaction.send(f"Registered <#{channel_id}>.", ephemeral=True)
@@ -381,10 +373,15 @@ class SetCog(commands.Cog, name="Set command."):
                 .where(col(CategoryGroup.guild_id) == interaction.guild_id)
                 .where(col(CategoryGroup.id) == int(group_id))
             )
-            group = session.scalar(stmt)
+            if (group := session.scalar(stmt)) is None:
-            group.UsernameLength = length
+                await interaction.response.send_message("Group or Category was not found.", ephemeral=True)
+                return
+
+            group.username_length = length
             session.commit()
-        await interaction.response.send_message(f"Username length set to {length}.", ephemeral=True)
+        await interaction.response.send_message(
+            f"Username length for **{group.name}** set to **{length}**.", ephemeral=True
+        )
 
     @set.subcommand(description="Registers the channel for verification messages.")
     async def verify_channel(
@@ -409,8 +406,10 @@ class SetCog(commands.Cog, name="Set command."):
 
         with Session(engine) as session:
             stmt = select(Guild).where(col(Guild.id) == interaction.guild_id)
-            guild = session.scalar(stmt)
+            if (guild := session.scalar(stmt)) is None:
-            guild.VerificationChannel = channel_id
+                await interaction.response.send_message("Guild was not found.", ephemeral=True)
+                return
+            guild.verification_channel = channel_id
             session.commit()
         await interaction.send(f"Registered <#{channel_id}>.", ephemeral=True)
 

agon/cogs/commands/submission.py

@@ -8,11 +8,11 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from cogs.submission.verification_view import VerificationView
+from agon.cogs.submission.verification_view import VerificationView
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup, Guild, Submission
+from agon.database.models import Category, CategoryGroup, Guild, Submission
-from main import agon_logger
+from agon.logger import agon_logger
-from utilities.utils import autofill_categories, autofill_groups, submit_score
+from agon.utils import autofill_categories, autofill_groups, submit_score
 
 
 class SubmissionCog(commands.Cog):
@@ -64,10 +64,7 @@ class SubmissionCog(commands.Cog):
                 .where(col(Category.group_id) == int(group_id))
                 .where(col(Category.id) == int(category_id))
             )
-
+            if (category := session.scalar(stmt)) is None:
-            category: Category | None = session.scalar(stmt)
-
-            if category is None:
                 await interaction.response.send_message("Category not found.", ephemeral=True)
                 return
 
@@ -79,10 +76,11 @@ class SubmissionCog(commands.Cog):
                 return
 
             # check with regex if score is in correct format
-            verified_score = await self.verify_score(interaction, score, is_time_record=category.is_time_record)
-
             # check if verify_score was successful. It replies with corrections required itself.
-            if verified_score is None:
+            if (
+                verified_score := await self.verify_score(interaction, score, is_time_record=category.is_time_record)
+            ) is None:
+                # Verify score handles responding. Might change when submit is split up.
                 return
 
             # Create submission verification request or submit score if verification not needed.
@@ -92,21 +90,18 @@ class SubmissionCog(commands.Cog):
                 return
 
             stmt = select(col(Guild.verification_channel)).where(col(Guild.id) == interaction.guild_id)
-            verification_channel_id: int | None = session.scalar(stmt)
 
-            if verification_channel_id is None:
+            if (verification_channel_id := session.scalar(stmt)) is None:
                 error_response = "No verification channel was registered. Contact server admins."
                 await interaction.response.send_message(error_response, ephemeral=True)
                 return
 
-            channel = interaction.guild.get_channel(verification_channel_id)
+            if (channel := interaction.guild.get_channel(verification_channel_id)) is None:
-
-            if channel is None:
                 error_response = "Registered Verification channel does not exist. Contact server admins."
                 await interaction.response.send_message(error_response, ephemeral=True)
                 return
 
-            if not isinstance(channel, nextcord.TextChannel):
+            if not isinstance(channel, nextcord.TextChannel | nextcord.Thread):
                 await interaction.response.send_message("An error happened with submission.")
                 agon_logger.error(
                     "Channel id %s in guild %s is does not correspond to a TextChannel.", channel.id, channel.guild.id
@@ -213,9 +208,9 @@ class SubmissionCog(commands.Cog):
             elif re.search("^[0-9](\\.[0-9])?$", score):
                 # need to add 0 in seconds and leading colon and 0
                 score = "0:0" + score
-            elif re.search("^[0]?[0-9]:[0-9]{2}(\\.[0-9])?$", score):
+            elif re.search("^[0][0-9]:[0-9]{2}(\\.[0-9])?$", score):
                 # if there is a minute 10ths place 0, remove
-                score = score.lstrip("0")
+                score = score[1:]
 
         return score
 

agon/cogs/commands/update.py

@@ -6,9 +6,9 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Guild
+from agon.database.models import Guild
-from utilities.utils import autofill_users_in_guild
+from agon.utils import autofill_users_in_guild
 
 from .views.update_username_verify import UpdateUsernameVerifyView
 

agon/cogs/commands/view.py

@@ -7,9 +7,9 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup, Score
+from agon.database.models import Category, CategoryGroup, Score
-from utilities.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, format_score_string
+from agon.utils import MAX_LINE_LENGTH, autofill_categories, autofill_groups, format_score_string
 
 
 class ViewCog(commands.Cog, name="View Command"):

agon/cogs/commands/views/delete_confirm.py

@@ -4,9 +4,9 @@ import nextcord
 from sqlalchemy import delete, select
 from sqlalchemy.orm import Session
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup
+from agon.database.models import Category, CategoryGroup
-from utilities.utils import send_highscore_message
+from agon.utils import send_highscore_message
 
 
 class DeleteConfirmView(nextcord.ui.Modal):
@@ -43,7 +43,7 @@ class DeleteConfirmView(nextcord.ui.Modal):
                 session.delete(group)
                 # delete the message related to group
                 channel = interaction.guild.get_channel(group.channel_id)
-                if not isinstance(channel, nextcord.TextChannel):
+                if not isinstance(channel, nextcord.TextChannel | nextcord.Thread):
                     return
                 message: nextcord.Message = await channel.fetch_message(group.message_id)
                 await message.delete()

agon/cogs/commands/views/update_username_verify.py

@@ -5,9 +5,9 @@ from sqlalchemy import distinct, exc, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup, Score
+from agon.database.models import Category, CategoryGroup, Score
-from utilities.utils import send_highscore_message
+from agon.utils import send_highscore_message
 
 
 class UpdateUsernameVerifyView(nextcord.ui.View):

agon/cogs/guild_listener/__init__.py

@@ -6,8 +6,8 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Guild
+from agon.database.models import Guild
 
 
 class GuildListener(commands.Cog, name="Guild Listener"):
@@ -26,10 +26,9 @@ class GuildListener(commands.Cog, name="Guild Listener"):
         """
         with Session(engine) as session:
             stmt = select(Guild).where(col(Guild.id == guild.id))
-            guild_data = session.scalar(stmt)
 
             # just in case check if the guild already exists
-            if guild_data is None:
+            if (guild_data := session.scalar(stmt)) is None:
                 new_guild = Guild(id=guild.id, name=guild.name)
                 session.add(new_guild)
             else:

agon/cogs/loops/guild_data.py

@@ -5,8 +5,8 @@ from sqlalchemy import select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Guild
+from agon.database.models import Guild
 
 
 class GuildData(commands.Cog, name="Guild Data"):
@@ -31,7 +31,7 @@ class GuildData(commands.Cog, name="Guild Data"):
         with Session(engine) as session:
             for guild in self.bot.guilds:
                 # update given guild name for guild id
-                stmt = select(Guild).where(col(Guild.id == guild.id))
+                stmt = select(Guild).where(col(Guild.id) == guild.id)
                 guild_data = session.scalar(stmt)
 
                 # just in case checking if the guild doesn't exist.
@@ -39,6 +39,6 @@ class GuildData(commands.Cog, name="Guild Data"):
                     new_guild = Guild(id=guild.id, name=guild.name)
                     session.add(new_guild)
                 else:
-                    guild_data.GuildName = guild.name
+                    guild_data.name = guild.name
 
                 session.commit()

agon/cogs/submission/verification_view.py

@@ -5,9 +5,9 @@ from sqlalchemy import delete, select
 from sqlalchemy.orm import Session
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Submission
+from agon.database.models import Submission
-from utilities.utils import submit_score
+from agon.utils import submit_score
 
 
 class VerificationView(nextcord.ui.View):
@@ -39,9 +39,7 @@ class VerificationView(nextcord.ui.View):
                 .where(col(Submission.message_id) == interaction.message.id)
             )
 
-            submission = session.scalar(stmt)
+            if (submission := session.scalar(stmt)) is None:
-
-            if submission is None:
                 await interaction.response.send_message("Could not find submission data in database.", ephemeral=True)
                 await interaction.message.delete()
                 return

agon/database/db.py

@@ -1,14 +1,18 @@
 """Simple file to set up the sqlmodel connection to database."""
 
 from sqlmodel import SQLModel, create_engine
-from utilities import config
+
+from agon import config
+from agon.logger import agon_logger
 
 from . import models  # noqa: F401 - Need this import for creating the models.
 
 if config.ENVIRONMENT == "prod":
     url = f"mysql+pymysql://{config.SQL_USER}:{config.SQL_PASS}@{config.SQL_HOST}/{config.SQL_DB}"
+    agon_logger.info("Connected to prod database.")
 else:
-    url = "sqlite:///database.db"
+    url = "sqlite:///database/database.db"
+    agon_logger.info("Connected to local dev database.")
 engine = create_engine(url)
 
 # Don't need to create all when connected to prod.

agon/utils.py

@@ -8,8 +8,9 @@ from sqlalchemy import distinct, select
 from sqlalchemy.orm import Session, aliased
 from sqlmodel import col
 
-from database.db import engine
+from agon.database.db import engine
-from database.models import Category, CategoryGroup, Guild, Score
+from agon.database.models import Category, CategoryGroup, Guild, Score
+from agon.logger import agon_logger
 
 MAX_LINE_LENGTH = 142
 
@@ -64,7 +65,7 @@ def autofill_groups(guild_id: int, group_begin: str) -> "dict[str, str]":
     """
     with Session(engine) as session:
         # Select all groups in guild.
-        stmt = select(CategoryGroup).wherecol((CategoryGroup.guild_id) == guild_id)
+        stmt = select(CategoryGroup).where(col(CategoryGroup.guild_id) == guild_id)
 
         # dict has to have key values of same type for discord.
         group_dict: dict[str, str] = {group.name: str(group.id) for group in session.scalars(stmt)}
@@ -275,6 +276,8 @@ def format_highscore_message(session: Session, group: CategoryGroup) -> str:
     return ret_string + "```"
 
 
+# TODO(imcompiling): rework into two functions to remove the boolean and reduce function arguments.
+# 084
 def format_score_string(
     username: str,
     score: float,
@@ -327,7 +330,7 @@ def get_time_str(time_in: float) -> str:
     return time.strftime(f"%-M:%S.{milliseconds}", time.gmtime(time_in))
 
 
-async def send_highscore_message(session: Session, guild: nextcord.Guild, group: CategoryGroup) -> nextcord.Message:
+async def send_highscore_message(session: Session, guild: nextcord.Guild, group: CategoryGroup) -> None:
     """
     Function takes care of checking if a message exists for a group.
 
@@ -337,23 +340,34 @@ async def send_highscore_message(session: Session, guild: nextcord.Guild, group:
         session (Session): The sqlalchemy session being used for this function call.
         guild (nextcord.Guild): the nextcord.Guild object requesting this message.
         group (CategoryGroup): group to post to the message.
-
-    Returns:
-        nextcord.Message: Message object that was posted with group contents.
     """
     highscore_string = format_highscore_message(session, group)
-    channel = guild.get_channel(group.channel_id)
+    if (channel := guild.get_channel(group.channel_id)) is None:
+        agon_logger.error("Channel id %s in guild %s does not exist.", group.channel_id, guild.id)
+        return
+
+    if not isinstance(channel, nextcord.TextChannel | nextcord.Thread):
+        agon_logger.error(
+            "Channel id %s in guild %s is does not correspond to a TextChannel or Thread.", channel.id, channel.guild.id
+        )
+        return
 
     if group.message_id is None:
         # message doesn't exist.
         message: nextcord.Message = await channel.send(highscore_string)
-        group.MessageId = message.id
+        group.message_id = message.id
         session.commit()
     else:
-        message: nextcord.Message = await channel.fetch_message(group.message_id)
+        try:
-        await message.edit(content=highscore_string)
+            message: nextcord.Message = await channel.fetch_message(group.message_id)
+            await message.edit(content=highscore_string)
+        except nextcord.NotFound:
+            # Message was deleted on discord's side.
+            message: nextcord.Message = await channel.send(highscore_string)
+            group.message_id = message.id
+            session.commit()
 
-    return message
+    return
 
 
 async def submit_score(
@@ -390,7 +404,7 @@ async def submit_score(
         existing_score = session.scalar(stmt)
 
         if existing_score:
-            existing_score.Score = score_f
+            existing_score.score = score_f
         else:
             score_obj = Score(username=username, score=score_f, category_id=category_id)
             session.add(score_obj)

database/database_test.py

@@ -1,40 +0,0 @@
-import os
-
-from dotenv import load_dotenv
-from sqlmodel import Session, SQLModel, create_engine, select
-
-from models import CategoryGroup, Guild
-
-load_dotenv()
-
-SQL_DB = os.getenv("SQL_DB", "")
-SQL_HOST = os.getenv("SQL_HOST", "")
-SQL_PASS = os.getenv("SQL_PASS", "")
-SQL_USER = os.getenv("SQL_USER", "")
-
-url = "sqlite:///database.db"
-# url = f"mysql+pymysql://{SQL_USER}:{SQL_PASS}@{SQL_HOST}/{SQL_DB}"
-engine = create_engine(url)
-SQLModel.metadata.create_all(engine)
-
-with Session(engine) as session:
-    guild = Guild(id=1, name="test guild")
-    session.add(guild)
-    group1 = CategoryGroup(name="group1", channel_id=1, guild_id=1, message_id=1)
-    group2 = CategoryGroup(name="group2", channel_id=2, guild_id=1, message_id=2)
-    session.add(group1)
-    session.add(group2)
-    session.commit()
-
-    # anotherone = Guild(id=2, name="test guild 2", submission_channel=1, verification_channel=2)
-    # session.add(anotherone)
-    # group1 = CategoryGroup(name="group1", channel_id=1, guild_id=2, message_id=1)
-    # group2 = CategoryGroup(name="group2", channel_id=2, guild_id=2, message_id=2)
-    # session.add(group1)
-    # session.add(group2)
-    # session.commit()
-
-    stmt = select(Guild).where(Guild.name == "Dakiny")
-    guild = session.scalar(stmt)
-
-    print(guild.category_groups)

database/pyproject.toml

@@ -1,7 +0,0 @@
-[tool.ruff]
-# Extend the `pyproject.toml` file in the parent directory...
-extend = "../pyproject.toml"
-
-[tool.ruff.lint]
-# ignore implicit-namespace-package in this directory.
-ignore = ["INP001"]

highscores_database.sql

@@ -1,56 +0,0 @@
-CREATE DATABASE highscores;
-use highscores;
-
-CREATE TABLE Guilds(
-   GuildId bigint unsigned not null unique,
-   GuildName varchar(95) not null,
-   SubmissionChannel bigint unsigned, -- deprecated, is not used anymore.
-   VerificationChannel bigint unsigned,
-   Active boolean DEFAULT true,
-   PRIMARY KEY (GuildId)
-);
-
-CREATE TABLE CategoryGroups(
-   GroupId int unsigned not null unique AUTO_INCREMENT,
-   GroupName varchar(50) not null,
-   ChannelId bigint unsigned,
-   GuildId bigint unsigned not null,
-   MessageId bigint unsigned,
-   PadLength smallint not null DEFAULT 26,
-   UsernameLength smallint DEFAULT 12,
-   CONSTRAINT UniqueGuildCategoryGroup UNIQUE (GuildId, GroupName),
-   FOREIGN KEY (GuildId) REFERENCES Guilds(GuildId) ON DELETE CASCADE,
-   PRIMARY KEY (GroupId)
-);
-
-CREATE TABLE Categories(
-   CategoryId int unsigned not null unique AUTO_INCREMENT,
-   CategoryName varchar(30) not null,
-   GroupId int unsigned not null,
-   Size smallint not null DEFAULT 3,
-   IsAscending boolean not null DEFAULT true,
-   IsTimeRecord boolean not null DEFAULT false,
-   IsValidated boolean not null DEFAULT true,
-   CONSTRAINT UniqueCategoryInGroup UNIQUE (GroupId, CategoryName),
-   FOREIGN KEY (GroupId) REFERENCES CategoryGroups(GroupId) ON DELETE CASCADE,
-   PRIMARY Key (CategoryId)
-);
-
-CREATE TABLE Scores(
-   UserName varchar(30) not null,
-   Score float not null, -- Maybe should have time and int scores?? timestamp type?
-   CategoryId int unsigned not null,
-   FOREIGN KEY (CategoryId) REFERENCES Categories(CategoryId) ON DELETE CASCADE,
-   PRIMARY KEY (CategoryId, UserName)
-);
-
-CREATE TABLE Submissions(
-   CategoryId int unsigned not null,
-   GroupId int unsigned not null,
-   GuildId bigint unsigned not null,
-   MessageId bigint unsigned not null,
-   Score varchar(30) not null, -- Score is stored as a string until converted during submission
-   UserId bigint unsigned not null,
-   UserName varchar(30) not null,
-   PRIMARY KEY (CategoryId, UserName) -- one submission a category per user.
-);

utilities/__init__.py

@@ -1 +0,0 @@
-"""Package of utility functions and environment configuration variables."""