Fixed it all

AbstractUmbra · AbstractUmbra · commit e070195bbcdb · 2023-06-04T15:28:26.000+01:00
diff --git a/Dockerfile b/Dockerfile
@@ -47,4 +47,4 @@ COPY poetry.lock pyproject.toml ./
 RUN poetry install --without=dev
 
 COPY . /app/
-ENTRYPOINT poetry run python bot.py
+ENTRYPOINT poetry run python -O bot.py
diff --git a/README.md b/README.md
@@ -18,9 +18,11 @@ This will allow for public evals. To disable the functionality entirely, ensure
 
 In the future we'll provide a systemd unit, pm2 config and maybe a Dockerfile for running the bot, but for now you can use your ideal terminal and:-
 ```shell
-python launcher.py
+python -O launcher.py
 ```
 
+(we run with `python -O` because we use `assert` for type checking purposes).
+
 ### Docker
 
 We also provide both `Dockerfile` and `docker-compose.yml` files for running the bot in Docker.
diff --git a/config.template.toml b/config.template.toml
@@ -13,7 +13,7 @@ dsn = 'postgres://pythonistabot:pythonistabot@database:5432/pythonistabot' # ass
 # 20 = INFO
 # 10 = DEBUG
 [LOGGING]
-webhook_url = ""
+webhook_url = ""  # optional
 level = 20
 
 [SNEKBOX] # optional
diff --git a/core/__init__.py b/core/__init__.py
@@ -23,8 +23,8 @@
 __version__ = "0.0.1a"
 
 from . import utils as utils
-from .bot import Bot
+from .bot import Bot as Bot
+from .context import *
 from .converters import *
 from .core import *
-from .context import *
 from .errors import *
diff --git a/core/bot.py b/core/bot.py
@@ -32,16 +32,17 @@
 import discord
 from discord.ext import commands
 
-from .core import CONFIG
 from .context import Context
+from .core import CONFIG
 from .utils import LogHandler
 
 
 if TYPE_CHECKING:
-    import mystbin
-    from queue import Queue
+    from asyncio import Queue
     from logging import LogRecord
 
+    import mystbin
+
 
 class Bot(commands.Bot):
     session: aiohttp.ClientSession
diff --git a/core/converters.py b/core/converters.py
@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2021 - Present PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -82,4 +82,4 @@ async def convert(self, ctx: Context, argument: str) -> Codeblock:  # type: igno
         if not code and not language:
             code[:] = previous_characters
 
-        return Codeblock("".join(language), "".join(code[len(language): -backticks]))
+        return Codeblock("".join(language), "".join(code[len(language) : -backticks]))
diff --git a/core/errors.py b/core/errors.py
@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2021 - Present PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/core/utils/__init__.py b/core/utils/__init__.py
@@ -21,4 +21,4 @@
 SOFTWARE.
 """
 from .formatters import *
-from .logging import LogHandler
+from .logging import LogHandler as LogHandler
diff --git a/core/utils/paginator.py b/core/utils/paginator.py
@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2021 - Present PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -20,15 +20,23 @@
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 """
+from __future__ import annotations
+
 import asyncio
+from abc import abstractmethod
 from typing import TYPE_CHECKING, Any
 
 import discord
 from discord import ui  # shortcut because I'm lazy
-from discord.ext.commands import CommandError, Paginator as _Paginator
+from discord.ext.commands import CommandError, Paginator as _Paginator  # type: ignore # why does this need a stub file?
 from discord.utils import MISSING
+
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
 from core import Context
-from typing_extensions import Self
+
 
 __all__ = ("CannotPaginate", "Pager", "KVPager", "TextPager")
 
