Additionally show exact Discord message format rule violations in 'showcase' extension

Author: Mega-JC

pcbot/exts/helpforums_pre/cogs.py

@@ -761,14 +761,11 @@ async def on_raw_member_remove(self, payload: discord.RawMemberRemoveEvent):
                 forum_channel.threads,
                 [thr async for thr in forum_channel.archived_threads(limit=20)],
             ):
-                if (
-                    help_thread.owner_id == payload.user.id
-                    and not (
-                        help_thread.locked
-                        or any(
-                            tag.name.lower() in ("solved", "invalid")
-                            for tag in help_thread.applied_tags
-                        )
+                if help_thread.owner_id == payload.user.id and not (
+                    help_thread.locked
+                    or any(
+                        tag.name.lower() in ("solved", "invalid")
+                        for tag in help_thread.applied_tags
                     )
                 ):
                     snakecore.utils.hold_task(

pcbot/exts/showcase/cogs.py

@@ -372,7 +372,7 @@ async def delete_bad_message_with_thread(
     def showcase_message_validity_check(
         self,
         message: discord.Message,
-    ) -> tuple[bool, str | None]:
+    ) -> tuple[bool, str | None, str | None]:
         """Checks if a showcase message has the right format.
 
         Returns
@@ -404,7 +404,9 @@ async def on_thread_create(self, thread: discord.Thread):
         except discord.NotFound:
             return
 
-        is_valid, reason = self.showcase_message_validity_check(message)
+        is_valid, general_reason, exact_reason = self.showcase_message_validity_check(
+            message
+        )
 
         if not is_valid:
             deletion_datetime = datetime.datetime.now(
@@ -414,7 +416,8 @@ async def on_thread_create(self, thread: discord.Thread):
             try:
                 warn_msg = await message.reply(
                     "### Invalid showcase message\n\n"
-                    f"{reason}\n\n"
+                    f"Failed on rule '{exact_reason}'.\n\n"
+                    f"{general_reason}\n\n"
                     " If no changes are made, your message (and its thread/post) will be "
                     f"deleted {snakecore.utils.create_markdown_timestamp(deletion_datetime, 'R')}."
                 )
@@ -531,7 +534,9 @@ async def on_message(self, message: discord.Message):
         ):
             return
 
-        is_valid, reason = self.showcase_message_validity_check(message)
+        is_valid, general_reason, exact_reason = self.showcase_message_validity_check(
+            message
+        )
 
         if is_valid:
             await self.prompt_author_for_feedback_thread(message)
@@ -543,7 +548,8 @@ async def on_message(self, message: discord.Message):
             try:
                 warn_msg = await message.reply(
                     "### Invalid showcase message\n\n"
-                    f"{reason}\n\n"
+                    f"Failed on rule '{exact_reason}'.\n\n"
+                    f"{general_reason}\n\n"
                     " If no changes are made, your message (and its thread/post) will be "
                     f"deleted {snakecore.utils.create_markdown_timestamp(deletion_datetime, 'R')}."
                 )
@@ -579,7 +585,9 @@ async def on_message_edit(self, old: discord.Message, new: discord.Message):
         ):
             return
 
-        is_valid, reason = self.showcase_message_validity_check(new)
+        is_valid, general_reason, exact_reason = self.showcase_message_validity_check(
+            new
+        )
 
         if not is_valid:
             if new.id in self.entry_message_deletion_dict:
@@ -602,7 +610,8 @@ async def on_message_edit(self, old: discord.Message, new: discord.Message):
                             content=(
                                 "### Invalid showcase message\n\n"
                                 "Your edited showcase message is invalid.\n\n"
-                                f"{reason}\n\n"
+                                f"Failed on rule '{exact_reason}'.\n\n"
+                                f"{general_reason}\n\n"
                                 " If no changes are made, your post will be "
                                 f"deleted "
                                 + snakecore.utils.create_markdown_timestamp(

pcbot/exts/showcase/utils/rules.py

@@ -13,31 +13,31 @@ def validate(
         enforce_type: EnforceType,
         message: discord.Message,
         arg: Literal["any", "only", "none"] = "any",
-    ) -> tuple[Literal[False], str] | tuple[Literal[True], None]:
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         """Validate a message for the presence of content according to the specified arguments."""
 
         has_content = bool(message.content)
         only_content = not has_content and not (message.attachments or message.embeds)
 
         if enforce_type == "always" and arg == "only" and not only_content:
-            return (False, "Message must always contain only text content")
+            return (False, "Message must always contain only text content", None)
 
         if enforce_type == "always" and arg == "any" and not has_content:
-            return (False, "Message must always contain text content")
+            return (False, "Message must always contain text content", None)
 
         if enforce_type == "always" and arg == "none" and has_content:
-            return (False, "Message must always contain no text content")
+            return (False, "Message must always contain no text content", None)
 
         if enforce_type == "never" and arg == "only" and only_content:
-            return (False, "Message must never contain only text content")
+            return (False, "Message must never contain only text content", None)
 
         if enforce_type == "never" and arg == "any" and has_content:
-            return (False, "Message must never contain text content")
+            return (False, "Message must never contain text content", None)
 
         if enforce_type == "never" and arg == "none" and not has_content:
-            return (False, "Message must never contain no text content")
+            return (False, "Message must never contain no text content", None)
 
-        return (True, None)
+        return (True, None, None)
 
     @staticmethod
     def validate_arg(arg: Literal["any", "only", "none"]) -> str | None:
@@ -53,7 +53,7 @@ def validate(
         enforce_type: EnforceType,
         message: discord.Message,
         arg: tuple[int, int],
-    ):
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         """Validate a message for the presence of text content within the specified length range."""
 
         if not isinstance(arg, tuple) or len(arg) != 2:
@@ -77,15 +77,17 @@ def validate(
             return (
                 False,
                 f"Message must always contain text content within {min_length}-{max_length} characters",
+                None,
             )
 
         if enforce_type == "never" and (min_length <= content_length <= max_length):
             return (
                 False,
                 f"Message must never contain text content within {min_length}-{max_length} characters",
+                None,
             )
 
-        return (True, None)
+        return (True, None, None)
 
     @staticmethod
     def validate_arg(arg: tuple[int | None, int | None]) -> str | None:
@@ -113,7 +115,7 @@ def validate(
         enforce_type: EnforceType,
         message: discord.Message,
         arg: Literal["any", "only", "none"],
-    ) -> tuple[Literal[False], str] | tuple[Literal[True], None]:
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         """Validate a message for the presence of URLs according to the specified arguments."""
 
         search_obj = tuple(re.finditer(URL_PATTERN, message.content))
@@ -125,24 +127,24 @@ def validate(
         no_urls = not any_urls
 
         if enforce_type == "always" and arg == "only" and not only_urls:
-            return (False, "Message must always contain only URLs")
+            return (False, "Message must always contain only URLs", None)
 
         if enforce_type == "always" and arg == "any" and not any_urls:
-            return (False, "Message must always contain at least one URL")
+            return (False, "Message must always contain at least one URL", None)
 
         if enforce_type == "always" and arg == "none" and not no_urls:
-            return (False, "Message must always contain no URLs")
+            return (False, "Message must always contain no URLs", None)
 
         if enforce_type == "never" and arg == "only" and only_urls:
-            return (False, "Message must never contain only URLs")
+            return (False, "Message must never contain only URLs", None)
 
         if enforce_type == "never" and arg == "any" and any_urls:
-            return (False, "Message must never contain at least one URL")
+            return (False, "Message must never contain at least one URL", None)
 
         if enforce_type == "never" and arg == "none" and no_urls:
-            return (False, "Message must never contain no URLs")
+            return (False, "Message must never contain no URLs", None)
 
-        return (True, None)
+        return (True, None, None)
 
 
 # Rule for validating VCS URLs
@@ -154,7 +156,7 @@ def validate(
         enforce_type: EnforceType,
         message: discord.Message,
         arg: Literal["any", "all", "none"] = "any",
-    ) -> tuple[Literal[False], str] | tuple[Literal[True], None]:
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         """Validate a message for the presence of VCS URLs according to the specified arguments."""
 
         search_obj = tuple(re.finditer(URL_PATTERN, message.content or ""))
@@ -164,24 +166,32 @@ def validate(
         all_vcs_urls = not any(not is_vcs_url(link) for link in links)
 
         if enforce_type == "always" and arg == "all" and not all_vcs_urls:
-            return (False, "Message must always contain only valid VCS URLs")
+            return (False, "Message must always contain only valid VCS URLs", None)
 
         if enforce_type == "always" and arg == "any" and not any_vcs_urls:
-            return (False, "Message must always contain at least one valid VCS URL")
+            return (
+                False,
+                "Message must always contain at least one valid VCS URL",
+                None,
+            )
 
         if enforce_type == "always" and arg == "none" and not no_vcs_urls:
-            return (False, "Message must always contain no valid VCS URLs")
+            return (False, "Message must always contain no valid VCS URLs", None)
 
         if enforce_type == "never" and arg == "all" and all_vcs_urls:
-            return (False, "Message must never contain only valid VCS URLs")
+            return (False, "Message must never contain only valid VCS URLs", None)
 
         if enforce_type == "never" and arg == "any" and any_vcs_urls:
-            return (False, "Message must never contain at least one valid VCS URL")
+            return (
+                False,
+                "Message must never contain at least one valid VCS URL",
+                None,
+            )
 
         if enforce_type == "never" and arg == "none" and no_vcs_urls:
-            return (False, "Message must never contain no valid VCS URLs")
+            return (False, "Message must never contain no valid VCS URLs", None)
 
-        return (True, None)
+        return (True, None, None)
 
     @staticmethod
     def validate_arg(arg: Literal["any", "all", "none"]) -> str | None:
@@ -197,32 +207,32 @@ def validate(
         enforce_type: EnforceType,
         message: discord.Message,
         arg: Literal["any", "only", "none"],
-    ):
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         """Validate a message for the presence of attachments according to the specified arguments."""
 
         any_attachments = bool(message.attachments)
         only_attachments = any_attachments and not (message.content or message.embeds)
         no_attachments = not any_attachments
 
         if enforce_type == "always" and arg == "only" and not only_attachments:
-            return (False, "Message must always contain only attachments")
+            return (False, "Message must always contain only attachments", None)
 
         if enforce_type == "always" and arg == "any" and not any_attachments:
-            return (False, "Message must always contain at least one attachment")
+            return (False, "Message must always contain at least one attachment", None)
 
         if enforce_type == "always" and arg == "none" and not no_attachments:
-            return (False, "Message must always contain no attachments")
+            return (False, "Message must always contain no attachments", None)
 
         if enforce_type == "never" and arg == "only" and only_attachments:
-            return (False, "Message must never contain only attachments")
+            return (False, "Message must never contain only attachments", None)
 
         if enforce_type == "never" and arg == "any" and any_attachments:
-            return (False, "Message must never contain at least one attachment")
+            return (False, "Message must never contain at least one attachment", None)
 
         if enforce_type == "never" and arg == "none" and no_attachments:
-            return (False, "Message must never contain no attachments")
+            return (False, "Message must never contain no attachments", None)
 
-        return (True, None)
+        return (True, None, None)
 
 
 class EmbedsRule(DiscordMessageRule, name="embeds"):
@@ -233,32 +243,32 @@ def validate(
         enforce_type: EnforceType,
         message: discord.Message,
         arg: Literal["any", "only", "none"],
-    ) -> tuple[Literal[False], str] | tuple[Literal[True], None]:
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         """Validate a message for the presence of embeds according to the specified arguments."""
 
         any_embeds = bool(message.embeds)
         only_embeds = any_embeds and not (message.content or message.attachments)
         no_embeds = not any_embeds
 
         if enforce_type == "always" and arg == "only" and not only_embeds:
-            return (False, "Message must always contain only embeds")
+            return (False, "Message must always contain only embeds", None)
 
         if enforce_type == "always" and arg == "any" and not any_embeds:
-            return (False, "Message must always contain at least one embed")
+            return (False, "Message must always contain at least one embed", None)
 
         if enforce_type == "always" and arg == "none" and not no_embeds:
-            return (False, "Message must always contain no embeds")
+            return (False, "Message must always contain no embeds", None)
 
         if enforce_type == "never" and arg == "only" and only_embeds:
-            return (False, "Message must never contain only embeds")
+            return (False, "Message must never contain only embeds", None)
 
         if enforce_type == "never" and arg == "any" and any_embeds:
-            return (False, "Message must never contain at least one embed")
+            return (False, "Message must never contain at least one embed", None)
 
         if enforce_type == "never" and arg == "none" and no_embeds:
-            return (False, "Message must never contain no embeds")
+            return (False, "Message must never contain no embeds", None)
 
-        return (True, None)
+        return (True, None, None)
 
 
 RULE_MAPPING: dict[str, type[DiscordMessageRule]] = {

pcbot/exts/showcase/utils/utils.py

@@ -59,7 +59,7 @@ def __init_subclass__(cls, name: str) -> None:
     @abstractmethod
     def validate(
         enforce_type: EnforceType, message: discord.Message, arg: Any = None
-    ) -> tuple[Literal[False], str] | tuple[Literal[True], None]:
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         ...
 
     @staticmethod
@@ -72,5 +72,5 @@ class AsyncDiscordMessageRule(DiscordMessageRule, name="AsyncDiscordMessageRule"
     @abstractmethod
     async def validate(
         enforce_type: EnforceType, message: discord.Message, arg: Any = None
-    ) -> tuple[Literal[False], str] | tuple[Literal[True], None]:
+    ) -> tuple[Literal[False], str, str | None] | tuple[Literal[True], None, None]:
         ...