Add case_insensitive commands

Author: Eviee Py

twitchio/ext/commands/bot.py

@@ -46,10 +46,10 @@
     from twitchio.eventsub.subscriptions import SubscriptionPayload
     from twitchio.models.eventsub_ import ChatMessage
     from twitchio.types_.eventsub import SubscriptionResponse
-    from twitchio.types_.options import ClientOptions
     from twitchio.user import PartialUser
 
     from .components import Component
+    from .types_ import BotOptions
 
     PrefixT: TypeAlias = str | Iterable[str] | Callable[["Bot", "ChatMessage"], Coroutine[Any, Any, str | Iterable[str]]]
 
@@ -162,7 +162,7 @@ def __init__(
         bot_id: str,
         owner_id: str | None = None,
         prefix: PrefixT,
-        **options: Unpack[ClientOptions],
+        **options: Unpack[BotOptions],
     ) -> None:
         super().__init__(
             client_id=client_id,

twitchio/ext/commands/core.py

@@ -29,7 +29,7 @@
 import inspect
 from collections.abc import Callable, Coroutine, Generator
 from types import MappingProxyType, UnionType
-from typing import TYPE_CHECKING, Any, Concatenate, Generic, ParamSpec, TypeAlias, TypeVar, Union, Unpack
+from typing import TYPE_CHECKING, Any, Concatenate, Generic, ParamSpec, TypeAlias, TypeVar, Union, Unpack, overload
 
 from twitchio.utils import MISSING
 
@@ -67,6 +67,9 @@
 Coro: TypeAlias = Coroutine[Any, Any, None]
 CoroC: TypeAlias = Coroutine[Any, Any, bool]
 
+DT = TypeVar("DT")
+VT = TypeVar("VT")
+
 
 class CommandErrorPayload:
     """Payload received in the :func:`~twitchio.event_command_error` event.
@@ -395,9 +398,17 @@ def after_invoke(self) -> None: ...
 
 class Mixin(Generic[Component_T]):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
-        self._commands: dict[str, Command[Component_T, ...]] = {}
+        case_: bool = kwargs.pop("case_insensitive", False)
+        self._case_insensitive: bool = case_
+        self._commands: dict[str, Command[Component_T, ...]] = {} if not case_ else _CaseInsensitiveDict()
+
         super().__init__(*args, **kwargs)
 
+    @property
+    def case_insensitive(self) -> bool:
+        """Property returning a bool indicating whether this Mixin is using case insensitive commands."""
+        return self._case_insensitive
+
     def add_command(self, command: Command[Component_T, ...], /) -> None:
         """Add a :class:`~.commands.Command` object to the mixin.
 
@@ -986,3 +997,44 @@ def predicate(context: Context) -> bool:
         return chatter.moderator or chatter.vip
 
     return guard(predicate)
+
+
+class _CaseInsensitiveDict(dict[str, VT]):
+    def __contains__(self, key: object) -> bool:
+        return super().__contains__(key.casefold()) if isinstance(key, str) else False
+
+    def __delitem__(self, key: str) -> None:
+        return super().__delitem__(key.casefold())
+
+    def __getitem__(self, key: str) -> VT:
+        return super().__getitem__(key.casefold())
+
+    @overload
+    def get(self, key: str, /) -> VT | None: ...
+
+    @overload
+    def get(self, key: str, default: VT, /) -> VT: ...
+
+    @overload
+    def get(self, key: str, default: DT, /) -> VT | DT: ...
+
+    def get(self, key: str, default: DT = None) -> VT | DT:
+        return super().get(key.casefold(), default)
+
+    @overload
+    def pop(self, key: str, /) -> VT: ...
+
+    @overload
+    def pop(self, key: str, default: VT, /) -> VT: ...
+
+    @overload
+    def pop(self, key: str, default: DT, /) -> VT | DT: ...
+
+    def pop(self, key: str, default: DT = MISSING) -> VT | DT:
+        if default is MISSING:
+            return super().pop(key.casefold())
+
+        return super().pop(key.casefold(), default)
+
+    def __setitem__(self, key: str, value: VT) -> None:
+        super().__setitem__(key.casefold(), value)

twitchio/ext/commands/types_.py

@@ -24,6 +24,8 @@
 
 from typing import TYPE_CHECKING, Any, TypedDict, TypeVar
 
+from twitchio.types_.options import ClientOptions
+
 
 if TYPE_CHECKING:
     from .components import Component
@@ -40,3 +42,7 @@ class CommandOptions(TypedDict, total=False):
 class ComponentOptions(TypedDict, total=False):
     name: str | None
     extras: dict[Any, Any]
+
+
+class BotOptions(ClientOptions, total=False):
+    case_insensitive: bool