disagreement 0.0.1__py3-none-any.whl → 0.1.0rc1__py3-none-any.whl

disagreement/ext/commands/core.py

@@ -0,0 +1,497 @@
+# disagreement/ext/commands/core.py
+
+import asyncio
+import inspect
+from typing import (
+    TYPE_CHECKING,
+    Optional,
+    List,
+    Dict,
+    Any,
+    Union,
+    Callable,
+    Awaitable,
+    Tuple,
+    get_origin,
+    get_args,
+)
+
+from .view import StringView
+from .errors import (
+    CommandError,
+    CommandNotFound,
+    BadArgument,
+    MissingRequiredArgument,
+    ArgumentParsingError,
+    CheckFailure,
+    CommandInvokeError,
+)
+from .converters import run_converters, DEFAULT_CONVERTERS, Converter
+from .cog import Cog
+from disagreement.typing import Typing
+
+if TYPE_CHECKING:
+    from disagreement.client import Client
+    from disagreement.models import Message, User
+
+
+class Command:
+    """
+    Represents a bot command.
+
+    Attributes:
+        name (str): The primary name of the command.
+        callback (Callable[..., Awaitable[None]]): The coroutine function to execute.
+        aliases (List[str]): Alternative names for the command.
+        brief (Optional[str]): A short description for help commands.
+        description (Optional[str]): A longer description for help commands.
+        cog (Optional['Cog']): Reference to the Cog this command belongs to.
+        params (Dict[str, inspect.Parameter]): Cached parameters of the callback.
+    """
+
+    def __init__(self, callback: Callable[..., Awaitable[None]], **attrs: Any):
+        if not asyncio.iscoroutinefunction(callback):
+            raise TypeError("Command callback must be a coroutine function.")
+
+        self.callback: Callable[..., Awaitable[None]] = callback
+        self.name: str = attrs.get("name", callback.__name__)
+        self.aliases: List[str] = attrs.get("aliases", [])
+        self.brief: Optional[str] = attrs.get("brief")
+        self.description: Optional[str] = attrs.get("description") or callback.__doc__
+        self.cog: Optional["Cog"] = attrs.get("cog")
+
+        self.params = inspect.signature(callback).parameters
+        self.checks: List[Callable[["CommandContext"], Awaitable[bool] | bool]] = []
+        if hasattr(callback, "__command_checks__"):
+            self.checks.extend(getattr(callback, "__command_checks__"))
+
+    def add_check(
+        self, predicate: Callable[["CommandContext"], Awaitable[bool] | bool]
+    ) -> None:
+        self.checks.append(predicate)
+
+    async def invoke(self, ctx: "CommandContext", *args: Any, **kwargs: Any) -> None:
+        from .errors import CheckFailure
+
+        for predicate in self.checks:
+            result = predicate(ctx)
+            if inspect.isawaitable(result):
+                result = await result
+            if not result:
+                raise CheckFailure("Check predicate failed.")
+
+        if self.cog:
+            await self.callback(self.cog, ctx, *args, **kwargs)
+        else:
+            await self.callback(ctx, *args, **kwargs)
+
+
+class CommandContext:
+    """
+    Represents the context in which a command is being invoked.
+    """
+
+    def __init__(
+        self,
+        *,
+        message: "Message",
+        bot: "Client",
+        prefix: str,
+        command: "Command",
+        invoked_with: str,
+        args: Optional[List[Any]] = None,
+        kwargs: Optional[Dict[str, Any]] = None,
+        cog: Optional["Cog"] = None,
+    ):
+        self.message: "Message" = message
+        self.bot: "Client" = bot
+        self.prefix: str = prefix
+        self.command: "Command" = command
+        self.invoked_with: str = invoked_with
+        self.args: List[Any] = args or []
+        self.kwargs: Dict[str, Any] = kwargs or {}
+        self.cog: Optional["Cog"] = cog
+
+        self.author: "User" = message.author
+
+    @property
+    def guild(self):
+        """The guild this command was invoked in."""
+        if self.message.guild_id and hasattr(self.bot, "get_guild"):
+            return self.bot.get_guild(self.message.guild_id)
+        return None
+
+    async def reply(
+        self,
+        content: str,
+        *,
+        mention_author: Optional[bool] = None,
+        **kwargs: Any,
+    ) -> "Message":
+        """Replies to the invoking message.
+
+        Parameters
+        ----------
+        content: str
+            The content to send.
+        mention_author: Optional[bool]
+            Whether to mention the author in the reply. If ``None`` the
+            client's :attr:`mention_replies` value is used.
+        """
+
+        allowed_mentions = kwargs.pop("allowed_mentions", None)
+        if mention_author is None:
+            mention_author = getattr(self.bot, "mention_replies", False)
+
+        if allowed_mentions is None:
+            allowed_mentions = {"replied_user": mention_author}
+        else:
+            allowed_mentions = dict(allowed_mentions)
+            allowed_mentions.setdefault("replied_user", mention_author)
+
+        return await self.bot.send_message(
+            channel_id=self.message.channel_id,
+            content=content,
+            message_reference={
+                "message_id": self.message.id,
+                "channel_id": self.message.channel_id,
+                "guild_id": self.message.guild_id,
+            },
+            allowed_mentions=allowed_mentions,
+            **kwargs,
+        )
+
+    async def send(self, content: str, **kwargs: Any) -> "Message":
+        return await self.bot.send_message(
+            channel_id=self.message.channel_id, content=content, **kwargs
+        )
+
+    async def edit(
+        self,
+        message: Union[str, "Message"],
+        *,
+        content: Optional[str] = None,
+        **kwargs: Any,
+    ) -> "Message":
+        """Edits a message previously sent by the bot."""
+
+        message_id = message if isinstance(message, str) else message.id
+        return await self.bot.edit_message(
+            channel_id=self.message.channel_id,
+            message_id=message_id,
+            content=content,
+            **kwargs,
+        )
+
+    def typing(self) -> "Typing":
+        """Return a typing context manager for this context's channel."""
+
+        return self.bot.typing(self.message.channel_id)
+
+
+class CommandHandler:
+    """
+    Manages command registration, parsing, and dispatching.
+    """
+
+    def __init__(
+        self,
+        client: "Client",
+        prefix: Union[
+            str, List[str], Callable[["Client", "Message"], Union[str, List[str]]]
+        ],
+    ):
+        self.client: "Client" = client
+        self.prefix: Union[
+            str, List[str], Callable[["Client", "Message"], Union[str, List[str]]]
+        ] = prefix
+        self.commands: Dict[str, Command] = {}
+        self.cogs: Dict[str, "Cog"] = {}
+
+        from .help import HelpCommand
+
+        self.add_command(HelpCommand(self))
+
+    def add_command(self, command: Command) -> None:
+        if command.name in self.commands:
+            raise ValueError(f"Command '{command.name}' is already registered.")
+
+        self.commands[command.name.lower()] = command
+        for alias in command.aliases:
+            if alias in self.commands:
+                print(
+                    f"Warning: Alias '{alias}' for command '{command.name}' conflicts with an existing command or alias."
+                )
+            self.commands[alias.lower()] = command
+
+    def remove_command(self, name: str) -> Optional[Command]:
+        command = self.commands.pop(name.lower(), None)
+        if command:
+            for alias in command.aliases:
+                self.commands.pop(alias.lower(), None)
+        return command
+
+    def get_command(self, name: str) -> Optional[Command]:
+        return self.commands.get(name.lower())
+
+    def add_cog(self, cog_to_add: "Cog") -> None:
+        if not isinstance(cog_to_add, Cog):
+            raise TypeError("Argument must be a subclass of Cog.")
+
+        if cog_to_add.cog_name in self.cogs:
+            raise ValueError(
+                f"Cog with name '{cog_to_add.cog_name}' is already registered."
+            )
+
+        self.cogs[cog_to_add.cog_name] = cog_to_add
+
+        for cmd in cog_to_add.get_commands():
+            self.add_command(cmd)
+
+        if hasattr(self.client, "_event_dispatcher"):
+            for event_name, callback in cog_to_add.get_listeners():
+                self.client._event_dispatcher.register(event_name.upper(), callback)
+        else:
+            print(
+                f"Warning: Client does not have '_event_dispatcher'. Listeners for cog '{cog_to_add.cog_name}' not registered."
+            )
+
+        if hasattr(cog_to_add, "cog_load") and inspect.iscoroutinefunction(
+            cog_to_add.cog_load
+        ):
+            asyncio.create_task(cog_to_add.cog_load())
+
+        print(f"Cog '{cog_to_add.cog_name}' added.")
+
+    def remove_cog(self, cog_name: str) -> Optional["Cog"]:
+        cog_to_remove = self.cogs.pop(cog_name, None)
+        if cog_to_remove:
+            for cmd in cog_to_remove.get_commands():
+                self.remove_command(cmd.name)
+
+            if hasattr(self.client, "_event_dispatcher"):
+                for event_name, callback in cog_to_remove.get_listeners():
+                    print(
+                        f"Note: Listener '{callback.__name__}' for event '{event_name}' from cog '{cog_name}' needs manual unregistration logic in EventDispatcher."
+                    )
+
+            if hasattr(cog_to_remove, "cog_unload") and inspect.iscoroutinefunction(
+                cog_to_remove.cog_unload
+            ):
+                asyncio.create_task(cog_to_remove.cog_unload())
+
+            cog_to_remove._eject()
+            print(f"Cog '{cog_name}' removed.")
+        return cog_to_remove
+
+    async def get_prefix(self, message: "Message") -> Union[str, List[str], None]:
+        if callable(self.prefix):
+            if inspect.iscoroutinefunction(self.prefix):
+                return await self.prefix(self.client, message)
+            else:
+                return self.prefix(self.client, message)  # type: ignore
+        return self.prefix
+
+    async def _parse_arguments(
+        self, command: Command, ctx: CommandContext, view: StringView
+    ) -> Tuple[List[Any], Dict[str, Any]]:
+        args_list = []
+        kwargs_dict = {}
+        params_to_parse = list(command.params.values())
+
+        if params_to_parse and params_to_parse[0].name == "self" and command.cog:
+            params_to_parse.pop(0)
+        if params_to_parse and params_to_parse[0].name == "ctx":
+            params_to_parse.pop(0)
+
+        for param in params_to_parse:
+            view.skip_whitespace()
+            final_value_for_param: Any = inspect.Parameter.empty
+
+            if param.kind == inspect.Parameter.VAR_POSITIONAL:
+                while not view.eof:
+                    view.skip_whitespace()
+                    if view.eof:
+                        break
+                    word = view.get_word()
+                    if word or not view.eof:
+                        args_list.append(word)
+                    elif view.eof:
+                        break
+                break
+
+            arg_str_value: Optional[str] = (
+                None  # Holds the raw string for current param
+            )
+
+            if view.eof:  # No more input string
+                if param.default is not inspect.Parameter.empty:
+                    final_value_for_param = param.default
+                elif param.kind != inspect.Parameter.VAR_KEYWORD:
+                    raise MissingRequiredArgument(param.name)
+                else:  # VAR_KEYWORD at EOF is fine
+                    break
+            else:  # Input available
+                is_last_pos_str_greedy = (
+                    param == params_to_parse[-1]
+                    and param.annotation is str
+                    and param.kind == inspect.Parameter.POSITIONAL_OR_KEYWORD
+                )
+
+                if is_last_pos_str_greedy:
+                    arg_str_value = view.read_rest().strip()
+                    if (
+                        not arg_str_value
+                        and param.default is not inspect.Parameter.empty
+                    ):
+                        final_value_for_param = param.default
+                    else:  # Includes empty string if that's what's left
+                        final_value_for_param = arg_str_value
+                else:  # Not greedy, or not string, or not last positional
+                    if view.buffer[view.index] == '"':
+                        arg_str_value = view.get_quoted_string()
+                        if arg_str_value == "" and view.buffer[view.index] == '"':
+                            raise BadArgument(
+                                f"Unterminated quoted string for argument '{param.name}'."
+                            )
+                    else:
+                        arg_str_value = view.get_word()
+
+                # If final_value_for_param was not set by greedy logic, try conversion
+                if final_value_for_param is inspect.Parameter.empty:
+                    if (
+                        arg_str_value is None
+                    ):  # Should not happen if view.get_word/get_quoted_string is robust
+                        if param.default is not inspect.Parameter.empty:
+                            final_value_for_param = param.default
+                        else:
+                            raise MissingRequiredArgument(param.name)
+                    else:  # We have an arg_str_value (could be empty string "" from quotes)
+                        annotation = param.annotation
+                        origin = get_origin(annotation)
+
+                        if origin is Union:  # Handles Optional[T] and Union[T1, T2]
+                            union_args = get_args(annotation)
+                            is_optional = (
+                                len(union_args) == 2 and type(None) in union_args
+                            )
+
+                            converted_for_union = False
+                            last_err_union: Optional[BadArgument] = None
+                            for t_arg in union_args:
+                                if t_arg is type(None):
+                                    continue
+                                try:
+                                    final_value_for_param = await run_converters(
+                                        ctx, t_arg, arg_str_value
+                                    )
+                                    converted_for_union = True
+                                    break
+                                except BadArgument as e:
+                                    last_err_union = e
+
+                            if not converted_for_union:
+                                if (
+                                    is_optional and param.default is None
+                                ):  # Special handling for Optional[T] if conversion failed
+                                    # If arg_str_value was "" and type was Optional[str], StringConverter would return ""
+                                    # If arg_str_value was "" and type was Optional[int], BadArgument would be raised.
+                                    # This path is for when all actual types in Optional[T] fail conversion.
+                                    # If default is None, we can assign None.
+                                    final_value_for_param = None
+                                elif last_err_union:
+                                    raise last_err_union
+                                else:  # Should not be reached if logic is correct
+                                    raise BadArgument(
+                                        f"Could not convert '{arg_str_value}' to any of {union_args} for param '{param.name}'."
+                                    )
+                        elif annotation is inspect.Parameter.empty or annotation is str:
+                            final_value_for_param = arg_str_value
+                        else:  # Standard type hint
+                            final_value_for_param = await run_converters(
+                                ctx, annotation, arg_str_value
+                            )
+
+            # Final check if value was resolved
+            if final_value_for_param is inspect.Parameter.empty:
+                if param.default is not inspect.Parameter.empty:
+                    final_value_for_param = param.default
+                elif param.kind != inspect.Parameter.VAR_KEYWORD:
+                    # This state implies an issue if required and no default, and no input was parsed.
+                    raise MissingRequiredArgument(
+                        f"Parameter '{param.name}' could not be resolved."
+                    )
+
+            # Assign to args_list or kwargs_dict if a value was determined
+            if final_value_for_param is not inspect.Parameter.empty:
+                if (
+                    param.kind == inspect.Parameter.POSITIONAL_OR_KEYWORD
+                    or param.kind == inspect.Parameter.POSITIONAL_ONLY
+                ):
+                    args_list.append(final_value_for_param)
+                elif param.kind == inspect.Parameter.KEYWORD_ONLY:
+                    kwargs_dict[param.name] = final_value_for_param
+
+        return args_list, kwargs_dict
+
+    async def process_commands(self, message: "Message") -> None:
+        if not message.content:
+            return
+
+        prefix_to_use = await self.get_prefix(message)
+        if not prefix_to_use:
+            return
+
+        actual_prefix: Optional[str] = None
+        if isinstance(prefix_to_use, list):
+            for p in prefix_to_use:
+                if message.content.startswith(p):
+                    actual_prefix = p
+                    break
+            if not actual_prefix:
+                return
+        elif isinstance(prefix_to_use, str):
+            if message.content.startswith(prefix_to_use):
+                actual_prefix = prefix_to_use
+            else:
+                return
+        else:
+            return
+
+        if actual_prefix is None:
+            return
+
+        content_without_prefix = message.content[len(actual_prefix) :]
+        view = StringView(content_without_prefix)
+
+        command_name = view.get_word()
+        if not command_name:
+            return
+
+        command = self.get_command(command_name)
+        if not command:
+            return
+
+        ctx = CommandContext(
+            message=message,
+            bot=self.client,
+            prefix=actual_prefix,
+            command=command,
+            invoked_with=command_name,
+            cog=command.cog,
+        )
+
+        try:
+            parsed_args, parsed_kwargs = await self._parse_arguments(command, ctx, view)
+            ctx.args = parsed_args
+            ctx.kwargs = parsed_kwargs
+            await command.invoke(ctx, *parsed_args, **parsed_kwargs)
+        except CommandError as e:
+            print(f"Command error for '{command.name}': {e}")
+            if hasattr(self.client, "on_command_error"):
+                await self.client.on_command_error(ctx, e)
+        except Exception as e:
+            print(f"Unexpected error invoking command '{command.name}': {e}")
+            exc = CommandInvokeError(e)
+            if hasattr(self.client, "on_command_error"):
+                await self.client.on_command_error(ctx, exc)

