refactor(enums)!: performance and functional improvements

changelog/248.breaking.rst

@@ -0,0 +1,5 @@
+Rework :class:`disnake.enums.Enum` internals.
+- Adds support for typed enums, removes support for untyped enums.
+- Small performance increase by skipping removing the need for ``.value``.
+- Closer to the vanilla python Enum api.
+- Adds in-code documentation for all existin enums.

disnake/activity.py

@@ -416,11 +416,7 @@ def to_dict(self) -> Dict[str, Any]:
         if self._end:
             timestamps["end"] = self._end
 
-        return {
-            "type": ActivityType.playing.value,
-            "name": str(self.name),
-            "timestamps": timestamps,
-        }
+        return {"type": ActivityType.playing, "name": str(self.name), "timestamps": timestamps}
 
     def __eq__(self, other: Any) -> bool:
         return isinstance(other, Game) and other.name == self.name
@@ -518,7 +514,7 @@ def twitch_name(self):
 
     def to_dict(self) -> Dict[str, Any]:
         ret: Dict[str, Any] = {
-            "type": ActivityType.streaming.value,
+            "type": ActivityType.streaming,
             "name": str(self.name),
             "url": str(self.url),
             "assets": self.assets,
@@ -795,13 +791,13 @@ def to_dict(self) -> Dict[str, Any]:
         o: Dict[str, Any]
         if self.name == self.state:
             o = {
-                "type": ActivityType.custom.value,
+                "type": ActivityType.custom,
                 "state": self.name,
                 "name": "Custom Status",
             }
         else:
             o = {
-                "type": ActivityType.custom.value,
+                "type": ActivityType.custom,
                 "name": self.name,
             }
 

disnake/app_commands.py

@@ -678,7 +678,7 @@ class APIUserCommand(UserCommand, _APIApplicationCommandMixin):
     @classmethod
     def from_dict(cls, data: ApplicationCommandPayload) -> Self:
         cmd_type = data.get("type", 0)
-        if cmd_type != ApplicationCommandType.user.value:
+        if cmd_type != ApplicationCommandType.user:
             raise ValueError(f"Invalid payload type for UserCommand: {cmd_type}")
 
         self = cls(
@@ -775,7 +775,7 @@ class APIMessageCommand(MessageCommand, _APIApplicationCommandMixin):
     @classmethod
     def from_dict(cls, data: ApplicationCommandPayload) -> Self:
         cmd_type = data.get("type", 0)
-        if cmd_type != ApplicationCommandType.message.value:
+        if cmd_type != ApplicationCommandType.message:
             raise ValueError(f"Invalid payload type for MessageCommand: {cmd_type}")
 
         self = cls(
@@ -968,7 +968,7 @@ class APISlashCommand(SlashCommand, _APIApplicationCommandMixin):
     @classmethod
     def from_dict(cls, data: ApplicationCommandPayload) -> Self:
         cmd_type = data.get("type", 0)
-        if cmd_type != ApplicationCommandType.chat_input.value:
+        if cmd_type != ApplicationCommandType.chat_input:
             raise ValueError(f"Invalid payload type for SlashCommand: {cmd_type}")
 
         self = cls(

disnake/channel.py

@@ -240,13 +240,13 @@ def type(self) -> Literal[ChannelType.text, ChannelType.news]:
 
         This always returns :attr:`ChannelType.text` or :attr:`ChannelType.news`.
         """
-        if self._type == ChannelType.text.value:
+        if self._type == ChannelType.text:  # pyright: ignore[reportUnnecessaryComparison]
             return ChannelType.text
         return ChannelType.news
 
     @property
     def _sorting_bucket(self) -> int:
-        return ChannelType.text.value
+        return ChannelType.text
 
     @utils.copy_doc(disnake.abc.GuildChannel.permissions_for)
     def permissions_for(
@@ -288,7 +288,7 @@ def is_news(self) -> bool:
 
         :return type: :class:`bool`
         """
-        return self._type == ChannelType.news.value
+        return self._type == ChannelType.news  # pyright: ignore[reportUnnecessaryComparison]
 
     @property
     def last_message(self) -> Optional[Message]:
@@ -1035,7 +1035,7 @@ def _update(self, guild: Guild, data: Union[VoiceChannelPayload, StageChannelPay
 
     @property
     def _sorting_bucket(self) -> int:
-        return ChannelType.voice.value
+        return ChannelType.voice
 
     @property
     def members(self) -> List[Member]:
@@ -2127,7 +2127,7 @@ def _update(self, guild: Guild, data: CategoryChannelPayload) -> None:
 
     @property
     def _sorting_bucket(self) -> int:
-        return ChannelType.category.value
+        return ChannelType.category
 
     @property
     def type(self) -> Literal[ChannelType.category]:
@@ -2557,7 +2557,7 @@ def type(self) -> Literal[ChannelType.forum]:
 
     @property
     def _sorting_bucket(self) -> int:
-        return ChannelType.text.value
+        return ChannelType.text
 
     @utils.copy_doc(disnake.abc.GuildChannel.permissions_for)
     def permissions_for(
@@ -2996,7 +2996,7 @@ async def create_thread(
                 name=name,
                 auto_archive_duration=auto_archive_duration or self.default_auto_archive_duration,
                 rate_limit_per_user=slowmode_delay or 0,
-                type=ChannelType.public_thread.value,
+                type=ChannelType.public_thread,
                 files=params.files,
                 flags=flags,
                 reason=reason,

disnake/components.py

@@ -452,7 +452,7 @@ class TextInput(Component):
     __repr_info__: ClassVar[Tuple[str, ...]] = __slots__
 
     def __init__(self, data: TextInputPayload) -> None:
-        style = data.get("style", TextInputStyle.short.value)
+        style = data.get("style", TextInputStyle.short)
 
         self.type: ComponentType = try_enum(ComponentType, data["type"])
         self.custom_id: str = data["custom_id"]