cleanup code

pydvpl_bot.py

@@ -7,17 +7,26 @@ from discord.ext.commands import DefaultHelpCommand
 from pydvpl.dvpl import compress_dvpl, decompress_dvpl
 
 
-# Define the authorized user ID
+# DEFINES ------------------------------------------------------ START
+
+
 AUTHORIZED_USER_ID = os.getenv('AUTHORIZED_ID')
 
-# Define your Discord bot token here
 TOKEN = os.getenv('DISCORD_TOKEN')
 
-LOG_CHANNEL_ID = 1220420254962942084
+LOG_CHANNEL_ID = os.getenv('CHANNEL_ID')
+
+UPDATE_INTERVAL = 60
 
 activity_start_time = 0
 
 
+# DEFINES ------------------------------------------------------ END
+
+
+# HELPER ------------------------------------------------------ START
+
+
 class PyDVPLHelpCommand(DefaultHelpCommand):
     def get_command_signature(self, command):
         return f"{self.context.prefix}{command.qualified_name} {command.signature}"
@@ -35,12 +44,7 @@ class PyDVPLHelpCommand(DefaultHelpCommand):
         await self.get_destination().send(embed=embed)
 
 
-# Set up bot command prefix
-bot_intents = discord.Intents.all()
-
-
-# Initialize the bot with intents
-bot = commands.Bot(command_prefix=">>", intents=bot_intents, help_command=PyDVPLHelpCommand())
+# FUNCTION ------------------------------------------------------ SPLIT
 
 
 # Ensure the existence of folders
@@ -51,6 +55,26 @@ def ensure_folders():
         os.makedirs("received_to_decompress")
 
 
+# HELPER ------------------------------------------------------ END
+
+
+# CORE_PREFIX ------------------------------------------------------ START
+
+
+# Set up bot command prefix
+bot_intents = discord.Intents.all()
+
+
+# Initialize the bot with intents
+bot = commands.Bot(command_prefix=">>", intents=bot_intents, help_command=PyDVPLHelpCommand())
+
+
+# CORE_PREFIX ------------------------------------------------------ END
+
+
+# CORE ------------------------------------------------------ START
+
+
 @bot.event
 async def on_ready():
     global activity_start_time
@@ -67,6 +91,57 @@ async def on_ready():
 
     ensure_folders()
 
+
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
+@bot.event
+async def on_disconnect():
+    print('Bot disconnected from Discord. Attempting to reconnect...')
+    await bot.change_presence(status=discord.Status.invisible)
+
+
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
+@bot.event
+async def on_command(ctx):
+    # Log command usage
+    log_channel = bot.get_channel(LOG_CHANNEL_ID)
+    if log_channel:
+        if ctx.guild:
+            log_message = f"Command `{ctx.command}` used by `{ctx.author} ({ctx.author.id})` in `{ctx.guild} ({ctx.guild.id})`"
+        else:
+            log_message = f"Command `{ctx.command}` used by `{ctx.author} ({ctx.author.id})` in {ctx.me.mention}'s `DM`"
+        await log_channel.send(log_message)
+
+
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
+@bot.event
+async def on_command_error(ctx, error):
+    if isinstance(error, commands.CommandNotFound):
+        await ctx.send("Sorry, I couldn't find that command. Use `>>help` to see the list of available commands.")
+        await ctx.message.delete()
+    else:
+        print(f'An error occurred: {error}')
+
+
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
+@bot.event
+async def on_error(event, *args):
+    print(f'An error occurred during event {event}: {args[0]}')
+    await bot.change_presence(status=discord.Status.dnd)
+
+
+# CORE ------------------------------------------------------ END
+
+
+
+# ACTIVITY ------------------------------------------------------ START
     
 
 
@@ -83,8 +158,7 @@ async def update_playing_time_activity():
     await bot.change_presence(activity=discord.Game(name=playing_time_activity))
 
 
-# Define the interval for updating the playing time (in seconds)
-UPDATE_INTERVAL = 60  # Update every minute
+# FUNCTION ------------------------------------------------------ SPLIT
 
 
 @tasks.loop(seconds=UPDATE_INTERVAL)
@@ -92,6 +166,11 @@ async def update_playing_time():
     await update_playing_time_activity()
 
 
+# ACTIVITY ------------------------------------------------------ END
+
+
+# PYDVPL ------------------------------------------------------ START
+
 async def compress_file(file_path):
     try:
         with open(file_path, "rb") as f:
@@ -106,6 +185,9 @@ async def compress_file(file_path):
         return None
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 async def decompress_file(file_path):
     try:
         with open(file_path, "rb") as f:
@@ -120,6 +202,9 @@ async def decompress_file(file_path):
         return None
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Compresses attached files.")
 async def compress(ctx):
     attachments = ctx.message.attachments
@@ -152,6 +237,9 @@ async def compress(ctx):
     await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Decompresses attached files.")
 async def decompress(ctx):
     attachments = ctx.message.attachments
@@ -183,6 +271,12 @@ async def decompress(ctx):
     await ctx.message.delete()
 
 
+# PYDVPL ------------------------------------------------------ END
+
+
+# UTILITY USER_CMD ------------------------------------------------------ START
+
+
 @bot.command(help="Pings to check bot's latency")
 async def ping(ctx):
     latency = round(bot.latency * 1000)  # latency in milliseconds
@@ -191,6 +285,40 @@ async def ping(ctx):
     await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