disagreement/ext/commands/decorators.py

@@ -0,0 +1,192 @@
+# disagreement/ext/commands/decorators.py
+from __future__ import annotations
+
+import asyncio
+import inspect
+import time
+from typing import Callable, Any, Optional, List, TYPE_CHECKING, Awaitable
+
+if TYPE_CHECKING:
+    from .core import Command, CommandContext
+    from disagreement.permissions import Permissions
+    from disagreement.models import Member, Guild, Channel
+
+
+def command(
+    name: Optional[str] = None, aliases: Optional[List[str]] = None, **attrs: Any
+) -> Callable:
+    """
+    A decorator that transforms a function into a Command.
+
+    Args:
+        name (Optional[str]): The name of the command. Defaults to the function name.
+        aliases (Optional[List[str]]): Alternative names for the command.
+        **attrs: Additional attributes to pass to the Command constructor
+                 (e.g., brief, description, hidden).
+
+    Returns:
+        Callable: A decorator that registers the command.
+    """
+
+    def decorator(
+        func: Callable[..., Awaitable[None]],
+    ) -> Callable[..., Awaitable[None]]:
+        if not asyncio.iscoroutinefunction(func):
+            raise TypeError("Command callback must be a coroutine function.")
+
+        from .core import Command
+
+        cmd_name = name or func.__name__
+
+        if hasattr(func, "__command_attrs__"):
+            raise TypeError("Function is already a command or has command attributes.")
+
+        cmd = Command(callback=func, name=cmd_name, aliases=aliases or [], **attrs)
+        func.__command_object__ = cmd  # type: ignore
+        return func
+
+    return decorator
+
+
+def listener(
+    name: Optional[str] = None,
+) -> Callable[[Callable[..., Awaitable[None]]], Callable[..., Awaitable[None]]]:
+    """
+    A decorator that marks a function as an event listener within a Cog.
+    """
+
+    def decorator(
+        func: Callable[..., Awaitable[None]],
+    ) -> Callable[..., Awaitable[None]]:
+        if not asyncio.iscoroutinefunction(func):
+            raise TypeError("Listener callback must be a coroutine function.")
+
+        actual_event_name = name or func.__name__
+        setattr(func, "__listener_name__", actual_event_name)
+        return func
+
+    return decorator
+
+
+def check(
+    predicate: Callable[["CommandContext"], Awaitable[bool] | bool],
+) -> Callable[[Callable[..., Awaitable[None]]], Callable[..., Awaitable[None]]]:
+    """Decorator to add a check to a command."""
+
+    def decorator(
+        func: Callable[..., Awaitable[None]],
+    ) -> Callable[..., Awaitable[None]]:
+        checks = getattr(func, "__command_checks__", [])
+        checks.append(predicate)
+        setattr(func, "__command_checks__", checks)
+        return func
+
+    return decorator
+
+
+def check_any(
+    *predicates: Callable[["CommandContext"], Awaitable[bool] | bool]
+) -> Callable[[Callable[..., Awaitable[None]]], Callable[..., Awaitable[None]]]:
+    """Decorator that passes if any predicate returns ``True``."""
+
+    async def predicate(ctx: "CommandContext") -> bool:
+        from .errors import CheckAnyFailure, CheckFailure
+
+        errors = []
+        for p in predicates:
+            try:
+                result = p(ctx)
+                if inspect.isawaitable(result):
+                    result = await result
+                if result:
+                    return True
+            except CheckFailure as e:
+                errors.append(e)
+        raise CheckAnyFailure(errors)
+
+    return check(predicate)
+
+
+def cooldown(
+    rate: int, per: float
+) -> Callable[[Callable[..., Awaitable[None]]], Callable[..., Awaitable[None]]]:
+    """Simple per-user cooldown decorator."""
+
+    buckets: dict[str, dict[str, float]] = {}
+
+    async def predicate(ctx: "CommandContext") -> bool:
+        from .errors import CommandOnCooldown
+
+        now = time.monotonic()
+        user_buckets = buckets.setdefault(ctx.command.name, {})
+        reset = user_buckets.get(ctx.author.id, 0)
+        if now < reset:
+            raise CommandOnCooldown(reset - now)
+        user_buckets[ctx.author.id] = now + per
+        return True
+
+    return check(predicate)
+
+
+def _compute_permissions(
+    member: "Member", channel: "Channel", guild: "Guild"
+) -> "Permissions":
+    """Compute the effective permissions for a member in a channel."""
+    return channel.permissions_for(member)
+
+
+def requires_permissions(
+    *perms: "Permissions",
+) -> Callable[[Callable[..., Awaitable[None]]], Callable[..., Awaitable[None]]]:
+    """Check that the invoking member has the given permissions in the channel."""
+
+    async def predicate(ctx: "CommandContext") -> bool:
+        from .errors import CheckFailure
+        from disagreement.permissions import (
+            has_permissions,
+            missing_permissions,
+        )
+        from disagreement.models import Member
+
+        channel = getattr(ctx, "channel", None)
+        if channel is None and hasattr(ctx.bot, "get_channel"):
+            channel = ctx.bot.get_channel(ctx.message.channel_id)
+        if channel is None and hasattr(ctx.bot, "fetch_channel"):
+            channel = await ctx.bot.fetch_channel(ctx.message.channel_id)
+
+        if channel is None:
+            raise CheckFailure("Channel for permission check not found.")
+
+        guild = getattr(channel, "guild", None)
+        if not guild and hasattr(channel, "guild_id") and channel.guild_id:
+            if hasattr(ctx.bot, "get_guild"):
+                guild = ctx.bot.get_guild(channel.guild_id)
+            if not guild and hasattr(ctx.bot, "fetch_guild"):
+                guild = await ctx.bot.fetch_guild(channel.guild_id)
+
+        if not guild:
+            is_dm = not hasattr(channel, "guild_id") or not channel.guild_id
+            if is_dm:
+                if perms:
+                    raise CheckFailure("Permission checks are not supported in DMs.")
+                return True
+            raise CheckFailure("Guild for permission check not found.")
+
+        member = ctx.author
+        if not isinstance(member, Member):
+            member = guild.get_member(ctx.author.id)
+            if not member and hasattr(ctx.bot, "fetch_member"):
+                member = await ctx.bot.fetch_member(guild.id, ctx.author.id)
+
+        if not member:
+            raise CheckFailure("Could not resolve author to a guild member.")
+
+        perms_value = _compute_permissions(member, channel, guild)
+
+        if not has_permissions(perms_value, *perms):
+            missing = missing_permissions(perms_value, *perms)
+            missing_names = ", ".join(p.name for p in missing if p.name)
+            raise CheckFailure(f"Missing permissions: {missing_names}")
+        return True
+
+    return check(predicate)