chore(typing): enable ruff ANN2, add more typehints from pyrefly infer (#1329)

Signed-off-by: arielle <[email protected]>
Co-authored-by: vi <[email protected]>

Author: onerandomusername

changelog/1329.misc.rst

@@ -0,0 +1 @@
+Add more typing to most modules, increasing type completeness.

disnake/__main__.py

@@ -5,15 +5,15 @@
 import platform
 import sys
 from pathlib import Path
-from typing import Union
+from typing import List, Tuple, Union
 
 import aiohttp
 
 import disnake
 
 
 def show_version() -> None:
-    entries = []
+    entries: List[str] = []
 
     sys_ver = sys.version_info
     entries.append(
@@ -232,7 +232,7 @@ async def cog_after_user_command_invoke(self, inter):
 _translation_table = str.maketrans(_base_table)
 
 
-def to_path(parser, name: Union[str, Path], *, replace_spaces: bool = False):
+def to_path(parser, name: Union[str, Path], *, replace_spaces: bool = False) -> Path:
     if isinstance(name, Path):
         return name
 
@@ -399,7 +399,7 @@ def add_newcog_args(subparser) -> None:
     parser.add_argument("--full", help="add all special methods as well", action="store_true")
 
 
-def parse_args():
+def parse_args() -> Tuple[argparse.ArgumentParser, argparse.Namespace]:
     parser = argparse.ArgumentParser(prog="disnake", description="Tools for helping with disnake")
     parser.add_argument("-v", "--version", action="store_true", help="shows the library version")
     parser.set_defaults(func=core)

disnake/abc.py

@@ -83,6 +83,7 @@
         OverwriteType,
         PermissionOverwrite as PermissionOverwritePayload,
     )
+    from .types.guild import ChannelPositionUpdate as ChannelPositionUpdatePayload
     from .types.threads import PartialForumTag as PartialForumTagPayload
     from .ui._types import MessageComponents
     from .ui.view import View
@@ -312,9 +313,9 @@ async def _move(
             # add ourselves at our designated position
             channels.insert(index, self)
 
-        payload = []
+        payload: List[ChannelPositionUpdatePayload] = []
         for index, c in enumerate(channels):
-            d: Dict[str, Any] = {"id": c.id, "position": index}
+            d: ChannelPositionUpdatePayload = {"id": c.id, "position": index}
             if parent_id is not MISSING and c.id == self.id:
                 d.update(parent_id=parent_id, lock_permissions=lock_permissions)
             payload.append(d)
@@ -508,7 +509,7 @@ def changed_roles(self) -> List[Role]:
         """List[:class:`.Role`]: Returns a list of roles that have been overridden from
         their default values in the :attr:`.Guild.roles` attribute.
         """
-        ret = []
+        ret: List[Role] = []
         g = self.guild
         for overwrite in filter(lambda o: o.is_role(), self._overwrites):
             role = g.get_role(overwrite.id)
@@ -1272,11 +1273,11 @@ async def move(self, **kwargs: Any) -> None:
             raise ValueError("Could not resolve appropriate move position")
 
         channels.insert(max((index + offset), 0), self)
-        payload = []
+        payload: List[ChannelPositionUpdatePayload] = []
         lock_permissions = kwargs.get("sync_permissions", False)
         reason = kwargs.get("reason")
         for index, channel in enumerate(channels):
-            d = {"id": channel.id, "position": index}
+            d: ChannelPositionUpdatePayload = {"id": channel.id, "position": index}
             if parent_id is not MISSING and channel.id == self.id:
                 d.update(parent_id=parent_id, lock_permissions=lock_permissions)
             payload.append(d)

disnake/activity.py

@@ -607,7 +607,7 @@ def __repr__(self) -> str:
         return f"<Streaming name={self.name!r}>"
 
     @property
-    def twitch_name(self):
+    def twitch_name(self) -> Optional[str]:
         """Optional[:class:`str`]: If provided, the twitch name of the user streaming.
 
         This corresponds to the ``large_image`` key of the :attr:`Streaming.assets`

disnake/app_commands.py

@@ -1250,7 +1250,7 @@ def __init__(self, *, data: ApplicationCommandPermissionsPayload, guild_id: int)
     def __repr__(self) -> str:
         return f"<ApplicationCommandPermissions id={self.id!r} type={self.type!r} permission={self.permission!r}>"
 
-    def __eq__(self, other):
+    def __eq__(self, other) -> bool:
         return (
             self.id == other.id and self.type == other.type and self.permission == other.permission
         )

disnake/audit_logs.py

@@ -118,8 +118,8 @@ def _transform_guild_id(entry: AuditLogEntry, data: Optional[Snowflake]) -> Opti
 
 def _transform_overwrites(
     entry: AuditLogEntry, data: List[PermissionOverwritePayload]
-) -> List[Tuple[Object, PermissionOverwrite]]:
-    overwrites = []
+) -> List[Tuple[Union[Object, Member, Role, User], PermissionOverwrite]]:
+    overwrites: List[Tuple[Union[Object, Member, Role, User], PermissionOverwrite]] = []
     for elem in data:
         allow = Permissions(int(elem["allow"]))
         deny = Permissions(int(elem["deny"]))

disnake/channel.py

@@ -306,7 +306,7 @@ def _update(self, guild: Guild, data: TextChannelPayload) -> None:
         )
         self._fill_overwrites(data)
 
-    async def _get_channel(self):
+    async def _get_channel(self) -> Self:
         return self
 
     @property
@@ -1227,7 +1227,7 @@ def members(self) -> List[Member]:
         if isinstance(self.guild, Object):
             return []
 
-        ret = []
+        ret: List[Member] = []
         for user_id, state in self.guild._voice_states.items():
             if state.channel and state.channel.id == self.id:
                 member = self.guild.get_member(user_id)
@@ -1392,7 +1392,7 @@ def _update(self, guild: Guild, data: VoiceChannelPayload) -> None:
         self.slowmode_delay: int = data.get("rate_limit_per_user", 0)
         self.last_message_id: Optional[int] = utils._get_as_snowflake(data, "last_message_id")
 
-    async def _get_channel(self):
+    async def _get_channel(self: Self) -> Self:
         return self
 
     @property
@@ -2079,7 +2079,7 @@ def _update(self, guild: Guild, data: StageChannelPayload) -> None:
         self.slowmode_delay: int = data.get("rate_limit_per_user", 0)
         self.last_message_id: Optional[int] = utils._get_as_snowflake(data, "last_message_id")
 
-    async def _get_channel(self):
+    async def _get_channel(self) -> Self:
         return self
 
     @property
@@ -3108,7 +3108,7 @@ def channels(self) -> List[GuildChannelType]:
         if isinstance(self.guild, Object):
             return []
 
-        def comparator(channel):
+        def comparator(channel: GuildChannelType) -> Tuple[bool, int]:
             return (
                 not isinstance(channel, (TextChannel, ThreadOnlyGuildChannel)),
                 channel.position,
@@ -4789,7 +4789,7 @@ def __init__(self, *, me: ClientUser, state: ConnectionState, data: DMChannelPay
         )
         self._flags: int = data.get("flags", 0)
 
-    async def _get_channel(self):
+    async def _get_channel(self) -> Self:
         return self
 
     def __str__(self) -> str:
@@ -4962,7 +4962,7 @@ def _update_group(self, data: GroupChannelPayload) -> None:
         else:
             self.owner = utils.find(lambda u: u.id == self.owner_id, self.recipients)
 
-    async def _get_channel(self):
+    async def _get_channel(self) -> Self:
         return self
 
     def __str__(self) -> str:
@@ -5133,7 +5133,9 @@ def get_partial_message(self, message_id: int, /) -> PartialMessage:
         return PartialMessage(channel=self, id=message_id)
 
 
-def _guild_channel_factory(channel_type: int):
+def _guild_channel_factory(
+    channel_type: int,
+) -> Tuple[Optional[Type[GuildChannelType]], ChannelType]:
     value = try_enum(ChannelType, channel_type)
     if value is ChannelType.text:
         return TextChannel, value
@@ -5153,7 +5155,11 @@ def _guild_channel_factory(channel_type: int):
         return None, value
 
 
-def _channel_factory(channel_type: int):
+def _channel_factory(
+    channel_type: int,
+) -> Tuple[
+    Optional[Union[Type[GuildChannelType], Type[DMChannel], Type[GroupChannel]]], ChannelType
+]:
     cls, value = _guild_channel_factory(channel_type)
     if value is ChannelType.private:
         return DMChannel, value
@@ -5163,14 +5169,21 @@ def _channel_factory(channel_type: int):
         return cls, value
 
 
-def _threaded_channel_factory(channel_type: int):
+def _threaded_channel_factory(
+    channel_type: int,
+) -> Tuple[
+    Optional[Union[Type[GuildChannelType], Type[DMChannel], Type[GroupChannel], Type[Thread]]],
+    ChannelType,
+]:
     cls, value = _channel_factory(channel_type)
     if value in (ChannelType.private_thread, ChannelType.public_thread, ChannelType.news_thread):
         return Thread, value
     return cls, value
 
 
-def _threaded_guild_channel_factory(channel_type: int):
+def _threaded_guild_channel_factory(
+    channel_type: int,
+) -> Tuple[Optional[Union[Type[GuildChannelType], Type[Thread]]], ChannelType]:
     cls, value = _guild_channel_factory(channel_type)
     if value in (ChannelType.private_thread, ChannelType.public_thread, ChannelType.news_thread):
         return Thread, value

disnake/client.py

@@ -1347,7 +1347,7 @@ def activity(self, value: Optional[ActivityTypes]) -> None:
             raise TypeError("activity must derive from BaseActivity.")
 
     @property
-    def status(self):
+    def status(self) -> Status:
         """:class:`.Status`: The status being used upon logging on to Discord.
 
         .. versionadded:: 2.0

disnake/embeds.py

@@ -834,7 +834,7 @@ def to_dict(self) -> EmbedData:
         return result
 
     @classmethod
-    def set_default_colour(cls, value: Optional[Union[int, Colour]]):
+    def set_default_colour(cls, value: Optional[Union[int, Colour]]) -> Optional[Colour]:
         """Set the default colour of all new embeds.
 
         .. versionadded:: 2.4

disnake/enums.py

@@ -81,6 +81,8 @@
     "NameplatePalette",
 )
 
+EnumMetaT = TypeVar("EnumMetaT", bound="Type[EnumMeta]")
+
 
 class _EnumValueBase(NamedTuple):
     if TYPE_CHECKING:
@@ -110,7 +112,7 @@ def _create_value_cls(name: str, comparable: bool) -> Type[_EnumValueBase]:
     return type(f"{parent.__name__}_{name}", (parent,), {"_cls_name": name})  # type: ignore
 
 
-def _is_descriptor(obj):
+def _is_descriptor(obj) -> bool:
     return hasattr(obj, "__get__") or hasattr(obj, "__set__") or hasattr(obj, "__delete__")
 
 
@@ -122,7 +124,7 @@ class EnumMeta(type):
         _enum_value_map_: ClassVar[Dict[Any, Any]]
         _enum_value_cls_: ClassVar[Type[_EnumValueBase]]
 
-    def __new__(cls, name: str, bases, attrs, *, comparable: bool = False):
+    def __new__(cls: EnumMetaT, name: str, bases, attrs, *, comparable: bool = False) -> EnumMetaT:
         value_mapping = {}
         member_mapping = {}
         member_names = []
@@ -176,16 +178,16 @@ def __repr__(cls) -> str:
     def __members__(cls):
         return types.MappingProxyType(cls._enum_member_map_)
 
-    def __call__(cls, value):
+    def __call__(cls, value: Any) -> Any:
         try:
             return cls._enum_value_map_[value]
         except (KeyError, TypeError):
             raise ValueError(f"{value!r} is not a valid {cls.__name__}") from None
 
-    def __getitem__(cls, key):
+    def __getitem__(cls, key: str) -> Any:
         return cls._enum_member_map_[key]
 
-    def __setattr__(cls, name: str, value) -> NoReturn:
+    def __setattr__(cls, name: str, value: Any) -> NoReturn:
         raise TypeError("Enums are immutable.")
 
     def __delattr__(cls, attr) -> NoReturn:
@@ -206,7 +208,7 @@ def __instancecheck__(self, instance) -> bool:
 
     class Enum(metaclass=EnumMeta):
         @classmethod
-        def try_value(cls, value):
+        def try_value(cls, value: Any) -> Self:
             try:
                 return cls._enum_value_map_[value]
             except (KeyError, TypeError):