Slight reorganisation and implement custom converters for slash commands

docs/source/api_references/parser.rst

@@ -0,0 +1,6 @@
+====================
+Parser API Reference
+====================
+
+.. automodule:: lightbulb.parser
+   :members:

docs/source/api_references/utils.rst

@@ -26,14 +26,6 @@ Pag
 
 ----
 
-Parser
-======
-
-.. automodule:: lightbulb.utils.parser
-   :members:
-
-----
-
 Permissions
 ===========
 

docs/source/changelogs/v2-changelog.rst

@@ -6,6 +6,17 @@ Below are all the changelogs for the stable versions of hikari-lightbulb (versio
 
 ----
 
+Version 2.3.2
+=============
+
+**Potentially Breaking Changes**
+
+- Module ``lightbulb.utils.parser`` has been moved up a level to ``lightbulb.parser``.
+
+**Other Changes**
+
+- Slash commands now have full custom converter support.
+
 Version 2.3.1
 =============
 

docs/source/guides/commands.rst

@@ -267,6 +267,12 @@ Acceptable primitives: ``str``, ``int``, ``float``
 
 - ``hikari.Attachment`` - ``hikari.OptionType.ATTACHMENT``
 
+.. note::
+    Slash command options that resolve to type ``hikari.OptionType.STRING`` will also have the appropriate
+    converter run upon invocation. If this causes the command to take too long to run then you can
+    pass ``auto_defer=True`` to the ``lightbulb.command`` decorator. The deferral will be processed prior
+    to the conversion of options.
+
 ----
 
 Adding Checks to Commands

lightbulb/__init__.py

@@ -23,6 +23,7 @@
     "BangBangCooldownAlgorithm",
     "BaseConverter",
     "BaseHelpCommand",
+    "BaseParser",
     "BooleanConverter",
     "BotApp",
     "BotMissingRequiredPermission",
@@ -82,6 +83,7 @@
     "OptionLike",
     "OptionModifier",
     "OptionsProxy",
+    "Parser",
     "Plugin",
     "PrefixCommand",
     "PrefixCommandCompletionEvent",
@@ -150,6 +152,7 @@
     "nsfw_channel_only",
     "option",
     "owner_only",
+    "parser",
     "plugins",
     "set_help",
     "set_max_concurrency",
@@ -170,6 +173,7 @@
 from lightbulb import errors
 from lightbulb import events
 from lightbulb import help_command
+from lightbulb import parser
 from lightbulb import plugins
 from lightbulb import utils
 from lightbulb.app import *
@@ -184,6 +188,7 @@
 from lightbulb.errors import *
 from lightbulb.events import *
 from lightbulb.help_command import *
+from lightbulb.parser import *
 from lightbulb.plugins import *
 
-__version__ = "2.3.1"
+__version__ = "2.3.2"

lightbulb/app.py

@@ -33,7 +33,6 @@
 from importlib import util
 
 import hikari
-from hikari.internal import ux
 from multidict import CIMultiDict
 
 from lightbulb import checks
@@ -44,9 +43,9 @@
 from lightbulb import events
 from lightbulb import help_command as help_command_
 from lightbulb import internal
+from lightbulb import parser
 from lightbulb import plugins as plugins_
 from lightbulb.utils import data_store
-from lightbulb.utils import parser
 
 _LOGGER = logging.getLogger("lightbulb.app")
 _APPLICATION_CMD_ERROR_REGEX: re.Pattern[str] = re.compile(

lightbulb/commands/base.py

@@ -40,8 +40,8 @@
     from lightbulb import context as context_
     from lightbulb import cooldowns
     from lightbulb import events
+    from lightbulb import parser as parser_
     from lightbulb import plugins
-    from lightbulb.utils import parser as parser_
 
 _AutocompleteableOptionT = t.Union[str, int, float]
 AutocompleteCallbackT = t.TypeVar(

lightbulb/context/prefix.py

@@ -31,7 +31,7 @@
 
     from lightbulb import app as app_
     from lightbulb import commands
-    from lightbulb.utils import parser
+    from lightbulb import parser
 
 
 class PrefixContext(base.Context):

lightbulb/context/slash.py

@@ -19,12 +19,14 @@
 
 __all__ = ["SlashContext"]
 
+import asyncio
 import typing as t
 
 import hikari
 
 from lightbulb import commands
 from lightbulb.context import base
+from lightbulb.converters import CONVERTER_TYPE_MAPPING
 
 if t.TYPE_CHECKING:
     from lightbulb import app as app_
@@ -41,16 +43,24 @@ class SlashContext(base.ApplicationContext):
         command (:obj:`~.commands.slash.SlashCommand`): The command that the context is for.
     """
 
-    __slots__ = ("_options", "_raw_options")
+    __slots__ = ("_options", "_raw_options", "_to_convert")
 
     def __init__(
         self, app: app_.BotApp, event: hikari.InteractionCreateEvent, command: commands.slash.SlashCommand
     ) -> None:
         super().__init__(app, event, command)
         self._options: t.Dict[str, t.Any] = {}
         self._raw_options: t.Sequence[hikari.CommandInteractionOption] = self.interaction.options or []
+        self._to_convert: t.List[t.Coroutine[t.Any, t.Any, None]] = []
         self._parse_options(self.interaction.options)
 
+    async def _convert_option(self, name: str, value: str) -> None:
+        cmd = self.invoked or self.command
+        if cmd.options[name].arg_type in CONVERTER_TYPE_MAPPING:
+            self._options[name] = await CONVERTER_TYPE_MAPPING[cmd.options[name].arg_type](self).convert(value)
+            return
+        self._options[name] = value
+
     def _parse_options(self, options: t.Optional[t.Sequence[hikari.CommandInteractionOption]]) -> None:
         # We need to clear the options here to ensure the subcommand name does not exist in the mapping
         self._options.clear()
@@ -69,12 +79,20 @@ def _parse_options(self, options: t.Optional[t.Sequence[hikari.CommandInteractio
                 val = t.cast(hikari.Snowflake, int(opt.value) if isinstance(opt.value, str) else opt.value)
                 self._options[opt.name] = self.resolved.attachments.get(val, opt.value)
             else:
+                if isinstance(opt.value, str):
+                    self._to_convert.append(self._convert_option(opt.name, opt.value))
+                    continue
                 self._options[opt.name] = opt.value
 
         cmd = self.invoked or self.command
         for opt in cmd.options.values():
             self._options.setdefault(opt.name, opt.default if opt.default is not hikari.UNDEFINED else None)
 
+    async def _maybe_defer(self) -> None:
+        await super()._maybe_defer()
+        # Ensure that running converters don't block the automatic deferral
+        await asyncio.gather(*self._to_convert)
+
     @property
     def raw_options(self) -> t.Dict[str, t.Any]:
         return self._options

lightbulb/converters/__init__.py

@@ -36,7 +36,31 @@
     "UserConverter",
 ]
 
+import datetime
+import typing as t
+
+import hikari
+
 from lightbulb.converters import base
 from lightbulb.converters import special
 from lightbulb.converters.base import *
 from lightbulb.converters.special import *
+
+CONVERTER_TYPE_MAPPING: t.Mapping[t.Any, t.Type[base.BaseConverter[t.Any]]] = {
+    hikari.User: special.UserConverter,
+    hikari.Member: special.MemberConverter,
+    hikari.GuildChannel: special.GuildChannelConverter,
+    hikari.TextableGuildChannel: special.TextableGuildChannelConverter,
+    hikari.TextableChannel: special.TextableGuildChannelConverter,
+    hikari.GuildCategory: special.GuildCategoryConverter,
+    hikari.GuildVoiceChannel: special.GuildVoiceChannelConverter,
+    hikari.Role: special.RoleConverter,
+    hikari.Emoji: special.EmojiConverter,
+    hikari.Guild: special.GuildConverter,
+    hikari.Message: special.MessageConverter,
+    hikari.Invite: special.InviteConverter,
+    hikari.Colour: special.ColourConverter,
+    hikari.Color: special.ColourConverter,
+    hikari.Snowflake: special.SnowflakeConverter,
+    datetime.datetime: special.TimestampConverter,
+}

lightbulb/converters/base.py

@@ -22,7 +22,8 @@
 import abc
 import typing as t
 
-from lightbulb import context as context_
+if t.TYPE_CHECKING:
+    from lightbulb import context as context_
 
 T = t.TypeVar("T")
 
@@ -38,7 +39,7 @@ class BaseConverter(abc.ABC, t.Generic[T]):
     __slots__ = ("context",)
 
     def __init__(self, context: context_.base.Context) -> None:
-        self.context = context
+        self.context: context_.Context = context
         """Context to convert the argument(s) under."""
 
     @abc.abstractmethod