Moving bot class to separate file, renaming entry script to main.py

README.md

@@ -14,7 +14,7 @@ In brief, the full setup process is:
 - create a Discord application in their developer portal
 - configure a `config.py`
 - install Python dependencies
-- run the `bot.py` script
+- run the `main.py` script
 - invite the bot to your server
 - do additional configuration for your guild using chat commands
 

docs/setup.md

@@ -83,7 +83,7 @@ Mac-specificness. Linux will be similar. Windows probably won't be as similar.
 2. Run the bot
     ```shell
     source .venv/bin/activate   # skip if you already just did it above
-    python bot.py
+    python main.py
     ```
 
 It will take a few seconds to connect and when you see output like this it means

main.py

@@ -0,0 +1,27 @@
+"""
+Rocketbot Discord bot. Relies on a configured config.py (copy config.sample.py
+for a template).
+
+Author: Ian Albert (@rocketsoup)
+Date: 2021-11-11
+"""
+import asyncio
+
+from config import CONFIG
+from rocketbot.bot import start_bot
+from rocketbot.utils import bot_log
+
+CURRENT_CONFIG_VERSION = 3
+if (CONFIG.get('__config_version') or 0) < CURRENT_CONFIG_VERSION:
+	# If you're getting this error, it means something changed in config.py's
+	# format. Consult config.sample.py and compare it to your own config.py.
+	# Rename/move any values as needed. When satisfied, update "__config_version"
+	# to the value in config.sample.py. ...I know, pretty janky migration process.
+	raise RuntimeError('config.py format may be outdated. Review ' +
+		'config.sample.py, update the "__config_version" field to ' +
+		f'{CURRENT_CONFIG_VERSION}, and try again.')
+
+try:
+	asyncio.run(start_bot())
+except KeyboardInterrupt:
+	bot_log(None, None, 'Stopping bot due to Ctrl+C key')

bot.py → rocketbot/bot.py

@@ -1,39 +1,12 @@
-"""
-Rocketbot Discord bot. Relies on a configured config.py (copy config.sample.py
-for a template).
-
-Author: Ian Albert (@rocketsoup)
-Date: 2021-11-11
-"""
-import asyncio
 import traceback
+from typing import Optional
 
 from discord import Intents
 from discord.ext import commands
 
 from config import CONFIG
-from rocketbot.cogs.autokickcog import AutoKickCog
-from rocketbot.cogs.configcog import ConfigCog
-from rocketbot.cogs.crosspostcog import CrossPostCog
-from rocketbot.cogs.generalcog import GeneralCog
-from rocketbot.cogs.joinagecog import JoinAgeCog
-from rocketbot.cogs.joinraidcog import JoinRaidCog
-from rocketbot.cogs.logcog import LoggingCog
-from rocketbot.cogs.patterncog import PatternCog
-from rocketbot.cogs.urlspamcog import URLSpamCog
-from rocketbot.cogs.usernamecog import UsernamePatternCog
 from rocketbot.utils import bot_log
 
