Automod Updates

.gitignore

@@ -1,17 +1,16 @@
-.pytest_cache/
-**/__pycache__
+.vscode/
+*.code-workspace
+
 venv/
 .venv/
-bot/
-dist/
+.ruff_cache/
+.pytest_cache/
+**/__pycache__/
 *.egg-info/
 
-.vscode/
-*.code-workspace
-
+bot/
+dist/
 .python-version
-.venv
-
 .env
 *.sh
 *.bat

CHANGELOG.md

@@ -14,6 +14,112 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Removed
 
+## [0.23.0]
+
+### Added
+
+- Added a new type of database (`JsonDB`) that uses Pydantic models
+  - This should be used going forward
+  - The old database classes can be accessed from `commanderbot.lib.databases.v1`
+- Added an optional dependency group for OCR (Optical Character Recognition)
+  - Uses [tesserocr](https://github.com/sirfz/tesserocr)
+  - This is optional because it requires quite a bit of setup (Especially on Windows)
+  - Query `SUPPORTS_OCR` in `commanderbot.lib.constants` to check if it was added
+  - If added, it will add extra capabilities to the following extensions:
+    - `automod`
+- The following library classes now support Pydantic:
+  - `AllowedMentions`
+  - `Color`
+  - `ChannelType`
+  - `Intents`
+  - `ImageHash`
+  - `Timedelta`
+- `sudo`:
+  - Now supports exporting `JsonDB` databases
+- Added a process pool to `CommanderBot` that any extension can use
+
+### Changed
+
+- Updated discord.py to 2.7
+- The bot config now uses Pydantic
+- `automod`:
+  - Completely rewritten from scratch to fix tons of issues that have piled up over the years
+  - Now uses slash commands
+  - Now uses components v2
+  - Now uses `JsonDB` and Pydantic models
+  - Rule metadata now has it's own class instead of being combined with the rule
+  - Rules **must** be written in Json now (Sorry Arcensoth)
+  - You can now export the Json schema for rules
+    - This is useful for creating rules in a text editor
+  - Rules now receive an `AutomodContext` instead of an `AutomodEvent`
+    - This gives you access to:
+      - The bot
+      - The guild state that received the event
+      - The logger instance for that guild state
+      - The rule being ran
+      - The event
+    - Metadata now uses a dataclass instead of a `dict`
+    - Added support for caching attachment data
+    - String formatting using context data now uses `string.Template`
+  - Added support for buckets
+    - Closes ([Old repo #63](https://github.com/CommanderBot-Dev/commanderbot-py/pull/63))
+    - These can be used to persist data between events
+    - Available bucket types:
+      - `flagged_image_attachments`
+      - `message_history`
+  - New triggers:
+    - `discord_automod_blocked_member_interactions`
+    - `discord_automod_blocked_message`
+    - `discord_automod_timed_out`
+    - `member_gained_flags`
+    - `member_lost_flags`
+    - `member_timeout_started`
+    - `member_timeout_ended`
+    - `message_frequency`
+  - New conditions:
+    - `actor_has_all_flags`
+    - `actor_has_any_flags`
+    - `author_has_all_flags`
+    - `author_has_any_flags`
+    - `has_flagged_image_attachments`
+    - `image_attachments_contain`
+    - `random_chance`
+    - `randomize`
+    - `return_false`
+    - `return_true`
+  - New actions:
+    - `add_to_bucket`
+    - `delete_actor_messages`
+    - `delete_author_messages`
+    - `randomize`
+    - `sequence`
+    - `timeout_actor`
+    - `timeout_author`
+    - `type_in_channel`
+  - New events:
+    - `DiscordAutomodBlockedMemberInteractions`
+    - `DiscordAutomodBlockedMessage`
+    - `DiscordAutomodTimedOut`
+    - `GuildChannelPinsUpdated`
+    - `MessageFrequency`
+  - New guards:
+    - `CategoriesGuard`
+    - `ChannelTypesGuard`
+    - `DiscordAutomodRulesGuard`
+    - `FlagsGuard`
+- `help_forum`:
+  - Now uses `JsonDB` and Pydantic models (This is just a direct port with no optimizations)
+
+### Fixed
+
+- `mcdoc`:
+  - Fixed an issue where application emojis weren't being used
+
+### Removed
+
+- `help_chat`:
+  - It hasn't been used in ages and is pretty outdated now
+
 ## [0.22.0] - 2026-01-06
 
 ### Fixed
@@ -410,7 +516,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Implemented `status` and `faq` extensions as an exercise for developing `commanderbot-lib`
 
-[unreleased]: https://github.com/MinecraftCommands/commanderbot-py/compare/v0.22.0...HEAD
+[unreleased]: https://github.com/MinecraftCommands/commanderbot-py/compare/v0.23.0...HEAD
+[0.23.0]: https://github.com/MinecraftCommands/commanderbot-py/compare/v0.22.0...v0.23.0
 [0.22.0]: https://github.com/MinecraftCommands/commanderbot-py/compare/v0.21.0...v0.22.0
 [0.21.0]: https://github.com/MinecraftCommands/commanderbot-py/compare/v0.20.0...v0.21.0
 [0.20.0]: https://github.com/MinecraftCommands/commanderbot-py/compare/v0.19.0...v0.20.0

README.md

@@ -2,14 +2,16 @@
 
 A collection of utilities and extensions for discord.py bots.
 
-[![uv-badge]](https://github.com/astral-sh/uv/)
-[![package-badge]](https://pypi.python.org/pypi/commanderbot/)
-[![version-badge]](https://pypi.python.org/pypi/commanderbot/)
+[![uv-badge]](https://github.com/astral-sh/uv)
+[![ruff-badge]](https://github.com/astral-sh/ruff)
+[![ty-badge]](https://github.com/astral-sh/ty)
+[![package-badge]](https://pypi.python.org/pypi/commanderbot)
+[![version-badge]](https://pypi.python.org/pypi/commanderbot)
 
 ## Requirements
 
 - Python 3.14+
-- discord.py 2.6+
+- discord.py 2.7+
 
 ## Running your bot
 
@@ -75,5 +77,7 @@ The current set of configuration options is limited. The following is an example
 ```
 
 [uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=flat-square
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square
+[ty-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json&style=flat-square
 [package-badge]: https://img.shields.io/pypi/v/commanderbot.svg?style=flat-square
 [version-badge]: https://img.shields.io/pypi/pyversions/commanderbot.svg?style=flat-square

commanderbot/core/application_emoji_manager.py

@@ -5,6 +5,7 @@
 
 from commanderbot.core.exceptions import ApplicationEmojiDoesNotExist
 from commanderbot.lib import EmojiID
+from commanderbot.lib.predicates import is_emoji_id
 
 
 class ApplicationEmojiManager:
@@ -19,7 +20,7 @@ def _get_from_cache(self, emoji: str | EmojiID) -> Optional[Emoji]:
                 return e
 
         # Try to find the emoji by its ID
-        if isinstance(emoji, EmojiID):
+        if is_emoji_id(emoji):
             for e in self._cache.values():
                 if e.id == emoji:
                     return e

commanderbot/core/cli.py

@@ -50,19 +50,20 @@ def run():
     # Read config file
     log.info(f"Configuration file: {parsed_args.config}")
     log.debug("Parsing configuration file...")
-    config = Config.from_file(parsed_args.config)  # type: ignore
+    config = Config.model_validate_json(parsed_args.config.read_text())
+    config.log_info()
     log.debug("Successfully parsed configuration file!")
 
     # Get bot token
     bot_token = os.environ.get("BOT_TOKEN", None)
 
     if not bot_token:
         log.warning(
-            "Bot token provided in a form other than the BOT_TOKEN environment variable."
+            "Bot token provided in a form other than the BOT_TOKEN environment variable"
         )
 
         if parsed_args.token:
-            log.info("Using bot token provided as an argument.")
+            log.info("Using bot token provided as an argument")
             bot_token = parsed_args.token
 
         elif parsed_args.tokenfile:
@@ -78,6 +79,6 @@ def run():
     bot = CommanderBot(config, parsed_args.synctree)
     bot.run(bot_token)
 
-    log.warning("Bot has shut down.")
+    log.warning("Bot has shut down!")
 
     log.info("Goodbye!")

commanderbot/core/command_tree.py

@@ -1,7 +1,8 @@
 from collections import defaultdict
+from collections.abc import Iterable
 from dataclasses import dataclass, field
 from logging import Logger, getLogger
-from typing import Iterable, Optional, TypeAlias
+from typing import Optional, override
 
 from discord import AppCommandType
 from discord.abc import Snowflake
@@ -11,8 +12,8 @@
 
 __all__ = ("CachingCommandTree",)
 
-Cache: TypeAlias = dict[str, AppCommand]
-GuildType: TypeAlias = Snowflake | GuildID
+type Cache = dict[str, AppCommand]
+type GuildType = Snowflake | GuildID
 
 
 @dataclass
@@ -47,7 +48,7 @@ def update(self, commands: list[AppCommand], *, override: bool = False):
         def traverse_options(options: list[AppCommandGroup | Argument]):
             for option in options:
                 if isinstance(option, AppCommandGroup):
-                    self._cache[option.qualified_name] = option  # type: ignore
+                    self._cache[option.qualified_name] = option  # type: ignore[ty:invalid-assignment]
                     traverse_options(option.options)
 
         # Add commands and their options
@@ -90,7 +91,7 @@ def _get_cache(
         if guild:
             return self._guild_cache.get(self._guild_to_id(guild))
         else:
-            self._global_cache
+            return self._global_cache
 
     def _guild_to_id(self, guild: GuildType) -> GuildID:
         return guild.id if isinstance(guild, Snowflake) else guild
@@ -154,7 +155,7 @@ async def build_guild_cache(self, guilds: Iterable[Snowflake]):
 
         self._log.info("Finished building guild command cache.")
 
-    # @overrides CommandTree
+    @override
     async def fetch_command(
         self,
         command_id: int,
@@ -174,7 +175,7 @@ async def fetch_command(
         self.update_cache([command], guild=guild)
         return command
 
-    # @overrides CommandTree
+    @override
     async def fetch_commands(
         self, *, guild: Optional[Snowflake] = None, use_cache: bool = True
     ) -> list[AppCommand]:
@@ -188,7 +189,7 @@ async def fetch_commands(
         self.update_cache(commands, guild=guild, override=True)
         return commands
 
-    # @overrides CommandTree
+    @override
     async def sync(self, *, guild: Optional[Snowflake] = None) -> list[AppCommand]:
         # Create log messages
         sync_msg: str = "global app commands"
@@ -205,8 +206,8 @@ async def sync(self, *, guild: Optional[Snowflake] = None) -> list[AppCommand]:
         except Exception as ex:
             # Temporarily handle exception then re-raise it
             # This is only so we can print the warning to the log
-            self._log.warn(f"Unable to sync {sync_msg}. Reason: {ex}")
-            raise ex
+            self._log.warning(f"Unable to sync {sync_msg}. Reason: {ex}")
+            raise
 
         # Update cache
         self._log.info(f"Started updating {cache_msg}...")
@@ -215,7 +216,7 @@ async def sync(self, *, guild: Optional[Snowflake] = None) -> list[AppCommand]:
 
         return commands
 
-    # @overrides CommandTree
+    @override
     def clear_commands(
         self,
         *,