refactor(types): make VoiceRegion a dataclass

Author: vmphase

discord/guild.py

@@ -91,6 +91,7 @@
 from .stage_instance import StageInstance
 from .sticker import GuildSticker
 from .threads import Thread, ThreadMember
+from .types.voice import VoiceRegion as VoiceRegionData
 from .user import User
 from .utils import _D, _FETCHABLE
 from .welcome_screen import WelcomeScreen, WelcomeScreenChannel
@@ -121,7 +122,6 @@
     from .types.guild import ModifyIncidents as ModifyIncidentsPayload
     from .types.member import Member as MemberPayload
     from .types.threads import Thread as ThreadPayload
-    from .types.voice import VoiceRegion as VoiceRegionPayload
     from .types.voice import VoiceState as GuildVoiceState
     from .voice import VoiceClient
     from .webhook import Webhook
@@ -3797,7 +3797,7 @@ async def vanity_invite(self) -> Invite | None:
         payload["uses"] = payload.get("uses", 0)
         return Invite(state=self._state, data=payload, guild=self, channel=channel)
 
-    async def fetch_voice_regions(self) -> list[VoiceRegionPayload]:
+    async def fetch_voice_regions(self) -> list[VoiceRegionData]:
         """|coro|
 
         Retrieves the voice regions that the guild has access to.
@@ -3806,19 +3806,18 @@ async def fetch_voice_regions(self) -> list[VoiceRegionPayload]:
         recommended way to get the currently available regions.
         .. versionadded:: 2.9
 
-        Each payload is a :class:`~discord.types.voice.VoiceRegion` TypedDict
-        with the following keys:
+        Each :class:`~discord.types.voice.VoiceRegion` has the following attributes:
 
-        ``id``
+        :attr:`~discord.types.voice.VoiceRegion.id`
             The region ID, e.g. ``"us-west"``. Use this as the
             :attr:`~discord.VoiceChannel.rtc_region` of a voice channel.
-        ``name``
+        :attr:`~discord.types.voice.VoiceRegion.name`
             The region's display name, e.g. ``"US West"``.
-        ``optimal``
+        :attr:`~discord.types.voice.VoiceRegion.optimal`
             Whether the region is optimal for the guild's members.
-        ``deprecated``
+        :attr:`~discord.types.voice.VoiceRegion.deprecated`
             Whether the region is deprecated.
-        ``custom``
+        :attr:`~discord.types.voice.VoiceRegion.custom`
             Whether the region is a custom region.
 
         Returns
@@ -3831,7 +3830,8 @@ async def fetch_voice_regions(self) -> list[VoiceRegionPayload]:
         HTTPException
             Retrieving the voice regions failed.
         """
-        return await self._state.http.get_guild_voice_regions(self.id)
+        regions = await self._state.http.get_guild_voice_regions(self.id)
+        return [VoiceRegionData(**region) for region in regions]
 
     # TODO: use MISSING when async iterators get refactored
     def audit_logs(

discord/http.py

@@ -1045,13 +1045,14 @@ def guild_voice_state(
         return self.request(r, json=payload, reason=reason)
 
     def get_guild_voice_regions(
-        self, guild_id: Snowflake
-    ) -> Response[list[voice.VoiceRegion]]:
+        self,
+        guild_id: Snowflake,
+    ) -> Response[list[voice.VoiceRegionPayload]]:
         return self.request(
             Route("GET", "/guilds/{guild_id}/regions", guild_id=guild_id)
         )
 
-    def get_voice_regions(self) -> Response[list[voice.VoiceRegion]]:
+    def get_voice_regions(self) -> Response[list[voice.VoiceRegionPayload]]:
         return self.request(Route("GET", "/voice/regions"))
 
     def edit_profile(self, payload: dict[str, Any]) -> Response[user.User]:

discord/types/voice.py

@@ -25,6 +25,7 @@
 
 from __future__ import annotations
 
+from dataclasses import dataclass
 from typing import Literal
 
 from typing_extensions import NotRequired, TypedDict
@@ -59,7 +60,22 @@ class VoiceState(TypedDict):
 GuildVoiceState = VoiceState
 
 
-class VoiceRegion(TypedDict):
+class VoiceRegionPayload(TypedDict):
+    id: str
+    name: str
+    vip: bool
+    optimal: bool
+    deprecated: bool
+    custom: bool
+
+
+@dataclass(frozen=True, slots=True)
+class VoiceRegion:
+    """Represents a voice region a guild can use for voice channels.
+
+    This is returned by :meth:`Guild.fetch_voice_regions`.
+    """
+
     id: str
     name: str
     vip: bool