add docs, remove some stuff

Author: No767

bot/cogs/__init__.py

@@ -14,3 +14,5 @@ def __str__(self) -> str:
 
 EXTENSIONS = [module.name for module in iter_modules(__path__, f"{__package__}.")]
 VERSION: VersionInfo = VersionInfo(major=0, minor=3, micro=1, releaselevel="final")
+
+del Literal, NamedTuple

bot/cogs/admin.py

@@ -1,24 +1,16 @@
 from __future__ import annotations
 
-import asyncio
-import importlib
-import os
-import re
-import subprocess  # nosec # We already know this is dangerous, but it's needed
-import sys
 from typing import TYPE_CHECKING, Literal, Optional
 
 import discord
 from discord.ext import commands
 from discord.ext.commands import Greedy
 
 if TYPE_CHECKING:
-    from utils import RoboContext
+    from utils.context import RoboContext
 
     from bot.rodhaj import Rodhaj
 
-GIT_PULL_REGEX = re.compile(r"\s+(?P<filename>.*)\b\s+\|\s+[\d]")
-
 
 class Admin(commands.Cog, command_attrs=dict(hidden=True)):
     """Administrative commands for Rodhaj"""
@@ -33,78 +25,6 @@ def display_emoji(self) -> discord.PartialEmoji:
     async def cog_check(self, ctx: RoboContext) -> bool:
         return await self.bot.is_owner(ctx.author)
 
-    async def reload_or_load_extension(self, module: str) -> None:
-        try:
-            await self.bot.reload_extension(module)
-        except commands.ExtensionNotLoaded:
-            await self.bot.load_extension(module)
-
-    def find_modules_from_git(self, output: str) -> list[tuple[int, str]]:
-        files = GIT_PULL_REGEX.findall(output)
-        ret: list[tuple[int, str]] = []
-        for file in files:
-            root, ext = os.path.splitext(file)
-            if ext != ".py" or root.endswith("__init__"):
-                continue
-
-            true_root = ".".join(root.split("/")[1:])
-
-            if true_root.startswith("cogs") or true_root.startswith("libs"):
-                # A subdirectory within these are a part of the codebase
-
-                ret.append((true_root.count(".") + 1, true_root))
-
-        # For reload order, the submodules should be reloaded first
-        ret.sort(reverse=True)
-        return ret
-
-    async def run_process(self, command: str) -> list[str]:
-        process = await asyncio.create_subprocess_shell(
-            command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
-        )
-        result = await process.communicate()
-
-        return [output.decode() for output in result]
-
-    def tick(self, opt: Optional[bool], label: Optional[str] = None) -> str:
-        lookup = {
-            True: "\U00002705",
-            False: "\U0000274c",
-            None: "\U000023e9",
-        }
-        emoji = lookup.get(opt, "\U0000274c")
-        if label is not None:
-            return f"{emoji}: {label}"
-        return emoji
-
-    def format_results(self, statuses: list) -> str:
-        desc = "\U00002705 - Successful reload | \U0000274c - Failed reload | \U000023e9 - Skipped\n\n"
-        status = "\n".join(f"- {status}: `{module}`" for status, module in statuses)
-        desc += status
-        return desc
-
-    async def reload_exts(self, module: str) -> list[tuple[str, str]]:
-        statuses = []
-        try:
-            await self.reload_or_load_extension(module)
-            statuses.append((self.tick(True), module))
-        except commands.ExtensionError:
-            statuses.append((self.tick(False), module))
-
-        return statuses
-
-    def reload_lib_modules(self, module: str) -> list[tuple[str, str]]:
-        statuses = []
-        try:
-            actual_module = sys.modules[module]
-            importlib.reload(actual_module)
-            statuses.append((self.tick(True), module))
-        except KeyError:
-            statuses.append((self.tick(None), module))
-        except Exception:
-            statuses.append((self.tick(False), module))
-        return statuses
-
     # Umbra's sync command
     # To learn more about it, see the link below (and ?tag ass on the dpy server):
     # https://about.abstractumbra.dev/discord.py/2023/01/29/sync-command-example.html
@@ -147,43 +67,6 @@ async def sync(
 
         await ctx.send(f"Synced the tree to {ret}/{len(guilds)}.")
 
-    @commands.command(name="reload-all", hidden=True)
-    async def reload(self, ctx: RoboContext) -> None:
-        """Reloads all cogs and utils"""
-        async with ctx.typing():
-            stdout, _ = await self.run_process("git pull")
-
-        # progress and stuff is redirected to stderr in git pull
-        # however, things like "fast forward" and files
-        # along with the text "already up-to-date" are in stdout
-
-        if stdout.startswith("Already up-to-date."):
-            await ctx.send(stdout)
-            return
-
-        modules = self.find_modules_from_git(stdout)
-
-        mods_text = "\n".join(
-            f"{index}. `{module}`" for index, (_, module) in enumerate(modules, start=1)
-        )
-        prompt_text = (
-            f"This will update the following modules, are you sure?\n{mods_text}"
-        )
-
-        confirm = await ctx.prompt(prompt_text)
-        if not confirm:
-            await ctx.send("Aborting....")
-            return
-
-        statuses = []
-        for is_submodule, module in modules:
-            if is_submodule:
-                statuses = self.reload_lib_modules(module)
-            else:
-                statuses = await self.reload_exts(module)
-
-        await ctx.send(self.format_results(statuses))
-
 
 async def setup(bot: Rodhaj) -> None:
     await bot.add_cog(Admin(bot))

bot/cogs/config.py

@@ -10,7 +10,6 @@
     Any,
     AsyncIterator,
     Literal,
-    NamedTuple,
     Optional,
     Union,
     overload,
@@ -49,12 +48,30 @@
 )
 OPTIONS_FILE = Path(__file__).parents[1] / "locale" / "options.json"
 
+### Enums
 
-class BlocklistTicket(NamedTuple):
+
+class ConfigType(Enum):
+    TOGGLE = 0
+    SET = 1
+
+
+### Structs
+
+
+class BlocklistTicket(msgspec.Struct, frozen=True):
     cog: Tickets
     thread: discord.Thread
 
 
+class ConfigHelpEntry(msgspec.Struct, frozen=True):
+    key: str
+    default: str
+    description: str
+    examples: list[str]
+    notes: list[str]
+
+
 class BlocklistEntity(msgspec.Struct, frozen=True):
     bot: Rodhaj
     guild_id: int
@@ -66,63 +83,6 @@ def format(self) -> str:
         return f"{name} (ID: {self.entity_id})"
 
 
-class BlocklistPages(SimplePages):
-    def __init__(self, entries: list[BlocklistEntity], *, ctx: GuildContext):
-        converted = [entry.format() for entry in entries]
-        super().__init__(converted, ctx=ctx)
-
-
-class Blocklist:
-    def __init__(self, bot: Rodhaj):
-        self.bot = bot
-        self._blocklist: dict[int, BlocklistEntity] = {}
-
-    async def _load(self, connection: Union[asyncpg.Connection, asyncpg.Pool]):
-        query = """
-        SELECT guild_id, entity_id
-        FROM blocklist;
-        """
-        rows = await connection.fetch(query)
-        return {
-            row["entity_id"]: BlocklistEntity(bot=self.bot, **dict(row)) for row in rows
-        }
-
-    async def load(self, connection: Optional[asyncpg.Connection] = None):
-        try:
-            self._blocklist = await self._load(connection or self.bot.pool)
-        except Exception:
-            self._blocklist = {}
-
-    @overload
-    def get(self, key: int) -> Optional[BlocklistEntity]: ...
-
-    @overload
-    def get(self, key: int) -> BlocklistEntity: ...
-
-    def get(self, key: int, default: Any = None) -> Optional[BlocklistEntity]:
-        return self._blocklist.get(key, default)
-
-    def __contains__(self, item: int) -> bool:
-        return item in self._blocklist
-
-    def __getitem__(self, item: int) -> BlocklistEntity:
-        return self._blocklist[item]
-
-    def __len__(self) -> int:
-        return len(self._blocklist)
-
-    def all(self) -> dict[int, BlocklistEntity]:
-        return self._blocklist
-
-    def replace(self, blocklist: dict[int, BlocklistEntity]) -> None:
-        self._blocklist = blocklist
-
-
-class ConfigType(Enum):
-    TOGGLE = 0
-    SET = 1
-
-
 # Msgspec Structs are usually extremely fast compared to slotted classes
 class GuildConfig(msgspec.Struct):
     bot: Rodhaj
