feat(commands): add support for typing.Literal[...] as command choices (#2782)

* fix: add support for Literal type in typing annotations for Discord choices

* Update CHANGELOG.md

* Update CHANGELOG.md

Signed-off-by: Lumouille <[email protected]>

* Update CHANGELOG.md

Co-authored-by: JustaSqu1d <[email protected]>
Signed-off-by: Lumouille <[email protected]>

* refactor: move condition to method

* docs: update changelog

* fix: ensure all literal values are of the same type in SlashCommand options

* Update discord/commands/core.py

Co-authored-by: Paillat <[email protected]>
Signed-off-by: Lumouille <[email protected]>

* Update discord/commands/core.py

Co-authored-by: Paillat <[email protected]>
Signed-off-by: Lumouille <[email protected]>

* style(pre-commit): auto fixes from pre-commit.com hooks

---------

Signed-off-by: Lumouille <[email protected]>
Co-authored-by: JustaSqu1d <[email protected]>
Co-authored-by: Dorukyum <[email protected]>
Co-authored-by: Paillat <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 5 people

CHANGELOG.md

@@ -57,6 +57,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#2714](https://github.com/Pycord-Development/pycord/pull/2714))
 - Added the ability to pass a `datetime.time` object to `format_dt`.
   ([#2747](https://github.com/Pycord-Development/pycord/pull/2747))
+- Added support for type hinting slash command options with `typing.Annotated`.
+  ([#2782](https://github.com/Pycord-Development/pycord/pull/2782))
 - Added conversion to `Member` in `MentionableConverter`.
   ([#2775](https://github.com/Pycord-Development/pycord/pull/2775))
 - Added `discord.Interaction.created_at`.

discord/commands/core.py

@@ -73,9 +73,9 @@
 from .options import Option, OptionChoice
 
 if sys.version_info >= (3, 11):
-    from typing import Annotated, get_args, get_origin
+    from typing import Annotated, Literal, get_args, get_origin
 else:
-    from typing_extensions import Annotated, get_args, get_origin
+    from typing_extensions import Annotated, Literal, get_args, get_origin
 
 __all__ = (
     "_BaseCommand",
@@ -806,6 +806,26 @@ def _parse_options(self, params, *, check_params: bool = True) -> list[Option]:
             if option == inspect.Parameter.empty:
                 option = str
 
+            if self._is_typing_literal(option):
+                literal_values = get_args(option)
+                if not all(isinstance(v, (str, int, float)) for v in literal_values):
+                    raise TypeError(
+                        "Literal values for choices must be str, int, or float."
+                    )
+
+                value_type = type(literal_values[0])
+                if not all(isinstance(v, value_type) for v in literal_values):
+                    raise TypeError(
+                        "All Literal values for choices must be of the same type."
+                    )
+
+                option = Option(
+                    value_type,
+                    choices=[
+                        OptionChoice(name=str(v), value=v) for v in literal_values
+                    ],
+                )
+
             if self._is_typing_annotated(option):
                 type_hint = get_args(option)[0]
                 metadata = option.__metadata__
@@ -908,6 +928,9 @@ def _is_typing_union(self, annotation):
     def _is_typing_optional(self, annotation):
         return self._is_typing_union(annotation) and type(None) in annotation.__args__  # type: ignore
 
+    def _is_typing_literal(self, annotation):
+        return get_origin(annotation) is Literal
+
     def _is_typing_annotated(self, annotation):
         return get_origin(annotation) is Annotated