imcompiling/agon
1
0
Fork 0
Code Issues 17 Pull Requests 4 Actions Packages Activity

Remove all references to table. Remove a dead function. Fix some code smells.

Browse Source
This commit is contained in:
imcompiling
2025-02-20 17:23:57 -05:00
parent 36dad683d8
commit 327126307d
7 changed files with 29 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cogs/commands/create.py
+1 -1
View File
@@ -147,7 +147,7 @@ class CreateCog(commands.Cog, name="Create Cog"):
@category.on_autocomplete("group_id")
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str) -> None:
"""
Collects list of table names and compares to input table name for autocomplete assistance.
Collects list of group names and compares to input group name for autocomplete assistance.
Args:
interaction (nextcord.Interaction): Interaction with command.
cogs/commands/delete.py
+10 -10
View File
@@ -18,7 +18,7 @@ from utilities.utils import (
from .views.delete_confirm import DeleteConfirmView, create_delete_id
class DeleteCog(commands.Cog, name="Table Management"):
class DeleteCog(commands.Cog, name="Delete Cog"):
"""Class holds commands for deleting."""
def __init__(self) -> None:
@@ -32,7 +32,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
async def all(self, interaction: nextcord.Interaction) -> None:
"""Subcommand parent for deleting all of a thing. Never called."""
@all.subcommand(description="Clears highscores channel of all table messages. Does not change data.")
@all.subcommand(description="Clears highscores channel of all highscore messages. Does not change data.")
async def channel_messages(
self,
interaction: nextcord.Interaction,
@@ -69,16 +69,16 @@ class DeleteCog(commands.Cog, name="Table Management"):
for group in groups:
try:
table_message: nextcord.Message = await channel.fetch_message(group.MessageId)
await table_message.delete()
message: nextcord.Message = await channel.fetch_message(group.MessageId)
await message.delete()
except nextcord.NotFound:
# silently ignore that messages are not found. They got deleted already.
pass
await interaction.send("Table messages deleted.", ephemeral=True)
await interaction.send("Highscore messages deleted.", ephemeral=True)
@all.subcommand(
description="Removes all of a user's scores. Warning: data is destroyed, use with case.",
description="Removes all of a user's scores. Warning: data is destroyed, use with care.",
)
async def users(
self,
@@ -90,7 +90,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
"""
Searches all of guild's scores data for any score from the user and removes.
Updates table message is user was removed from that table.
Updates highscore message if user was removed from that Category Group.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command.
@@ -112,7 +112,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
for group in session.scalars(stmt):
await send_highscore_message(session, interaction.guild, group)
await interaction.send(f'User "{user_name}" was removed from all tables.', ephemeral=True)
await interaction.send(f'User "{user_name}" was removed from all Category Groups.', ephemeral=True)
@delete.subcommand(description="Delete a category from a group. Deletion is perminant.")
async def category(
@@ -225,7 +225,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
@group.on_autocomplete("group_id")
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str) -> None:
"""
Autocomplete function for table names.
Autocomplete function for group names.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command.
@@ -264,7 +264,7 @@ class DeleteCog(commands.Cog, name="Table Management"):
"""
await interaction.response.send_autocomplete(
autofill_users_in_group_category(
interaction.guild_id, int(group_id), category_id if category_id else 0, user_name
interaction.guild_id, int(group_id), int(category_id) if category_id else 0, user_name
)
)
cogs/commands/help.py
+1 -1
View File
@@ -27,7 +27,7 @@ class HelpCog(commands.Cog, name="Help commands."):
help_str: str = "Welcome to Agon! Three simple steps are needed to get started."
help_str += '1.) Set a channel to receive submission verifications with "/set verify_channel."\n'
help_str += "This channel is used to allow moderators to check if a submission is real/valid.\n\n"
help_str += '2.) Set up your highscore tables! Use "/create group" to first create a group message in the'
help_str += '2.) Set up your highscores! Use "/create group" to first create a group message in the'
help_str += 'channel you would like and then use "/create category" to create a category in that group message!'
help_str += "\n\n"
help_str += '3.) Users can then submit scores with the "/submit" command.'
cogs/commands/refresh.py
+13 -20
View File
@@ -14,13 +14,11 @@ from utilities.utils import autofill_groups, send_highscore_message
class RefreshCog(commands.Cog, name="Refresh Cog"):
"""
Class holds commands for refreshing.
"""
"""Class holds commands for refreshing."""
def __init__(self, bot: commands.Bot) -> None:
"""
Default constructor for RefreshCog class
Default constructor for RefreshCog class.
Args:
bot (commands.Bot): Bot object. Required to register submission button view.
@@ -28,19 +26,17 @@ class RefreshCog(commands.Cog, name="Refresh Cog"):
self._bot = bot
@nextcord.slash_command(default_member_permissions=nextcord.Permissions(administrator=True))
async def refresh(self, interaction: nextcord.Interaction):
"""
Parent slash command for refreshing things. Never called.
"""
async def refresh(self, interaction: nextcord.Interaction) -> None:
"""Parent slash command for refreshing things. Never called."""
@refresh.subcommand(description="Manually refresh a table. Use when changing settings or data manually changed.")
@refresh.subcommand(description="Manually refresh a group. Use when changing settings or data manually changed.")
async def group(
self,
interaction: nextcord.Interaction,
group_id: str = nextcord.SlashOption(name="group", description="Name of Group.", required=True),
) -> None:
"""
Refreshes a table given by user.
Refreshes a group given by user.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command.
@@ -57,22 +53,19 @@ class RefreshCog(commands.Cog, name="Refresh Cog"):
message: nextcord.Message = await send_highscore_message(session, interaction.guild, group)
await message.edit(view=SubmissionCreateButton(self._bot))
await interaction.response.send_message(f"Updated table {group.GroupName}!", ephemeral=True)
await interaction.response.send_message(f"Updated group {group.GroupName}!", ephemeral=True)
@refresh.subcommand()
async def all(self, interaction: nextcord.Interaction):
"""
Subcommand parent for refreshing all things. Never called.
"""
async def all(self, interaction: nextcord.Interaction) -> None:
"""Subcommand parent for refreshing all things. Never called."""
@all.subcommand(description="Triggers post/update of highscores to registered highscore channels.")
async def groups(self, interaction: nextcord.Interaction) -> None:
"""
A command which posts the highscore in the registered channel.
Sends warning if no channel has been registered.
Either creates new messages for each table if one doesn't exist
or edits the existing message.
Sends warning if no channel has been registered. Either creates new messages for each group if one doesn't
exist or edits the existing message.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command.
@@ -90,9 +83,9 @@ class RefreshCog(commands.Cog, name="Refresh Cog"):
await interaction.send(f"Posted all groups in {interaction.guild.name}'s highscores.", ephemeral=True)
@group.on_autocomplete("group_id")
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str):
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str) -> None:
"""
Collects list of table names and compares to input table name for autocomplete assistance.
Collects list of group names and compares to input group name for autocomplete assistance.
Args:
interaction (nextcord.Interaction): Interaction with command.
cogs/commands/submission.py
+1 -1
View File
@@ -208,7 +208,7 @@ class SubmissionCog(commands.Cog):
@submit.on_autocomplete("group_id")
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str) -> None:
"""
Autocomplete function for table names.
Autocomplete function for group names.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command.
cogs/commands/view.py
+3 -3
View File
@@ -87,9 +87,9 @@ class ViewCog(commands.Cog, name="View Command"):
await interaction.response.send_message(content=message_str)
@leaderboard.on_autocomplete("group_id")
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str):
async def group_autocomplete(self, interaction: nextcord.Interaction, group_id: str) -> None:
"""
Autocomplete function for table names.
Autocomplete function for group names.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command.
@@ -98,7 +98,7 @@ class ViewCog(commands.Cog, name="View Command"):
await interaction.response.send_autocomplete(autofill_groups(interaction.guild_id, group_id))
@leaderboard.on_autocomplete("category_id")
async def category_autocomplete(self, interaction: nextcord.Interaction, category_id: str, group_id: str):
async def category_autocomplete(self, interaction: nextcord.Interaction, category_id: str, group_id: str) -> None:
"""
Autocomplete function for category names.
utilities/utils.py
-29
View File
@@ -2,7 +2,6 @@
Contains various utlity functions for highscores bot
"""
import json
import time
import nextcord
@@ -400,31 +399,3 @@ async def submit_score(
group = session.scalar(stmt)
await send_highscore_message(session, interaction.guild, group)
def add_preset_configuration(guild_id: int, config_str: str) -> None:
"""
Adds an example configuration to a Guild. Uses guild id to know which guild and
config name to open a file in example_config.
Args:
guild_id (int): Guild id to add config to
config_str (str): Config name to add
"""
with Session(engine) as session:
with open(f"example_config/{config_str}.json", encoding="utf-8") as file:
config = json.load(file)
for group_name, categorys in config["tables"].items():
group_obj = CategoryGroup(GroupName=group_name, GuildId=guild_id)
session.add(group_obj)
for category_name in categorys:
cat_obj = Category(
CategoryName=category_name,
Size=config["table_size"],
IsTimeRecord=config["categories"][category_name]["is_time_record"],
IsAscending=config["categories"][category_name]["ascending"],
)
session.add(cat_obj)
session.commit()