+@bot.command(help="Generates an invite link for the bot and sends it to your DM.")
+async def invite(ctx):
+    permissions = discord.Permissions(
+        read_messages=True,
+        send_messages=True,
+        embed_links=True,  # Permission for embedded activities
+        attach_files=True,
+        read_message_history=True,
+        mention_everyone=True,
+        add_reactions=True,
+        manage_guild=True,
+    )
+
+    client_id = bot.user.id
+    invite_link = discord.utils.oauth_url(client_id, permissions=permissions, scopes=['bot'])
+
+    # Send the invite link to the user's DM
+    try:
+        await ctx.author.send(f"Invite link for PyDVPL: {invite_link}")
+        await ctx.send(f"Sent the invite link to your DM. {ctx.author.mention}")
+    except discord.Forbidden:
+        await ctx.send(f"Failed to send the invite link to your DM. {ctx.author.mention} Please make sure your DMs are open.")
+    await ctx.message.delete()
+
+
+# UTILITY USER_CMD ------------------------------------------------------ END
+
+
+# UTILITY ADMIN_CMD ------------------------------------------------------ START
+
+
 @bot.command(help="Cleans all files in received_to_compress and received_to_decompress directories.")
 async def clean(ctx):
     # Check if the user invoking the command is authorized
@@ -227,6 +355,9 @@ async def clean(ctx):
         await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Set bot's presence to online")
 async def online(ctx):
     if str(ctx.author.id) != AUTHORIZED_USER_ID:
@@ -238,6 +369,9 @@ async def online(ctx):
     await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Set bot's presence to Do Not Disturb")
 async def dnd(ctx):
     if str(ctx.author.id) != AUTHORIZED_USER_ID:
@@ -249,6 +383,9 @@ async def dnd(ctx):
     await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Set bot's presence to offline")
 async def offline(ctx):
     if str(ctx.author.id) != AUTHORIZED_USER_ID:
@@ -259,6 +396,10 @@ async def offline(ctx):
     await ctx.send("Bot's presence set to offline.")
     await ctx.message.delete()
 
+
+# FUNCTION ------------------------------------------------------ SPLIT
+    
+
 @bot.command(help="Set bot's activity")
 async def activity(ctx, activity_type, *, activity_text=None):
     if str(ctx.author.id) != AUTHORIZED_USER_ID:
@@ -287,6 +428,9 @@ async def activity(ctx, activity_type, *, activity_text=None):
     await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Send messages to specific channels or users")
 async def say(ctx, destination_type, *args):
     if str(ctx.author.id) != AUTHORIZED_USER_ID:
@@ -374,6 +518,9 @@ async def say(ctx, destination_type, *args):
         await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Show how long the bot has been playing the current game.")
 async def uptime(ctx):
     global activity_start_time
@@ -395,6 +542,9 @@ async def uptime(ctx):
     await ctx.message.delete()
 
 
+# FUNCTION ------------------------------------------------------ SPLIT
+
+
 @bot.command(help="Show statistics about bot's health and connection.")
 async def stats(ctx):
 
@@ -433,62 +583,14 @@ async def stats(ctx):
     await ctx.message.delete()
 
 
-@bot.command(help="Generates an invite link for the bot and sends it to your DM.")
-async def invite(ctx):
-    permissions = discord.Permissions(
-        read_messages=True,
-        send_messages=True,
-        embed_links=True,  # Permission for embedded activities
-        attach_files=True,
-        read_message_history=True,
-        mention_everyone=True,
-        add_reactions=True,
-        manage_guild=True,
-    )
-
-    client_id = bot.user.id
-    invite_link = discord.utils.oauth_url(client_id, permissions=permissions, scopes=['bot'])
-
-    # Send the invite link to the user's DM
-    try:
-        await ctx.author.send(f"Invite link for PyDVPL: {invite_link}")
-        await ctx.send(f"Sent the invite link to your DM. {ctx.author.mention}")
-    except discord.Forbidden:
-        await ctx.send(f"Failed to send the invite link to your DM. {ctx.author.mention} Please make sure your DMs are open.")
-    await ctx.message.delete()
-
-
-@bot.event
-async def on_disconnect():
-    print('Bot disconnected from Discord. Attempting to reconnect...')
-    await bot.change_presence(status=discord.Status.invisible)
-
+# UTILITY ADMIN_CMD ------------------------------------------------------ END
 
-@bot.event
-async def on_command(ctx):
-    # Log command usage
-    log_channel = bot.get_channel(LOG_CHANNEL_ID)
-    if log_channel:
-        if ctx.guild:
-            log_message = f"Command `{ctx.command}` used by `{ctx.author} ({ctx.author.id})` in `{ctx.guild} ({ctx.guild.id})`"
-        else:
-            log_message = f"Command `{ctx.command}` used by `{ctx.author} ({ctx.author.id})` in {ctx.me.mention}'s `DM`"
-        await log_channel.send(log_message)
 
 
-@bot.event
-async def on_command_error(ctx, error):
-    if isinstance(error, commands.CommandNotFound):
-        await ctx.send("Sorry, I couldn't find that command. Use `>>help` to see the list of available commands.")
-        await ctx.message.delete()
-    else:
-        print(f'An error occurred: {error}')
+# RUN PYDVPL ------------------------------------------------------ START
 
 
-@bot.event
-async def on_error(event, *args):
-    print(f'An error occurred during event {event}: {args[0]}')
-    await bot.change_presence(status=discord.Status.dnd)
+bot.run(TOKEN)
 
 
-bot.run(TOKEN)
+# RUN PYDVPL ------------------------------------------------------ END