@@ -86,9 +94,10 @@ def __init__(
         if stop:
             self.reaction_emojis.append(("\N{BLACK SQUARE FOR STOP}", self.stop_pages))  # type: ignore
 
-        if ctx.guild is not None:
+        if ctx.guild:
             self.permissions = self.channel.permissions_for(ctx.guild.me)
         else:
+            assert isinstance(self.channel, discord.abc.PrivateChannel)
             self.permissions = self.channel.permissions_for(ctx.me)
 
         if not self.permissions.embed_links:
@@ -97,7 +106,7 @@ def __init__(
         if not self.permissions.send_messages:
             raise CannotPaginate("Bot cannot send messages.")
 
-    def setup_buttons(self):
+    def setup_buttons(self) -> None:
         self.clear_items()
         for emoji, button in self.reaction_emojis:
             btn = ui.Button[Self](emoji=emoji)
@@ -108,14 +117,15 @@ def get_page(self, page: int) -> list[Any]:
         base = (page - 1) * self.per_page
         return self.entries[base : base + self.per_page]
 
+    @abstractmethod
     def get_content(self, entry: Any, page: int, *, first: bool = False) -> str:
-        return None
+        raise NotImplementedError
 
-    def get_embed(self, entries: list[Any], page: int, *, first: bool = False):
+    def get_embed(self, entries: list[Any], page: int, *, first: bool = False) -> discord.Embed:
         self.prepare_embed(entries, page, first=first)
         return self.embed
 
-    def prepare_embed(self, entries: list[Any], page: int, *, first: bool = False):
+    def prepare_embed(self, entries: list[Any], page: int, *, first: bool = False) -> None:
         p: list[Any] = []
         for index, entry in enumerate(entries, 1 + ((page - 1) * self.per_page)):
             if self.nocount:
@@ -162,28 +172,28 @@ async def checked_show_page(self, page: int):
         if page != 0 and page <= self.maximum_pages:
             await self.show_page(page)
 
-    async def first_page(self, inter: discord.Interaction):
+    async def first_page(self, inter: discord.Interaction) -> None:
         await inter.response.defer()
         await self.show_page(1)
 
-    async def last_page(self, inter: discord.Interaction):
+    async def last_page(self, inter: discord.Interaction) -> None:
         await inter.response.defer()
         await self.show_page(self.maximum_pages)
 
-    async def next_page(self, inter: discord.Interaction):
+    async def next_page(self, inter: discord.Interaction) -> None:
         await inter.response.defer()
         await self.checked_show_page(self.current_page + 1)
 
-    async def previous_page(self, inter: discord.Interaction):
+    async def previous_page(self, inter: discord.Interaction) -> None:
         await inter.response.defer()
         await self.checked_show_page(self.current_page - 1)
 
-    async def show_current_page(self, inter: discord.Interaction):
+    async def show_current_page(self, inter: discord.Interaction) -> None:
         await inter.response.defer()
         if self.paginating:
             await self.show_page(self.current_page)
 
-    async def numbered_page(self, inter: discord.Interaction):
+    async def numbered_page(self, inter: discord.Interaction) -> None:
         await inter.response.defer()
         to_delete = [await self.channel.send("What page do you want to go to?")]
 
@@ -205,8 +215,8 @@ def message_check(m: discord.Message) -> bool:
                 await asyncio.sleep(5)
 
         try:
-            await self.channel.delete_messages(to_delete)
-        except Exception:
+            await self.channel.delete_messages(to_delete)  # type: ignore # we handle the attribute error or http since exception handling is free
+        except (AttributeError, discord.HTTPException):
             pass
 
     async def stop_pages(self, interaction: discord.Interaction | None = None):
@@ -302,7 +312,7 @@ def get_page(self, page: int) -> Any:
         return self.entries[page - 1]
 
     def get_embed(self, entries: list[str], page: int, *, first: bool = False) -> discord.Embed:
-        return None # type: ignore
+        return None  # type: ignore
 
     def get_content(self, entry: str, page: int, *, first: bool = False) -> str:
         if self.maximum_pages > 1:
diff --git a/launcher.py b/launcher.py
@@ -21,7 +21,6 @@
 SOFTWARE.
 """
 import asyncio
-from typing import TYPE_CHECKING
 
 import aiohttp
 import asyncpg
@@ -36,7 +35,6 @@ async def main() -> None:
     async with core.Bot() as bot, aiohttp.ClientSession() as session, asyncpg.create_pool(
         dsn=core.CONFIG["DATABASE"]["dsn"]
     ) as pool, LogHandler(bot=bot) as handler:
-
         bot.logging_queue = asyncio.Queue()
         bot.session = session
         bot.pool = pool
@@ -60,4 +58,4 @@ async def main() -> None:
 try:
     asyncio.run(main())
 except KeyboardInterrupt:
-    print('Fix this later, but you killed bot with KeyboardInterrupt...')
+    print("Fix this later, but you killed bot with KeyboardInterrupt...")
diff --git a/modules/eval.py b/modules/eval.py
@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2021 - Present PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -27,6 +27,7 @@
 from discord.ext import commands
 
 import core
+from core.errors import InvalidEval
 from core.utils import formatters
 
 
@@ -45,7 +46,6 @@ def __init__(self, bot: core.Bot, endpoint_url: str) -> None:
 
     async def perform_eval(self, code: core.Codeblock) -> str:
         async with self.bot.session.post(self.eval_endpoint, json={"input": code.content[1]}) as eval_response:
-
             if eval_response.status != 200:
                 raise InvalidEval(eval_response.status, "There was an issue running this eval command.")
 
@@ -57,10 +57,7 @@ async def perform_eval(self, code: core.Codeblock) -> str:
     @commands.max_concurrency(1, per=commands.BucketType.user, wait=False)
     @commands.cooldown(rate=1, per=10.0, type=commands.BucketType.user)
     async def eval(
-            self,
-            ctx: core.Context,
-            *,
-            code: core.Codeblock = commands.param(converter=core.CodeblockConverter)
+        self, ctx: core.Context, *, code: core.Codeblock = commands.param(converter=core.CodeblockConverter)
     ) -> None:
         """Evaluates your code in the form of a Discord message.
 
@@ -102,7 +99,6 @@ async def eval_error_handler(self, ctx: core.Context, error: commands.CommandErr
 
 
 async def setup(bot: core.Bot) -> None:
-
     if key := core.CONFIG.get("SNEKBOX"):
         await bot.add_cog(Evaluation(bot, key["url"]))
 
diff --git a/modules/help.py b/modules/help.py
@@ -1,6 +1,6 @@
 """MIT License
 
-Copyright (c) 2021 - Present PythonistaGuild
+Copyright (c) 2021-Present PythonistaGuild
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -22,11 +22,18 @@
 """
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 import discord
 from discord.ext import commands
 
 import core
 from constants import Channels
+from core.context import Context
+
+
+if TYPE_CHECKING:
+    from discord.ext.commands._types import Check  # type: ignore # why does this need a stub?
 
 
 FORUM_BLURB = f"""
@@ -43,6 +50,23 @@
 """.strip()
 
 
+def is_forum_thread() -> Check[Context]:
+    def predicate(ctx: Context) -> bool:
+        channel = ctx.channel
+        if not channel.guild:
+            return False
+
+        if not isinstance(channel, discord.Thread):
+            return False
+
+        if channel.parent_id != Channels.HELP_FORUM:
+            return False
+
+        return True
+
+    return commands.check(predicate)
+
+
 class Help(commands.Cog):
     """Commands relating to the help channels/forum of Pythonista."""
 
@@ -62,16 +86,16 @@ async def forum_post_created(self, thread: discord.Thread) -> None:
 
         await thread.send(FORUM_BLURB)
 
+    @is_forum_thread()
     @commands.command("solved", brief="Closes a forum post", short_doc="Closes a forum post in the help channels")
-    async def solved(self, ctx: core.Context) -> None:
+    async def solved(self, ctx: core.GuildContext) -> None:
         """
         Marks a forum post as solved.
         This will archive the post, lock it, and add the solved tag.
         You must be a moderator or the post OP to solve a post.
         """
-        if not ctx.guild or not isinstance(ctx.channel, discord.Thread) or ctx.channel.parent_id != Channels.HELP_FORUM:
-            await ctx.reply("This doesn't seem to be the help forum...")
-            return
+        assert isinstance(ctx.channel, discord.Thread)  # guarded by the check
+        assert isinstance(ctx.channel.parent, discord.ForumChannel)  # guarded by the check
 
         if not ctx.author_is_mod() or ctx.author != ctx.channel.owner:
             await ctx.send("You can only mark your own posts as solved")
@@ -84,14 +108,20 @@ async def solved(self, ctx: core.Context) -> None:
         except discord.HTTPException:
             pass
 
+        tag = ctx.channel.parent.get_tag(1006769269201195059)
+        if not tag:
+            return
+
         await ctx.channel.edit(
             locked=True,
             archived=True,
-            applied_tags=ctx.channel.applied_tags + [ctx.channel.parent.get_tag(1006769269201195059)],
-            reason=f"Marked as solved by {ctx.author}"
-        )  # type: ignore
+            applied_tags=ctx.channel.applied_tags + [tag],
+            reason=f"Marked as solved by {ctx.author}",
+        )
+
+        channel = ctx.guild.get_channel(Channels.FORUM_LOGS)
+        assert isinstance(channel, discord.TextChannel)  # we know the ID.
 
-        channel: discord.TextChannel = ctx.guild.get_channel(Channels.FORUM_LOGS)  # type: ignore
         if not channel:
             return
 
diff --git a/modules/logging.py b/modules/logging.py
diff --git a/modules/manuals.py b/modules/manuals.py
diff --git a/modules/moderation.py b/modules/moderation.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/types_/config.py b/types_/config.py