@@ -196,6 +156,55 @@ def ticket_channel(self) -> Optional[discord.ForumChannel]:
         return guild and guild.get_channel(self.ticket_channel_id)  # type: ignore
 
 
+### Core classes
+
+
+class Blocklist:
+    def __init__(self, bot: Rodhaj):
+        self.bot = bot
+        self._blocklist: dict[int, BlocklistEntity] = {}
+
+    async def _load(self, connection: Union[asyncpg.Connection, asyncpg.Pool]):
+        query = """
+        SELECT guild_id, entity_id
+        FROM blocklist;
+        """
+        rows = await connection.fetch(query)
+        return {
+            row["entity_id"]: BlocklistEntity(bot=self.bot, **dict(row)) for row in rows
+        }
+
+    async def load(self, connection: Optional[asyncpg.Connection] = None):
+        try:
+            self._blocklist = await self._load(connection or self.bot.pool)
+        except Exception:
+            self._blocklist = {}
+
+    @overload
+    def get(self, key: int) -> Optional[BlocklistEntity]: ...
+
+    @overload
+    def get(self, key: int) -> BlocklistEntity: ...
+
+    def get(self, key: int, default: Any = None) -> Optional[BlocklistEntity]:
+        return self._blocklist.get(key, default)
+
+    def __contains__(self, item: int) -> bool:
+        return item in self._blocklist
+
+    def __getitem__(self, item: int) -> BlocklistEntity:
+        return self._blocklist[item]
+
+    def __len__(self) -> int:
+        return len(self._blocklist)
+
+    def all(self) -> dict[int, BlocklistEntity]:
+        return self._blocklist
+
+    def replace(self, blocklist: dict[int, BlocklistEntity]) -> None:
+        self._blocklist = blocklist
+
+
 class GuildWebhookDispatcher:
     def __init__(self, bot: Rodhaj, guild_id: int):
         self.bot = bot
@@ -234,12 +243,7 @@ async def get_config(self) -> Optional[GuildWebhook]:
         return GuildWebhook(bot=self.bot, **dict(rows))
 
 
-class ConfigHelpEntry(msgspec.Struct, frozen=True):
-    key: str
-    default: str
-    description: str
-    examples: list[str]
-    notes: list[str]
+### Embeds
 
 
 class ConfigEntryEmbed(Embed):
@@ -256,6 +260,15 @@ def __init__(self, entry: ConfigHelpEntry, **kwargs):
         )
 
 
+### UI elements (Sources and Pages)
+
+
+class BlocklistPages(SimplePages):
+    def __init__(self, entries: list[BlocklistEntity], *, ctx: GuildContext):
+        converted = [entry.format() for entry in entries]
+        super().__init__(converted, ctx=ctx)
+
+
 class ConfigHelpPageSource(menus.ListPageSource):
     async def format_page(self, menu: ConfigHelpPages, entry: ConfigHelpEntry):
         embed = ConfigEntryEmbed(entry=entry)
@@ -309,6 +322,9 @@ def __init__(
         self.embed = discord.Embed(colour=discord.Colour.from_rgb(200, 168, 255))
 
 
+### Flags and Converters
+
+
 class ConfigOptionFlags(commands.FlagConverter):
     active: Optional[bool] = commands.flag(
         name="active",
@@ -377,6 +393,9 @@ async def convert(self, ctx: GuildContext, argument: str):
         return argument
 
 
+### Command cog
+
+
 class Config(commands.Cog):
     """Config and setup commands for Rodhaj"""
 
@@ -511,6 +530,7 @@ def clean_prefixes(self, prefixes: Union[str, list[str]]) -> str:
         return ", ".join(f"`{prefix}`" for prefix in prefixes[2:])
 
     ### Misc Utilities
+
     async def _handle_error(
         self, error: commands.CommandError, *, ctx: GuildContext
     ) -> None:
@@ -520,6 +540,8 @@ async def _handle_error(
         elif isinstance(error, commands.BadArgument):
             await ctx.send(str(error))
 
+    ### Commands
+
     @is_manager()
     @bot_check_permissions(manage_channels=True, manage_webhooks=True)
     @commands.guild_only()