Cleanup

rocketbot/cogs/autokickcog.py

@@ -1,7 +1,8 @@
 from datetime import datetime, timedelta
 
 from discord import Guild, Member, Status
-from discord.ext import commands, tasks
+from discord.ext import tasks
+from discord.ext.commands import Cog
 from discord.ext.tasks import Loop
 
 from config import CONFIG
@@ -66,7 +67,7 @@ class AutoKickCog(BaseCog, name='Auto Kick'):
 		timer: Loop = self.status_check_timer
 		timer.start()
 
-	@commands.Cog.listener()
+	@Cog.listener()
 	async def on_member_join(self, member: Member) -> None:
 		"""Event handler"""
 		guild: Guild = member.guild

rocketbot/cogs/basecog.py

@@ -2,7 +2,7 @@
 Base cog class and helper classes.
 """
 from datetime import datetime, timedelta, timezone
-from typing import Optional, ForwardRef
+from typing import Optional
 
 import discord
 from discord import Guild, Interaction, Member, Message, RawReactionActionEvent, TextChannel
@@ -18,7 +18,7 @@ from rocketbot.collections import AgeBoundDict
 from rocketbot.storage import Storage
 from rocketbot.utils import bot_log, dump_stacktrace
 
-Rocketbot = ForwardRef('rocketbot.bot.Rocketbot')
+Rocketbot = 'rocketbot.bot.Rocketbot'
 
 class WarningContext:
 	def __init__(self, member: Member, warn_time: datetime):
@@ -176,7 +176,7 @@ class BaseCog(Cog):
 			BaseCog.STATE_KEY_RECENT_WARNINGS)
 		if recent_warns is None:
 			recent_warns = AgeBoundDict(timedelta(seconds=CONFIG['squelch_warning_seconds']),
-				lambda i, context : context.last_warned)
+				lambda i, context0 : context0.last_warned)
 			Storage.set_state_value(member.guild, BaseCog.STATE_KEY_RECENT_WARNINGS, recent_warns)
 		context: WarningContext = recent_warns.get(member.id)
 		if context is None:

rocketbot/cogs/configcog.py

@@ -31,18 +31,16 @@ class ConfigCog(BaseCog, name='Configuration'):
 		default_permissions=Permissions(Permissions.manage_messages.flag)
 	)
 
-	@config.command(
-		description='Sets the mod warning channel',
-		extras={
-			'long_description': 'Run this command in the channel where bot messages ' +
-				'intended for server moderators should be sent. Other bot ' +
-				'messages may still be posted in the channel a command was ' +
-				'invoked in. If no output channel is set, mod-related messages ' +
-				'will not be posted!',
-		}
-	)
-	async def setwarningchannel(self, interaction: Interaction) -> None:
-		"""Command handler"""
+	@config.command()
+	async def set_warning_channel(self, interaction: Interaction) -> None:
+		"""
+		Sets mod warnings to post in the current channel.
+
+		Run this command in the channel where bot messages intended for server
+		moderators should be sent. Other bot messages may still be posted in
+		the channel a command was invoked in. If no output channel is set,
+		mod-related messages will not be posted!
+		"""
 		guild: Guild = interaction.guild
 		channel: TextChannel = interaction.channel
 		Storage.set_config_value(guild, ConfigKey.WARNING_CHANNEL_ID,
@@ -52,15 +50,14 @@ class ConfigCog(BaseCog, name='Configuration'):
 			ephemeral=True,
 		)
 
-	@config.command(
-		description='Shows the mod warning channel',
-		extras={
-			'long_description': 'Shows the configured channel (if any) where mod ' + \
-				'warnings will be posted.',
-		},
-	)
-	async def getwarningchannel(self, interaction: Interaction) -> None:
-		"""Command handler"""
+	@config.command()
+	async def get_warning_channel(self, interaction: Interaction) -> None:
+		"""
+		Shows the mod warning channel, if any.
+
+		Shows the configured channel (if any) where mod warnings and other bot
+		output will be posted.
+		"""
 		guild: Guild = interaction.guild
 		channel_id = Storage.get_config_value(guild, ConfigKey.WARNING_CHANNEL_ID)
 		if channel_id is None:
@@ -75,20 +72,23 @@ class ConfigCog(BaseCog, name='Configuration'):
 				ephemeral=True,
 			)
 
-	@config.command(
-		description='Sets a user/role to mention in warning messages',
-		extras={
-			'usage': '<@user|@role>',
-			'long_description': 'Configures an role or other prefix to include at the ' +
-				'beginning of warning messages. If the intent is to get the ' +
-				'attention of certain users, be sure to specify a properly ' +
-				'formed @ tag, not just the name of the user/role.',
-		},
-	)
-	async def setwarningmention(self,
+	@config.command()
+	async def set_warning_mention(self,
 			interaction: Interaction,
 			mention: Optional[Union[User, Role]] = None) -> None:
-		"""Command handler"""
+		"""
+		Sets a user/role to mention in warning messages.
+
+		Configures an role or other prefix to include at the beginning of
+		warning messages. The intent is to get the attention of certain users
+		in case action is needed. Leave blank to tag no one.
+
+		Parameters
+		----------
+		interaction: Interaction
+		mention: User or Role
+			The user or role to mention in warning messages
+		"""
 		guild: Guild = interaction.guild
 		Storage.set_config_value(guild, ConfigKey.WARNING_MENTION, mention.mention if mention else None)
 		if mention is None:
@@ -98,19 +98,15 @@ class ConfigCog(BaseCog, name='Configuration'):
 			)
 		else:
 			await interaction.response.send_message(
-				f'{CONFIG["success_emoji"]} Warning messages will now tag {mention}.',
+				f'{CONFIG["success_emoji"]} Warning messages will now tag {mention.mention}.',
 				ephemeral=True,
 			)
 
-	@config.command(
-		description='Shows the user/role to mention in warning messages',
-		extras={
-			'long_description': 'Shows the text, if any, that will be prefixed on any ' +
-				'warning messages.',
-		},
-	)
-	async def getwarningmention(self, interaction: Interaction) -> None:
-		"""Command handler"""
+	@config.command()
+	async def get_warning_mention(self, interaction: Interaction) -> None:
+		"""
+		Shows the configured user/role to mention in warning messages.
+		"""
 		guild: Guild = interaction.guild
 		mention: str = Storage.get_config_value(guild, ConfigKey.WARNING_MENTION)
 		if mention is None: