refactor: events guild_ban_add, guild_ban_remove, guild_role_create, guild_role_update, guild_role_delete

Author: Soheab

discord/app/state.py

@@ -548,73 +548,6 @@ def parse_guild_audit_log_entry_create(self, data) -> None:
             entry = AuditLogEntry(users={data["user_id"]: user}, data=data, guild=guild)
             self.dispatch("audit_log_entry", entry)
 
-    def parse_guild_ban_add(self, data) -> None:
-        # we make the assumption that GUILD_BAN_ADD is done
-        # before GUILD_MEMBER_REMOVE is called
-        # hence we don't remove it from cache or do anything
-        # strange with it, the main purpose of this event
-        # is mainly to dispatch to another event worth listening to for logging
-        guild = self._get_guild(int(data["guild_id"]))
-        if guild is not None:
-            try:
-                user = User(data=data["user"], state=self)
-            except KeyError:
-                pass
-            else:
-                member = guild.get_member(user.id) or user
-                self.dispatch("member_ban", guild, member)
-
-    def parse_guild_ban_remove(self, data) -> None:
-        guild = self._get_guild(int(data["guild_id"]))
-        if guild is not None and "user" in data:
-            user = self.store_user(data["user"])
-            self.dispatch("member_unban", guild, user)
-
-    def parse_guild_role_create(self, data) -> None:
-        guild = self._get_guild(int(data["guild_id"]))
-        if guild is None:
-            _log.debug(
-                "GUILD_ROLE_CREATE referencing an unknown guild ID: %s. Discarding.",
-                data["guild_id"],
-            )
-            return
-
-        role_data = data["role"]
-        role = Role(guild=guild, data=role_data, state=self)
-        guild._add_role(role)
-        self.dispatch("guild_role_create", role)
-
-    def parse_guild_role_delete(self, data) -> None:
-        guild = self._get_guild(int(data["guild_id"]))
-        if guild is not None:
-            role_id = int(data["role_id"])
-            try:
-                role = guild._remove_role(role_id)
-            except KeyError:
-                return
-            else:
-                self.dispatch("guild_role_delete", role)
-        else:
-            _log.debug(
-                "GUILD_ROLE_DELETE referencing an unknown guild ID: %s. Discarding.",
-                data["guild_id"],
-            )
-
-    def parse_guild_role_update(self, data) -> None:
-        guild = self._get_guild(int(data["guild_id"]))
-        if guild is not None:
-            role_data = data["role"]
-            role_id = int(role_data["id"])
-            role = guild.get_role(role_id)
-            if role is not None:
-                old_role = copy.copy(role)
-                role._update(role_data)
-                self.dispatch("guild_role_update", old_role, role)
-        else:
-            _log.debug(
-                "GUILD_ROLE_UPDATE referencing an unknown guild ID: %s. Discarding.",
-                data["guild_id"],
-            )
 
     def parse_guild_members_chunk(self, data) -> None:
         guild_id = int(data["guild_id"])

discord/events/guild.py

@@ -25,7 +25,8 @@
 import asyncio
 import copy
 import logging
-from typing import Any, Self
+from typing import TYPE_CHECKING, Any, Self
+from discord import Role
 from discord.app.event_emitter import Event
 from discord.app.state import ConnectionState
 from discord.emoji import Emoji
@@ -34,8 +35,12 @@
 from discord.raw_models import RawMemberRemoveEvent
 from discord.sticker import Sticker
 
+if TYPE_CHECKING:
+    from ..types.member import MemberWithUser
+
 _log = logging.getLogger(__name__)
 
+
 class GuildMemberJoin(Event, Member):
     __event_name__ = "GUILD_MEMBER_JOIN"
 
@@ -62,6 +67,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
         self.__dict__.update(member.__dict__)
         return self
 
+
 class GuildMemberRemove(Event, Member):
     __event_name__ = "GUILD_MEMBER_REMOVE"
 
@@ -90,6 +96,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
                 data["guild_id"],
             )
 
+
 class GuildMemberUpdate(Event, Member):
     __event_name__ = "GUILD_MEMBER_UPDATE"
 
@@ -136,6 +143,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
                 user_id,
             )
 
+
 class GuildEmojisUpdate(Event):
     __event_name__ = "GUILD_EMOJIS_UPDATE"
     guild: Guild
@@ -165,6 +173,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
         self.old_emojis = guild.emojis
         self.emojis = emojis
 
+
 class GuildStickersUpdate(Event):
     __event_name__ = "GUILD_STICKERS_UPDATE"
 
@@ -177,7 +186,9 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
         guild = await state._get_guild(int(data["guild_id"]))
         if guild is None:
             _log.debug(
-                ("GUILD_STICKERS_UPDATE referencing an unknown guild ID: %s. Discarding."),
+                (
+                    "GUILD_STICKERS_UPDATE referencing an unknown guild ID: %s. Discarding."
+                ),
                 data["guild_id"],
             )
             return
@@ -195,6 +206,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
         self.stickers = stickers
         self.guild = guild
 
+
 class GuildAvailable(Event, Guild):
     __event_name__ = "GUILD_AVAILABLE"
 
@@ -206,6 +218,7 @@ async def __load__(cls, data: Guild, _: ConnectionState) -> Self:
         self.__dict__.update(data.__dict__)
         return self
 
+
 class GuildUnavailable(Event, Guild):
     __event_name__ = "GUILD_UNAVAILABLE"
 
@@ -217,6 +230,7 @@ async def __load__(cls, data: Guild, _: ConnectionState) -> Self:
         self.__dict__.update(data.__dict__)
         return self
 
+
 class GuildJoin(Event, Guild):
     __event_name__ = "GUILD_JOIN"
 
@@ -228,6 +242,7 @@ async def __load__(cls, data: Guild, _: ConnectionState) -> Self:
         self.__dict__.update(data.__dict__)
         return self
 
+
 class GuildCreate(Event, Guild):
     __event_name__ = "GUILD_CREATE"
 
@@ -244,7 +259,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
 
         try:
             # Notify the on_ready state, if any, that this guild is complete.
-            state._ready_state.put_nowait(guild) # type: ignore
+            state._ready_state.put_nowait(guild)  # type: ignore
         except AttributeError:
             pass
         else:
@@ -266,6 +281,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
         self.__dict__.update(data.__dict__)
         return self
 
+
 class GuildUpdate(Event, Guild):
     __event_name__ = "GUILD_UPDATE"
 
@@ -289,6 +305,7 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
                 data["id"],
             )
 
+
 class GuildDelete(Event, Guild):
     __event_name__ = "GUILD_DELETE"
 
@@ -315,9 +332,162 @@ async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
 
         # do a cleanup of the messages cache
         messages = await state.cache.get_all_messages()
-        await asyncio.gather(*[state.cache.delete_message(message.id) for message in messages])
+        await asyncio.gather(
+            *[state.cache.delete_message(message.id) for message in messages]
+        )
 
         await state._remove_guild(guild)
         self = cls()
         self.__dict__.update(guild.__dict__)
-        return self
+        return self
+
+
+class GuildBanAdd(Event, Member):
+    __event_name__ = "GUILD_BAN_ADD"
+
+    def __init__(self) -> None: ...
+
+    @classmethod
+    async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
+        guild = await state._get_guild(int(data["guild_id"]))
+        if guild is None:
+            _log.debug(
+                "GUILD_BAN_ADD referencing an unknown guild ID: %s. Discarding.",
+                data["guild_id"],
+            )
+            return
+
+        member = await guild.get_member(int(data["user"]["id"]))
+        if member is None:
+            fake_data: MemberWithUser = {
+                "user": data["user"],
+                "roles": [],
+                "joined_at": None,
+                "deaf": False,
+                "mute": False,
+            }
+            member = Member(guild=guild, data=fake_data, state=state)
+
+        self = cls()
+        self.__dict__.update(member.__dict__)
+        return self
+
+
+class GuildBanRemove(Event, Member):
+    __event_name__ = "GUILD_BAN_REMOVE"
+
+    def __init__(self) -> None: ...
+
+    @classmethod
+    async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
+        guild = await state._get_guild(int(data["guild_id"]))
+        if guild is None:
+            _log.debug(
+                "GUILD_BAN_ADD referencing an unknown guild ID: %s. Discarding.",
+                data["guild_id"],
+            )
+            return
+
+        member = await guild.get_member(int(data["user"]["id"]))
+        if member is None:
+            fake_data: MemberWithUser = {
+                "user": data["user"],
+                "roles": [],
+                "joined_at": None,
+                "deaf": False,
+                "mute": False,
+            }
+            member = Member(guild=guild, data=fake_data, state=state)
+
+        self = cls()
+        self.__dict__.update(member.__dict__)
+        return self
+
+
+class GuildRoleCreate(Event, Role):
+    __event_name__ = "GUILD_ROLE_CREATE"
+
+    def __init__(self) -> None: ...
+
+    @classmethod
+    async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
+        guild = await state._get_guild(int(data["guild_id"]))
+        if guild is None:
+            _log.debug(
+                "GUILD_ROLE_CREATE referencing an unknown guild ID: %s. Discarding.",
+                data["guild_id"],
+            )
+            return
+
+        role = Role(guild=guild, data=data["role"], state=state)
+        guild._add_role(role)
+
+        self = cls()
+        self.__dict__.update(role.__dict__)
+        return self
+
+
+class GuildRoleUpdate(Event, Role):
+    __event_name__ = "GUILD_ROLE_UPDATE"
+
+    old: Role
+
+    def __init__(self) -> None: ...
+
+    @classmethod
+    async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
+        guild = await state._get_guild(int(data["guild_id"]))
+        if guild is None:
+            _log.debug(
+                "GUILD_ROLE_UPDATE referencing an unknown guild ID: %s. Discarding.",
+                data["guild_id"],
+            )
+            return
+
+        role_id: int = int(data["role"]["id"])
+        role = guild.get_role(role_id)
+        if role is None:
+            _log.debug(
+                "GUILD_ROLE_UPDATE referencing an unknown role ID: %s. Discarding.",
+                data["role"]["id"],
+            )
+            return
+
+        old_role = copy.copy(role)
+        await role._update(data["role"])
+
+        self = cls()
+        self.__dict__.update(role.__dict__)
+        self.old = old_role
+        return self
+
+
+class GuildRoleDelete(Event, Role):
+    __event_name__ = "GUILD_ROLE_DELETE"
+
+    def __init__(self) -> None: ...
+
+    @classmethod
+    async def __load__(cls, data: Any, state: ConnectionState) -> Self | None:
+        guild = await state._get_guild(int(data["guild_id"]))
+        if guild is None:
+            _log.debug(
+                "GUILD_ROLE_DELETE referencing an unknown guild ID: %s. Discarding.",
+                data["guild_id"],
+            )
+            return
+
+        role_id: int = int(data["role_id"])
+        role = guild.get_role(role_id)
+        if role is None:
+            _log.debug(
+                "GUILD_ROLE_DELETE referencing an unknown role ID: %s. Discarding.",
+                data["role_id"],
+            )
+            return
+
+        guild._remove_role(role_id)
+
+        self = cls()
+        self.__dict__.update(role.__dict__)
+        return self

discord/types/member.py

@@ -35,7 +35,7 @@ class Nickname(TypedDict):
 
 class PartialMember(TypedDict):
     roles: SnowflakeList
-    joined_at: str
+    joined_at: str | None
     deaf: bool
     mute: bool