refactor: use custom event and container for message events

Author: onerandomusername

monty/events.py

@@ -0,0 +1,51 @@
+# from pydantic import dataclasses
+import dataclasses
+import enum
+import functools
+
+import disnake
+
+from monty.utils.code import prepare_input
+from monty.utils.markdown import remove_codeblocks
+from monty.utils.messages import extract_urls
+
+
+class MontyEvent(enum.Enum):
+    monty_message_processed = "monty_message_processed"
+
+
+@dataclasses.dataclass(frozen=True)
+class MessageContext:
+    """A context for a message event."""
+
+    content: str
+
+    # Lazily initialize attributes
+    @functools.cached_property
+    def code(self) -> str | None:
+        """Return the code blocks found in the message."""
+        return prepare_input(self.content, require_fenced=True)
+
+    @functools.cached_property
+    def text(self) -> str:
+        """Return the message content with code blocks removed."""
+        return remove_codeblocks(self.content)
+
+    @functools.cached_property
+    def urls(self) -> list[str]:
+        """Return the URLs found in the message."""
+        return list(extract_urls(self.text))
+
+    @classmethod
+    def from_message_inter(
+        cls, inter: disnake.MessageInteraction | disnake.MessageCommandInteraction, /
+    ) -> "MessageContext":
+        """Create a MessageContext from an interaction."""
+        if isinstance(inter, disnake.MessageCommandInteraction):
+            return cls(inter.target.content)
+        return cls(inter.message.content)
+
+    @classmethod
+    def from_message(cls, message: disnake.Message) -> "MessageContext":
+        """Create a MessageContext from a message."""
+        return cls(content=message.content)

monty/exts/core/events.py

@@ -0,0 +1,39 @@
+import disnake
+from disnake.ext import commands
+
+from monty.bot import Monty
+from monty.events import MessageContext, MontyEvent
+from monty.log import get_logger
+from monty.metadata import ExtMetadata
+
+
+EXT_METADATA = ExtMetadata(core=True)
+
+
+logger = get_logger(__name__)
+
+
+class Events(commands.Cog):
+    """Global checks for monty."""
+
+    def __init__(self, bot: Monty) -> None:
+        self.bot = bot
+
+    @commands.Cog.listener(disnake.Event.message)
+    async def on_message(self, message: disnake.Message) -> None:
+        """Re-dispatch message listener events for on_message commands.
+
+        There are multiple listeners that listen for urls and code content
+        so we pre-process that information here before dispatching.
+        """
+        # Only care about messages from users.
+        if message.author.bot:
+            return
+
+        context = MessageContext.from_message(message)
+        self.bot.dispatch(MontyEvent.monty_message_processed.value, message, context)
+
+
+def setup(bot: Monty) -> None:
+    """Add the events cog the bot."""
+    bot.add_cog(Events(bot))

monty/exts/info/codesnippets.py

@@ -2,7 +2,7 @@
 import re
 import textwrap
 from datetime import timedelta
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, overload
 from urllib.parse import quote_plus
 from urllib.parse import unquote as urlunquote
 
@@ -14,6 +14,7 @@
 from disnake.ext import commands
 
 from monty.bot import Monty
+from monty.events import MessageContext, MontyEvent
 from monty.log import get_logger
 from monty.utils import scheduling
 from monty.utils.helpers import EXPAND_BUTTON_PREFIX, block_url_traversal, decode_github_link
@@ -301,11 +302,26 @@ def _snippet_to_codeblock(
         # Returns an empty codeblock if the snippet is empty
         return f"{ret}```\n```"
 
-    async def _parse_snippets(self, content: str) -> str:
+    @overload
+    async def _parse_snippets(self, *, content: str) -> str: ...
+    @overload
+    async def _parse_snippets(self, *, context: MessageContext) -> str: ...
+
+    async def _parse_snippets(self, *, content: str | None = None, context: MessageContext | None = None) -> str:
         """Parse message content and return a string with a code block for each URL found."""
-        all_snippets = []
+        if context and content:
+            msg = "Provide either content or context, not both."
+            raise ValueError(msg)
+
+        if context:
+            content = "\n".join(context.urls)
+        elif content:
+            content = remove_codeblocks(content)
+        else:
+            msg = "Either content or context must be provided."
+            raise ValueError(msg)
 
-        content = remove_codeblocks(content)
+        all_snippets: list[tuple[int, str]] = []
 
         for pattern, handler in self.pattern_handlers:
             for match in pattern.finditer(content):
@@ -335,12 +351,9 @@ async def _parse_snippets(self, content: str) -> str:
         # Sorts the list of snippets by their match index and joins them into a single message
         return "\n".join(m[1] for m in sorted(all_snippets))
 
-    @commands.Cog.listener()
-    async def on_message(self, message: disnake.Message) -> None:
+    @commands.Cog.listener(MontyEvent.monty_message_processed.value)
+    async def on_message(self, message: disnake.Message, context: MessageContext) -> None:
         """Checks if the message has a snippet link, removes the embed, then sends the snippet contents."""
-        if message.author.bot:
-            return
-
         if not message.guild:
             return
 
@@ -354,7 +367,7 @@ async def on_message(self, message: disnake.Message) -> None:
         if not my_perms.send_messages:
             return
 
-        message_to_send = await self._parse_snippets(message.content)
+        message_to_send = await self._parse_snippets(content=context.text)
         destination = message.channel
 
         if 0 < len(message_to_send) <= 2000 and message_to_send.count("\n") <= 27:
@@ -380,7 +393,7 @@ async def send_expanded_links(self, inter: disnake.MessageInteraction) -> None:
 
         custom_id = inter.data.custom_id[len(EXPAND_BUTTON_PREFIX) :]
         link = decode_github_link(custom_id)
-        snippet = await self._parse_snippets(link)
+        snippet = await self._parse_snippets(content=link)
 
         def disable_button() -> disnake.ui.View:
             view = disnake.ui.View.from_message(inter.message)

monty/utils/code.py

@@ -45,6 +45,9 @@ def prepare_input(code: str, *, require_fenced: bool = False) -> str | None:
         if len(blocks) > 1:
             code = "\n".join(block.group("code") for block in blocks)
             info = "several code blocks"
+        elif len(match) > 1:
+            code = "\n".join(block.group("code") for block in match)
+            info = "several code blocks"
         else:
             match = match[0] if len(blocks) == 0 else blocks[0]
             code, block, lang, delim = match.group("code", "block", "lang", "delim")

monty/utils/markdown.py

@@ -17,7 +17,7 @@
 
 
 CODE_BLOCK_RE = re.compile(
-    r"(?P<delim>`{1,2})([^\n]+)(?P=delim)|```(.+?)```",
+    r"```(.+?)```|(?P<delim>`{1,2})([^\n]+?)(?P=delim)",
     re.DOTALL | re.MULTILINE,
 )