-CURRENT_CONFIG_VERSION = 3
-if (CONFIG.get('__config_version') or 0) < CURRENT_CONFIG_VERSION:
-	# If you're getting this error, it means something changed in config.py's
-	# format. Consult config.sample.py and compare it to your own config.py.
-	# Rename/move any values as needed. When satisfied, update "__config_version"
-	# to the value in config.sample.py. ...I know, pretty janky migration process.
-	raise RuntimeError('config.py format may be outdated. Review ' +
-		'config.sample.py, update the "__config_version" field to ' +
-		f'{CURRENT_CONFIG_VERSION}, and try again.')
-
 class Rocketbot(commands.Bot):
 	"""
 	Bot subclass
@@ -41,8 +14,13 @@ class Rocketbot(commands.Bot):
 	def __init__(self, command_prefix, **kwargs):
 		super().__init__(command_prefix, **kwargs)
 
-	async def on_command_error(self, context: commands.Context, exception):
-		bot_log(None, None, 'Command error:\n' + '\n'.join(traceback.format_stack()))
+	async def on_command_error(self, context: commands.Context, exception: BaseException) -> None:
+		bot_log(None, None, f'Command error')
+		ex = exception
+		while ex is not None:
+			print(f'Caused by {ex}')
+			traceback.print_exception(type(ex), ex, ex.__traceback__)
+			ex = ex.__cause__ if ex.__cause__ != ex else None
 		if context.guild is None or \
 				context.message.channel is None or \
 				context.message.author.bot:
@@ -57,7 +35,6 @@ class Rocketbot(commands.Bot):
 				mention_author=False)
 			return
 		# Stack trace everything else
-		# traceback.print_exception(type(exception), exception, exception.__traceback__)
 
 	async def on_error(self, event_method, args=None, kwargs=None):
 		bot_log(None, None, 'Event caused error\n' + \
@@ -66,34 +43,50 @@ class Rocketbot(commands.Bot):
 			f'	event kwargs: {kwargs}' + \
 			traceback.format_exc())
 
-async def start_bot():
+# Current active bot instance
+rocketbot: Optional[Rocketbot] = None
+
+def __create_bot():
+	global rocketbot
+	if rocketbot is not None:
+		return
+	bot_log(None, None, 'Creating bot...')
 	intents = Intents.default()
 	intents.messages = True  # pylint: disable=assigning-non-slot
 	intents.message_content = True  # pylint: disable=assigning-non-slot
 	intents.members = True  # pylint: disable=assigning-non-slot
 	intents.presences = True
+	rocketbot = Rocketbot(command_prefix=CONFIG['command_prefix'], intents=intents)
+__create_bot()
+
+from rocketbot.cogs.autokickcog import AutoKickCog
+from rocketbot.cogs.configcog import ConfigCog
+from rocketbot.cogs.crosspostcog import CrossPostCog
+from rocketbot.cogs.generalcog import GeneralCog
+from rocketbot.cogs.joinagecog import JoinAgeCog
+from rocketbot.cogs.joinraidcog import JoinRaidCog
+from rocketbot.cogs.logcog import LoggingCog
+from rocketbot.cogs.patterncog import PatternCog
+from rocketbot.cogs.urlspamcog import URLSpamCog
+from rocketbot.cogs.usernamecog import UsernamePatternCog
+
+async def start_bot():
 	bot_log(None, None, 'Bot initializing...')
 	bot_log(None, None, f"Type {CONFIG['command_prefix']}help in Discord for available commands.")
-	bot = Rocketbot(command_prefix=CONFIG['command_prefix'], intents=intents)
 
 	# Core
-	await bot.add_cog(GeneralCog(bot))
-	await bot.add_cog(ConfigCog(bot))
+	await rocketbot.add_cog(GeneralCog(rocketbot))
+	await rocketbot.add_cog(ConfigCog(rocketbot))
 
 	# Optional
-	await bot.add_cog(AutoKickCog(bot))
-	await bot.add_cog(CrossPostCog(bot))
-	await bot.add_cog(JoinAgeCog(bot))
-	await bot.add_cog(JoinRaidCog(bot))
-	await bot.add_cog(LoggingCog(bot))
-	await bot.add_cog(PatternCog(bot))
-	await bot.add_cog(URLSpamCog(bot))
-	await bot.add_cog(UsernamePatternCog(bot))
+	await rocketbot.add_cog(AutoKickCog(rocketbot))
+	await rocketbot.add_cog(CrossPostCog(rocketbot))
+	await rocketbot.add_cog(JoinAgeCog(rocketbot))
+	await rocketbot.add_cog(JoinRaidCog(rocketbot))
+	await rocketbot.add_cog(LoggingCog(rocketbot))
+	await rocketbot.add_cog(PatternCog(rocketbot))
+	await rocketbot.add_cog(URLSpamCog(rocketbot))
+	await rocketbot.add_cog(UsernamePatternCog(rocketbot))
 
-	await bot.start(CONFIG['client_token'], reconnect=True)
+	await rocketbot.start(CONFIG['client_token'], reconnect=True)
 	print('\nBot aborted')
-
-try:
-	asyncio.run(start_bot())
-except KeyboardInterrupt:
-	bot_log(None, None, 'Stopping bot due to Ctrl+C key')

rocketbot/cogs/generalcog.py

@@ -2,6 +2,7 @@
 Cog for handling most ungrouped commands and basic behaviors.
 """
 import re
+import traceback
 from datetime import datetime, timedelta, timezone
 from typing import Optional
 
@@ -55,6 +56,10 @@ class GeneralCog(BaseCog, name='General'):
 		if self.is_first_ready:
 			print('----------------------------------------------------------')
 			self.is_first_ready = False
+		try:
+			await self.bot.tree.sync()
+		except Exception as e:
+			traceback.print_exception(type(e), e, e.__traceback__)
 
 	@commands.Cog.listener()
 	async def on_resumed(self):