✨ Guild & Channel properties for APIObjects

pincer/client.py

@@ -189,10 +189,11 @@ def __init__(
         self.http = HTTPClient(token)
         self.throttler = throttler
         self.event_mgr = EventMgr()
-        # TODO: Document guild prop
-        # The guild value is only registered if the GUILD_MEMBERS
-        # intent is enabled.
+
+        # The guild and channel value is only registered if the GUILD intent.
         self.guilds: Dict[Snowflake, Optional[Guild]] = {}
+        self.channels: Dict[Snowflake, Optional[Channel]] = {}
+
         ChatCommandHandler.managers[self.__module__] = self
 
     @property
@@ -497,7 +498,7 @@ async def handle_middleware(
             raise RuntimeError(f"Middleware `{key}` has not been registered.")
 
         if next_call.startswith("on_"):
-            return next_call, ret_object
+            return (next_call, ret_object)
 
         return await self.handle_middleware(
             payload, next_call, *arguments, **params
@@ -565,7 +566,7 @@ async def event_handler(self, _, payload: GatewayDispatch):
         ----------
         _ :
             Socket param, but this isn't required for this handler. So
-            it's just a filler parameter, doesn't matter what is passed.
+            its just a filler parameter, doesn't matter what is passed.
         payload : :class:`~pincer.core.dispatch.GatewayDispatch`
             The payload sent from the Discord gateway, this contains the
             required data for the client to know what event it is and
@@ -582,7 +583,7 @@ async def payload_event_handler(self, _, payload: GatewayDispatch):
         ----------
         _ :
             Socket param, but this isn't required for this handler. So
-            it's just a filler parameter, doesn't matter what is passed.
+            its just a filler parameter, doesn't matter what is passed.
         payload : :class:`~pincer.core.dispatch.GatewayDispatch`
             The payload sent from the Discord gateway, this contains the
             required data for the client to know what event it is and
@@ -857,5 +858,4 @@ async def get_webhook(
         """
         return await Webhook.from_id(self, id, token)
 
-
 Bot = Client

pincer/middleware/channel_create.py

@@ -14,7 +14,7 @@
     from ..core.dispatch import GatewayDispatch
 
 
-def channel_create_middleware(
+async def channel_create_middleware(
         self,
         payload: GatewayDispatch
 ) -> Tuple[str, Channel]:
@@ -32,10 +32,13 @@ def channel_create_middleware(
     Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
         ``on_channel_creation`` and a channel.
     """
-    return (
-        "on_channel_creation",
-        Channel.from_dict(construct_client_dict(self, payload.data))
-    )
+
+    channel: Channel = Channel.from_dict(construct_client_dict(self, payload.data))
+    self.guilds[channel.guild_id].channels.append(channel)
+
+    self.channels[channel.id] = channel
+
+    return "on_channel_creation", channel
 
 
 def export():

pincer/middleware/channel_delete.py

@@ -26,11 +26,10 @@ async def channel_delete_middleware(self, payload: GatewayDispatch):
 
     channel = Channel.from_dict(construct_client_dict(self, payload.data))
 
-    if channel.guild_id in self.guilds:
-        guild = self.guilds[channel.guild_id]
-        old = filter(lambda c: c.id == channel.id, guild.channels)
-        if old:
-            guild.channels.remove(old)
+    guild = self.guilds[channel.guild_id]
+    guild.channels = list(filter(lambda c: c.id != channel.id, guild.channels))
+
+    self.channels.pop(channel.id)
 
     return "on_channel_delete", channel
 

pincer/middleware/channel_pins_update.py

@@ -23,9 +23,12 @@ async def channel_pins_update_middleware(self, payload: GatewayDispatch):
         ``on_channel_pins_update`` and a ``Channel``
     """
 
+    event = ChannelPinsUpdateEvent.from_dict(payload.data)
+    self.channels[event.channel_id].last_pin_timestamp = event.last_pin_timestamp
+
     return (
         "on_channel_pins_update",
-        ChannelPinsUpdateEvent.from_dict(payload.data)
+        event
     )
 
 

pincer/middleware/channel_update.py

@@ -25,13 +25,7 @@ async def channel_update_middleware(self, payload: GatewayDispatch):
     """
 
     channel = Channel.from_dict(construct_client_dict(self, payload.data))
-
-    if channel.guild_id in self.guilds.keys():
-        guild = self.guilds[channel.guild_id]
-        old = filter(lambda c: c.id == channel.id, guild.channels)
-        if old:
-            guild.channels.remove(old)
-        guild.channels.append(channel)
+    self.channels[channel.id] = channel
 
     return "on_channel_update", channel
 

pincer/middleware/guild_create.py

@@ -33,6 +33,9 @@ async def guild_create_middleware(self, payload: GatewayDispatch):
     """
     guild = Guild.from_dict(construct_client_dict(self, payload.data))
     self.guilds[guild.id] = guild
+    for channel in guild.channels:
+        self.channels[channel.id] = channel
+
     return "on_guild_create", guild
 
 

pincer/middleware/guild_delete.py

@@ -23,15 +23,15 @@ async def guild_delete_middleware(self, payload: GatewayDispatch):
     Tuple[:class:`str`, :class:`~pincer.objects.guild.guild.UnavailableGuild`]
         ``on_guild_delete`` and an ``UnavailableGuild``
     """
-    # TODO: Fix docs on line 23 (three lines above)
-    # http://docs.pincer.dev/pincer.middleware#pincer.middleware.guild_delete.guild_delete_middleware
 
     guild = UnavailableGuild.from_dict(
         construct_client_dict(self, payload.data)
     )
 
-    if guild.id in self.guilds.key():
-        self.guilds.pop(guild.id)
+    self.guilds.pop(guild.id, None)
+
+    for channel in self.guild.channels:
+        self.channels.pop(channel.id)
 
     return "on_guild_delete", guild
 

pincer/middleware/guild_emojis_update.py

@@ -25,11 +25,15 @@ async def guild_emojis_update_middleware(self, payload: GatewayDispatch):
         ``on_guild_emoji_update`` and a ``GuildEmojisUpdateEvent``
     """  # noqa: E501
 
+    event = GuildEmojisUpdateEvent.from_dict(
+        construct_client_dict(self, payload.data)
+    )
+
+    self.guild[event.guild_id] = event.emojis
+
     return (
         "on_guild_emojis_update",
-        GuildEmojisUpdateEvent.from_dict(
-            construct_client_dict(self, payload.data)
-        )
+        event
     )
 
 

pincer/middleware/guild_member_add.py

@@ -26,7 +26,7 @@ async def guild_member_add_middleware(self, payload: GatewayDispatch):
     -------
     Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildMemberAddEvent`]
         ``on_guild_member_add`` and a ``GuildMemberAddEvent``
-    """  # noqa: E501
+    """
 
     return (
         "on_guild_member_add",

pincer/middleware/guild_member_remove.py

@@ -25,7 +25,7 @@ async def guild_member_remove_middleware(self, payload: GatewayDispatch):
     -------
     Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildMemberRemoveEvent`]
         ``on_guild_member_remove`` and a ``GuildMemberRemoveEvent``
-    """  # noqa: E501
+    """ 
 
     return (
         "on_guild_member_remove",

pincer/middleware/guild_member_update.py

@@ -26,7 +26,7 @@ async def guild_member_update_middleware(self, payload: GatewayDispatch):
     -------
     Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildMemberUpdateEvent`]
         ``on_guild_member_update`` and a ``GuildMemberUpdateEvent``
-    """  # noqa: E501
+    """
 
     return (
         "on_guild_member_update",

pincer/middleware/guild_role_create.py

@@ -25,11 +25,13 @@ async def guild_role_create_middleware(self, payload: GatewayDispatch):
         ``on_guild_role_create`` and a ``GuildRoleCreateEvent``
     """  # noqa: E501
 
+    event = GuildRoleCreateEvent.from_dict(construct_client_dict(self, payload.data))
+
+    self.guilds[event.guild_id].roles.append(event.role)
+
     return (
         "on_guild_role_create",
-        GuildRoleCreateEvent.from_dict(
-            construct_client_dict(self, payload.data)
-        )
+        event
     )
 
 

pincer/middleware/guild_role_delete.py

@@ -25,11 +25,15 @@ async def guild_role_delete_middleware(self, payload: GatewayDispatch):
         ``on_guild_role_delete`` and a ``GuildRoleDeleteEvent``
     """  # noqa: E501
 
+    event = GuildRoleDeleteEvent.from_dict(construct_client_dict(self, payload.data))
+
+    self.guilds[event.guild_id].roles = list(filter(
+        lambda role: role.id != event.role_id, self.guilds[event.guild_id].roles
+    ))
+
     return (
         "on_guild_role_delete",
-        GuildRoleDeleteEvent.from_dict(
-            construct_client_dict(self, payload.data)
-        ),
+        event
     )
 
 

pincer/middleware/guild_role_update.py

@@ -23,13 +23,17 @@ async def guild_role_update_middleware(self, payload: GatewayDispatch):
     -------
     Tuple[:class:`str`, :class:`~pincer.objects.events.guild.GuildRoleUpdateEvent`]
         ``on_guild_role_update`` and a ``GuildRoleUpdateEvent``
-    """  # noqa: E501
+    """
+
+    event = GuildRoleUpdateEvent.from_dict(construct_client_dict(self, payload.data))
+    self.guilds[event.guild_id].roles = [
+        role if role.id != event.role.id else event.role
+        for role in self.guilds[event.guild_id].roles
+    ]
 
     return (
         "on_guild_role_update",
-        GuildRoleUpdateEvent.from_dict(
-            construct_client_dict(self, payload.data)
-        ),
+        event
     )
 
 

pincer/middleware/guild_update.py

@@ -25,19 +25,12 @@ async def guild_update_middleware(self, payload: GatewayDispatch):
         ``on_guild_Update`` and an ``Guild``
     """
 
-    channel_list = payload.data.pop("channels", [])
-
-    channels: List[Channel] = [
-        Channel.from_dict(construct_client_dict(self, channel))
-        for channel in channel_list
-    ]
-
-    guild = Guild.from_dict(construct_client_dict(
-        self,
-        {"channels": channels, **payload.data}
-    ))
+    guild = Guild.from_dict(construct_client_dict(self, payload.data))
     self.guild[guild.id] = guild
 
+    for channel in guild.channels:
+        self.channels[channel.id] = channel
+
     return "on_guild_update", guild
 
 

pincer/objects/events/channel.py

@@ -32,4 +32,3 @@ class ChannelPinsUpdateEvent(APIObject):
 
     guild_id: APINullable[Snowflake] = MISSING
     last_pin_timestamp: APINullable[Timestamp] = MISSING
-