refactor!: use Annotated for command options

Author: VincentRPS

examples/interactions/commands/application_commands.py

@@ -1,3 +1,5 @@
+from typing import Annotated
+
 import pycord
 
 # start the bot with no intents, and with default config
@@ -22,28 +24,31 @@ async def favorite(
     # The name of this option,
     # can be set to anything but
     # try to keep it short
-    anime: str = pycord.Option(
-        # The description for this option,
-        # this is a longer version of name displaying
-        # more detail and technicalities
-        description='Your favorite Anime Show',
-        # this just sets it so the user cannot proceed without
-        # entering this option
-        required=True,
-        # enables autocomplete on Discord's side
-        autocomplete=True,
-        # these are the choices the user can pick.
-        # the first value is the name, which is what
-        # the user will see. The second is the value, which is what
-        # you, or the bot, will see.
-        choices=[
-            pycord.CommandChoice('Attack on Titan'),
-            pycord.CommandChoice("JoJo's Bizzare Adventure"),
-            pycord.CommandChoice('Cowboy Bebop'),
-            pycord.CommandChoice('Hunter x Hunter'),
-            pycord.CommandChoice('Spy x Family'),
-        ],
-    ),
+    anime: Annotated[
+        str,
+        pycord.Option(
+            # The description for this option,
+            # this is a longer version of name displaying
+            # more detail and technicalities
+            description='Your favorite Anime Show',
+            # this just sets it so the user cannot proceed without
+            # entering this option
+            required=True,
+            # enables autocomplete on Discord's side
+            autocomplete=True,
+            # these are the choices the user can pick.
+            # the first value is the name, which is what
+            # the user will see. The second is the value, which is what
+            # you, or the bot, will see.
+            choices=[
+                pycord.CommandChoice('Attack on Titan'),
+                pycord.CommandChoice("JoJo's Bizzare Adventure"),
+                pycord.CommandChoice('Cowboy Bebop'),
+                pycord.CommandChoice('Hunter x Hunter'),
+                pycord.CommandChoice('Spy x Family'),
+            ],
+        ),
+    ],
 ):
     """Pick which one is your favorite anime"""
 

pycord/commands/application/command.py

@@ -22,7 +22,8 @@
 
 import asyncio
 from copy import copy
-from typing import TYPE_CHECKING, Any, Sequence, Union
+from inspect import isclass
+from typing import TYPE_CHECKING, Any, Sequence, Union, get_origin
 
 from ...channel import Channel, identify_channel
 from ...enums import ApplicationCommandOptionType, ApplicationCommandType
@@ -31,17 +32,17 @@
 from ...media import Attachment
 from ...member import Member
 from ...message import Message
+from ...missing import MISSING, MissingEnum
 from ...role import Role
 from ...snowflake import Snowflake
 from ...types import AsyncFunc
 from ...types.interaction import ApplicationCommandData
-from ...missing import MISSING, MissingEnum
 from ...user import User
-from ...utils import get_arg_defaults, remove_undefined
+from ...utils import get_arg_defaults, get_args, remove_undefined
 from ..command import Command
 from ..group import Group
-from .errors import ApplicationCommandException
 from .context import Context
+from .errors import ApplicationCommandException
 
 if TYPE_CHECKING:
     from ...state import State
@@ -195,6 +196,8 @@ def __init__(
         else:
             if choices:
                 self.choices = [choice._to_dict() for choice in choices]
+            else:
+                self.choices = MISSING
         if options is MISSING:
             self.options = []
         else:
@@ -537,28 +540,24 @@ def _parse_arguments(self) -> None:
                 continue
             elif v[1] is Interaction or v[1] is Context:
                 continue
-            elif not isinstance(v[0], Option) and v[0] is not None:
+
+            args = get_args(v[1])
+
+            if not isinstance(args[1], Option):
                 raise ApplicationCommandException(
-                    f'Options may only be of type Option, not {v[0]}'
+                    f'Options may only be of type Option, not {args[1]}'
                 )
 
-            if v[0]:
-                v[0]._param = name
-                v[0].type = _OPTION_BIND[v[1]].value
+            option: Option = args[1]
 
-                if not v[0].name:
-                    v[0].name = name
+            option._param = name
+            option.type = _OPTION_BIND[args[0]].value
 
-                self.options.append(v[0])
-                self._options_dict[v[0].name] = v[0]
-            else:
-                if v[1] is None:
-                    raise
+            if not option.name:
+                option.name = name
 
-                option = Option(name=name, type=v[1])
-                option._param = name
-                self.options.append(option)
-                self._options_dict[name] = option
+            self.options.append(option)
+            self._options_dict[option.name] = option
 
         for option in self.options:
             self._options.append(option.to_dict())

pycord/utils.py

@@ -25,13 +25,13 @@
 import warnings
 from collections.abc import Iterator, Sequence
 from itertools import accumulate
-from typing import Any, AsyncGenerator, Callable, Type, TypeVar
+from typing import Annotated, Any, AsyncGenerator, Callable, Type, TypeVar, get_origin
 
 from aiohttp import ClientResponse
 
 from .file import File
-from .types import AsyncFunc
 from .missing import MISSING
+from .types import AsyncFunc
 
 try:
     import msgspec
@@ -270,3 +270,19 @@ def to_datauri(f: File) -> str:
     b64 = base64.b64encode(b)
 
     return f'data:{m};base64,{b64}'
+
+
+def get_args(annotation: Any) -> tuple[Any, ...]:
+    if get_origin(annotation) is not Annotated:
+        raise ValueError(
+            f'Argument annotation {annotation} must originate from typing.Annotated'
+        )
+
+    anns = annotation.__args__ + annotation.__metadata__
+
+    if len(anns) != 2:
+        raise ValueError(
+            f'Annotation {annotation} must only have two arguments subsequently'
+        )
+
+    return anns