fix: overall type-hinting improvements (#2457)

* fix: RawMemberRemoveEvent type-hinting * Update CHANGELOG.md Signed-off-by: YoggieS <[email protected]> * style(pre-commit): auto fixes from pre-commit.com hooks * Update CHANGELOG.md Co-authored-by: plun1331 <[email protected]> Signed-off-by: YoggieS <[email protected]> * fix: overall type-hinting * style(pre-commit): auto fixes from pre-commit.com hooks * fix: further types lookup & fixes * style(pre-commit): auto fixes from pre-commit.com hooks * Update discord/guild.py Co-authored-by: UK <[email protected]> Signed-off-by: YoggieS <[email protected]> * review suggestions * review suggestions v2 * style(pre-commit): auto fixes from pre-commit.com hooks * review suggestions v3 * update changelog with correct # * nonce typing partial revert * onboarding PromptOption types * Update CHANGELOG.md Co-authored-by: Dorukyum <[email protected]> Signed-off-by: YoggieS <[email protected]> --------- Signed-off-by: YoggieS <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: plun1331 <[email protected]> Co-authored-by: UK <[email protected]> Co-authored-by: Dorukyum <[email protected]>
Pycord-Development · Jun 5, 2024 · 61cc544 · 61cc544
1 parent 9fc3d7b
commit 61cc544
Show file tree

Hide file tree

Showing 27 changed files with 98 additions and 73 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -52,6 +52,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#2448](https://github.com/Pycord-Development/pycord/pull/2448))
 - Fixed missing `application_id` in `Entitlement.delete`.
   ([#2458](https://github.com/Pycord-Development/pycord/pull/2458))
+- Fixed many inaccurate type hints throughout the library.
+  ([#2457](https://github.com/Pycord-Development/pycord/pull/2457))
 
 ### Changed
 

diff --git a/discord/abc.py b/discord/abc.py
@@ -115,7 +115,7 @@ async def _single_delete_strategy(
 
 
 async def _purge_messages_helper(
-    channel: TextChannel | Thread | VoiceChannel,
+    channel: TextChannel | StageChannel | Thread | VoiceChannel,
     *,
     limit: int | None = 100,
     check: Callable[[Message], bool] = MISSING,
@@ -1345,7 +1345,7 @@ async def send(
         file: File = ...,
         stickers: Sequence[GuildSticker | StickerItem] = ...,
         delete_after: float = ...,
-        nonce: str | int = ...,
+        nonce: int | str = ...,
         enforce_nonce: bool = ...,
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
@@ -1365,7 +1365,7 @@ async def send(
         files: list[File] = ...,
         stickers: Sequence[GuildSticker | StickerItem] = ...,
         delete_after: float = ...,
-        nonce: str | int = ...,
+        nonce: int | str = ...,
         enforce_nonce: bool = ...,
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
@@ -1385,7 +1385,7 @@ async def send(
         file: File = ...,
         stickers: Sequence[GuildSticker | StickerItem] = ...,
         delete_after: float = ...,
-        nonce: str | int = ...,
+        nonce: int | str = ...,
         enforce_nonce: bool = ...,
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
@@ -1405,7 +1405,7 @@ async def send(
         files: list[File] = ...,
         stickers: Sequence[GuildSticker | StickerItem] = ...,
         delete_after: float = ...,
-        nonce: str | int = ...,
+        nonce: int | str = ...,
         enforce_nonce: bool = ...,
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
@@ -1465,7 +1465,7 @@ async def send(
             The file to upload.
         files: List[:class:`~discord.File`]
             A list of files to upload. Must be a maximum of 10.
-        nonce: :class:`int`
+        nonce: Union[:class:`str`, :class:`int`]
             The nonce to use for sending this message. If the message was successfully sent,
             then the message will have a nonce with this value.
         enforce_nonce: Optional[:class:`bool`]

diff --git a/discord/audit_logs.py b/discord/audit_logs.py
@@ -193,16 +193,16 @@ def _transform_type(
 
 def _transform_actions(
     entry: AuditLogEntry, data: list[AutoModActionPayload] | None
-) -> AutoModAction | None:
+) -> list[AutoModAction] | None:
     if data is None:
         return None
     else:
         return [AutoModAction.from_dict(d) for d in data]
 
 
 def _transform_trigger_metadata(
-    entry: AuditLogEntry, data: list[AutoModActionPayload] | None
-) -> AutoModAction | None:
+    entry: AuditLogEntry, data: AutoModTriggerMetadataPayload | None
+) -> AutoModTriggerMetadata | None:
     if data is None:
         return None
     else:
@@ -309,7 +309,7 @@ def __init__(
                 "$add_allow_list",
             ]:
                 self._handle_trigger_metadata(
-                    self.before, self.after, entry, elem["new_value"], attr
+                    self.before, self.after, entry, elem["new_value"], attr  # type: ignore
                 )
                 continue
             elif attr in [
@@ -318,7 +318,7 @@ def __init__(
                 "$remove_allow_list",
             ]:
                 self._handle_trigger_metadata(
-                    self.after, self.before, entry, elem["new_value"], attr
+                    self.after, self.before, entry, elem["new_value"], attr  # type: ignore
                 )
                 continue
 

diff --git a/discord/channel.py b/discord/channel.py
@@ -1218,7 +1218,7 @@ async def create_thread(
             A list of stickers to upload. Must be a maximum of 3.
         delete_message_after: :class:`int`
             The time to wait before deleting the thread.
-        nonce: :class:`int`
+        nonce: Union[:class:`str`, :class:`int`]
             The nonce to use for sending this message. If the message was successfully sent,
             then the message will have a nonce with this value.
         allowed_mentions: :class:`~discord.AllowedMentions`

diff --git a/discord/commands/context.py b/discord/commands/context.py
@@ -37,7 +37,7 @@
     import discord
     from .. import Bot
     from ..state import ConnectionState
-    from ..voice_client import VoiceProtocol
+    from ..voice_client import VoiceClient
 
     from .core import ApplicationCommand, Option
     from ..interactions import InteractionChannel
@@ -211,7 +211,7 @@ def user(self) -> Member | User:
     author: Member | User = user
 
     @property
-    def voice_client(self) -> VoiceProtocol | None:
+    def voice_client(self) -> VoiceClient | None:
         """Returns the voice client associated with this context's command.
         Shorthand for :attr:`Interaction.guild.voice_client<~discord.Guild.voice_client>`, if applicable.
         """

diff --git a/discord/commands/core.py b/discord/commands/core.py
@@ -328,7 +328,7 @@ def is_on_cooldown(self, ctx: ApplicationContext) -> bool:
         if not self._buckets.valid:
             return False
 
-        bucket = self._buckets.get_bucket(ctx)
+        bucket = self._buckets.get_bucket(ctx)  # type: ignore
         current = utcnow().timestamp()
         return bucket.get_tokens(current) == 0
 
@@ -363,7 +363,7 @@ def get_cooldown_retry_after(self, ctx: ApplicationContext) -> float:
             If this is ``0.0`` then the command isn't on cooldown.
         """
         if self._buckets.valid:
-            bucket = self._buckets.get_bucket(ctx)
+            bucket = self._buckets.get_bucket(ctx)  # type: ignore
             current = utcnow().timestamp()
             return bucket.get_retry_after(current)
 
@@ -1245,7 +1245,7 @@ def to_dict(self) -> dict:
 
         return as_dict
 
-    def add_command(self, command: SlashCommand) -> None:
+    def add_command(self, command: SlashCommand | SlashCommandGroup) -> None:
         if command.cog is None and self.cog is not None:
             command.cog = self.cog
 

diff --git a/discord/context_managers.py b/discord/context_managers.py
@@ -38,7 +38,7 @@
 __all__ = ("Typing",)
 
 
-def _typing_done_callback(fut: asyncio.Future) -> None:
+def _typing_done_callback(fut: asyncio.Task) -> None:
     # just retrieve any exception and call it a day
     try:
         fut.exception()

diff --git a/discord/ext/commands/converter.py b/discord/ext/commands/converter.py
@@ -1166,7 +1166,7 @@ async def _actual_conversion(
 
 
 async def run_converters(
-    ctx: Context, converter, argument: str, param: inspect.Parameter
+    ctx: Context, converter, argument: str | None, param: inspect.Parameter
 ):
     """|coro|
 
@@ -1182,7 +1182,7 @@ async def run_converters(
         The invocation context to run the converters under.
     converter: Any
         The converter to run, this corresponds to the annotation in the function.
-    argument: :class:`str`
+    argument: Optional[:class:`str`]
         The argument to convert to.
     param: :class:`inspect.Parameter`
         The parameter being converted. This is mainly for error reporting.

diff --git a/discord/ext/commands/help.py b/discord/ext/commands/help.py
@@ -90,7 +90,13 @@ class Paginator:
             .. versionadded:: 1.7
     """
 
-    def __init__(self, prefix="```", suffix="```", max_size=2000, linesep="\n"):
+    def __init__(
+        self,
+        prefix: str | None = "```",
+        suffix: str | None = "```",
+        max_size: int = 2000,
+        linesep: str = "\n",
+    ):
         self.prefix = prefix
         self.suffix = suffix
         self.max_size = max_size

diff --git a/discord/guild.py b/discord/guild.py
@@ -107,7 +107,7 @@
     from .types.member import Member as MemberPayload
     from .types.threads import Thread as ThreadPayload
     from .types.voice import GuildVoiceState
-    from .voice_client import VoiceProtocol
+    from .voice_client import VoiceClient
     from .webhook import Webhook
 
     VocalGuildChannel = Union[VoiceChannel, StageChannel]
@@ -647,8 +647,8 @@ def me(self) -> Member:
         return self.get_member(self_id)  # type: ignore
 
     @property
-    def voice_client(self) -> VoiceProtocol | None:
-        """Returns the :class:`VoiceProtocol` associated with this guild, if any."""
+    def voice_client(self) -> VoiceClient | None:
+        """Returns the :class:`VoiceClient` associated with this guild, if any."""
         return self._state._get_voice_client(self.id)
 
     @property
@@ -3121,7 +3121,7 @@ async def bulk_ban(
         *users: Snowflake,
         delete_message_seconds: int | None = None,
         reason: str | None = None,
-    ) -> list[list[Snowflake], list[Snowflake]]:
+    ) -> tuple[list[Snowflake], list[Snowflake]]:
         r"""|coro|
 
         Bulk ban users from the guild.
@@ -3152,7 +3152,7 @@ async def bulk_ban(
 
         Returns
         -------
-        List[List[:class:`abc.Snowflake`], List[:class:`abc.Snowflake`]]
+        Tuple[List[:class:`abc.Snowflake`], List[:class:`abc.Snowflake`]]
             Returns two lists: the first contains members that were successfully banned, while the second is members that could not be banned.
 
         Raises

diff --git a/discord/http.py b/discord/http.py
@@ -464,7 +464,7 @@ def send_message(
         tts: bool = False,
         embed: embed.Embed | None = None,
         embeds: list[embed.Embed] | None = None,
-        nonce: str | None = None,
+        nonce: int | str | None = None,
         enforce_nonce: bool | None = None,
         allowed_mentions: message.AllowedMentions | None = None,
         message_reference: message.MessageReference | None = None,
@@ -524,7 +524,7 @@ def send_multipart_helper(
         tts: bool = False,
         embed: embed.Embed | None = None,
         embeds: Iterable[embed.Embed | None] | None = None,
-        nonce: str | None = None,
+        nonce: int | str | None = None,
         enforce_nonce: bool | None = None,
         allowed_mentions: message.AllowedMentions | None = None,
         message_reference: message.MessageReference | None = None,
@@ -587,7 +587,7 @@ def send_files(
         tts: bool = False,
         embed: embed.Embed | None = None,
         embeds: list[embed.Embed] | None = None,
-        nonce: str | None = None,
+        nonce: int | str | None = None,
         enforce_nonce: bool | None = None,
         allowed_mentions: message.AllowedMentions | None = None,
         message_reference: message.MessageReference | None = None,
@@ -1203,7 +1203,7 @@ def start_forum_thread(
         files: Sequence[File] | None = None,
         embed: embed.Embed | None = None,
         embeds: list[embed.Embed] | None = None,
-        nonce: str | None = None,
+        nonce: int | str | None = None,
         allowed_mentions: message.AllowedMentions | None = None,
         stickers: list[sticker.StickerItem] | None = None,
         components: list[components.Component] | None = None,
@@ -2151,8 +2151,8 @@ def edit_channel_permissions(
         self,
         channel_id: Snowflake,
         target: Snowflake,
-        allow: str,
-        deny: str,
+        allow: int | str,
+        deny: int | str,
         type: channel.OverwriteType,
         *,
         reason: str | None = None,

diff --git a/discord/interactions.py b/discord/interactions.py
@@ -1221,7 +1221,7 @@ async def premium_required(self) -> Interaction:
         self._responded = True
         return self._parent
 
-    async def _locked_response(self, coro: Coroutine[Any]):
+    async def _locked_response(self, coro: Coroutine[Any, Any, Any]) -> None:
         """|coro|
 
         Wraps a response and makes sure that it's locked while executing.

diff --git a/discord/invite.py b/discord/invite.py
@@ -49,6 +49,7 @@
     from .types.invite import GatewayInvite as GatewayInvitePayload
     from .types.invite import Invite as InvitePayload
     from .types.invite import InviteGuild as InviteGuildPayload
+    from .types.invite import VanityInvite as VanityInvitePayload
     from .types.scheduled_events import ScheduledEvent as ScheduledEventPayload
     from .user import User
 
@@ -353,7 +354,7 @@ def __init__(
         self,
         *,
         state: ConnectionState,
-        data: InvitePayload,
+        data: InvitePayload | VanityInvitePayload,
         guild: PartialInviteGuild | Guild | None = None,
         channel: PartialInviteChannel | GuildChannel | None = None,
     ):

diff --git a/discord/member.py b/discord/member.py
@@ -62,6 +62,7 @@
     from .types.member import MemberWithUser as MemberWithUserPayload
     from .types.member import UserWithMember as UserWithMemberPayload
     from .types.user import User as UserPayload
+    from .types.voice import GuildVoiceState as GuildVoiceStatePayload
     from .types.voice import VoiceState as VoiceStatePayload
 
     VocalGuildChannel = Union[VoiceChannel, StageChannel]
@@ -125,12 +126,19 @@ class VoiceState:
     )
 
     def __init__(
-        self, *, data: VoiceStatePayload, channel: VocalGuildChannel | None = None
+        self,
+        *,
+        data: VoiceStatePayload | GuildVoiceStatePayload,
+        channel: VocalGuildChannel | None = None,
     ):
         self.session_id: str = data.get("session_id")
         self._update(data, channel)
 
-    def _update(self, data: VoiceStatePayload, channel: VocalGuildChannel | None):
+    def _update(
+        self,
+        data: VoiceStatePayload | GuildVoiceStatePayload,
+        channel: VocalGuildChannel | None,
+    ):
         self.self_mute: bool = data.get("self_mute", False)
         self.self_deaf: bool = data.get("self_deaf", False)
         self.self_stream: bool = data.get("self_stream", False)

diff --git a/discord/message.py b/discord/message.py
@@ -240,14 +240,14 @@ def __init__(self, *, data: AttachmentPayload, state: ConnectionState):
                     setattr(self, attr, value)
 
     @property
-    def expires_at(self) -> datetime.datetime:
+    def expires_at(self) -> datetime.datetime | None:
         """This attachment URL's expiry time in UTC."""
         if not self._ex:
             return None
         return datetime.datetime.utcfromtimestamp(int(self._ex, 16))
 
     @property
-    def issued_at(self) -> datetime.datetime:
+    def issued_at(self) -> datetime.datetime | None:
         """The attachment URL's issue time in UTC."""
         if not self._is:
             return None

diff --git a/discord/partial_emoji.py b/discord/partial_emoji.py
@@ -100,7 +100,9 @@ class PartialEmoji(_EmojiTag, AssetMixin):
     if TYPE_CHECKING:
         id: int | None
 
-    def __init__(self, *, name: str, animated: bool = False, id: int | None = None):
+    def __init__(
+        self, *, name: str | None, animated: bool = False, id: int | None = None
+    ):
         self.animated = animated
         self.name = name
         self.id = id

diff --git a/discord/raw_models.py b/discord/raw_models.py
@@ -30,7 +30,6 @@
 
 from .automod import AutoModAction, AutoModTriggerType
 from .enums import AuditLogAction, ChannelType, ReactionType, try_enum
-from .types.user import User
 
 if TYPE_CHECKING:
     from .abc import MessageableChannel
@@ -58,6 +57,7 @@
         TypingEvent,
         VoiceChannelStatusUpdateEvent,
     )
+    from .user import User
 
 
 __all__ = (

diff --git a/discord/reaction.py b/discord/reaction.py
@@ -111,7 +111,7 @@ def __init__(
         self.me: bool = data.get("me")
         self.burst: bool = data.get("burst")
         self.me_burst: bool = data.get("me_burst")
-        self._burst_colours: list[Colour] = data.get("burst_colors", [])
+        self._burst_colours: list[str] = data.get("burst_colors", [])
 
     @property
     def burst_colours(self) -> list[Colour]: