Merge pull request #165 from nekokatt/task/162-author-message-events

Added message author attributes to events and fixed typing.

Author: Nekokatt

hikari/events/message_events.py

@@ -46,18 +46,17 @@
 
 import attr
 
+from hikari import channels
+from hikari import guilds
 from hikari import intents
 from hikari import snowflakes
+from hikari import undefined
 from hikari import users
 from hikari.events import base_events
 from hikari.events import shard_events
 from hikari.utilities import attr_extensions
 
 if typing.TYPE_CHECKING:
-    # Do NOT remove the users import here. It **is** required, even if PyCharm
-    # tries to assure you otherwise.
-    from hikari import channels
-    from hikari import guilds
     from hikari import messages
     from hikari import traits
     from hikari.api import shard as gateway_shard
@@ -131,9 +130,24 @@ def guild_id(self) -> snowflakes.Snowflake:
         """
 
     @property
-    def channel(self) -> typing.Optional[channels.GuildTextChannel]:
-        # <<inherited docstring from MessagesEvent>>.
-        return typing.cast("channels.GuildTextChannel", self.app.cache.get_guild_channel(self.channel_id))
+    def channel(self) -> typing.Union[None, channels.GuildTextChannel, channels.GuildNewsChannel]:
+        """Channel that the message was sent in, if known.
+
+        Returns
+        -------
+        typing.Union[builtins.None, hikari.channels.GuildTextChannel, hikari.channels.GuildNewsChannel]
+            The channel the message was sent in, or `builtins.None` if not
+            known/cached.
+
+            This otherwise will always be a `hikari.channels.GuildTextChannel`
+            if it is a normal message, or `hikari.channels.GuildNewsChannel` if
+            sent in an announcement channel.
+        """
+        channel = self.app.cache.get_guild_channel(self.channel_id)
+        assert channel is None or isinstance(
+            channel, (channels.GuildTextChannel, channels.GuildNewsChannel)
+        ), f"expected cached channel to be None or a GuildTextChannel/GuildNewsChannel, not {channel}"
+        return channel
 
     @property
     def guild(self) -> typing.Optional[guilds.GatewayGuild]:
@@ -157,6 +171,11 @@ def guild(self) -> typing.Optional[guilds.GatewayGuild]:
 class MessageCreateEvent(MessageEvent, abc.ABC):
     """Event base for any message creation event."""
 
+    @property
+    def message_id(self) -> snowflakes.Snowflake:
+        # <<inherited docstring from MessageEvent>>.
+        return self.message.id
+
     @property
     @abc.abstractmethod
     def message(self) -> messages.Message:
@@ -168,11 +187,6 @@ def message(self) -> messages.Message:
             The message object that was sent with this event.
         """
 
-    @property
-    def message_id(self) -> snowflakes.Snowflake:
-        # <<inherited docstring from MessageEvent>>.
-        return self.message.id
-
     @property
     def channel_id(self) -> snowflakes.Snowflake:
         # <<inherited docstring from MessageEvent>>.
@@ -189,6 +203,17 @@ def author_id(self) -> snowflakes.Snowflake:
         """
         return self.message.author.id
 
+    @property
+    @abc.abstractmethod
+    def author(self) -> users.User:
+        """User that sent the message.
+
+        Returns
+        -------
+        hikari.users.User
+            The user that sent the message.
+        """
+
 
 @base_events.requires_intents(intents.Intents.GUILD_MESSAGES, intents.Intents.PRIVATE_MESSAGES)
 @attr.s(kw_only=True, slots=True, weakref_slot=False)
@@ -219,6 +244,23 @@ def message_id(self) -> snowflakes.Snowflake:
         # <<inherited docstring from MessageEvent>>.
         return self.message.id
 
+    @property
+    def channel_id(self) -> snowflakes.Snowflake:
+        # <<inherited docstring from MessageEvent>>.
+        return self.message.channel_id
+
+    @property
+    @abc.abstractmethod
+    def channel(self) -> typing.Optional[channels.TextChannel]:
+        """Channel that the message was sent in, if known.
+
+        Returns
+        -------
+        typing.Optional[hikari.channels.TextChannel]
+            The text channel that the message was sent in, if known and cached,
+            otherwise, `builtins.None`.
+        """
+
     @property
     def author_id(self) -> snowflakes.Snowflake:
         """ID of the author that triggered this event.
@@ -230,13 +272,23 @@ def author_id(self) -> snowflakes.Snowflake:
         """
         # Looks like `author` is always present in this event variant.
         author = self.message.author
-        assert isinstance(author, users.PartialUser)
+        assert isinstance(author, users.User), "message.author was expected to be present"
         return author.id
 
     @property
-    def channel_id(self) -> snowflakes.Snowflake:
-        # <<inherited docstring from MessageEvent>>.
-        return self.message.channel_id
+    @abc.abstractmethod
+    def author(self) -> typing.Optional[users.User]:
+        """User that sent the message.
+
+        Returns
+        -------
+        typing.Optional[hikari.users.User]
+            The user that sent the message, if known and cached, otherwise
+            `builtins.None`.
+        """
+        author = self.message.author
+        assert isinstance(author, users.User), "message.author was expected to be present"
+        return author
 
 
 @base_events.requires_intents(intents.Intents.GUILD_MESSAGES, intents.Intents.PRIVATE_MESSAGES)
@@ -278,6 +330,18 @@ def channel_id(self) -> snowflakes.Snowflake:
         # <<inherited docstring from MessagesEvent>>.
         return self.message.channel_id
 
+    @property
+    @abc.abstractmethod
+    def channel(self) -> typing.Optional[channels.TextChannel]:
+        """Channel that the message was sent in, if known.
+
+        Returns
+        -------
+        typing.Optional[hikari.channels.TextChannel]
+            The text channel that the message was sent in, if known and cached,
+            otherwise, `builtins.None`.
+        """
+
 
 @base_events.requires_intents(intents.Intents.GUILD_MESSAGES)
 @attr_extensions.with_copy
@@ -292,14 +356,27 @@ class GuildMessageCreateEvent(GuildMessageEvent, MessageCreateEvent):
     # <<inherited docstring from ShardEvent>>.
 
     message: messages.Message = attr.ib()
-
     # <<inherited docstring from MessageCreateEvent>>.
 
     @property
     def guild_id(self) -> snowflakes.Snowflake:
         # <<inherited docstring from GuildMessageEvent>>.
         # Always present in this event.
-        return typing.cast("snowflakes.Snowflake", self.message.guild_id)
+        guild_id = self.message.guild_id
+        assert isinstance(guild_id, snowflakes.Snowflake)
+        return guild_id
+
+    @property
+    def author(self) -> guilds.Member:
+        """Member that sent the message.
+
+        Returns
+        -------
+        hikari.guilds.Member
+            The member that sent the message. This is a specialised
+            implementation of `hikari.users.User`.
+        """
+        return typing.cast(guilds.Member, self.message.member)
 
 
 @base_events.requires_intents(intents.Intents.PRIVATE_MESSAGES)
@@ -315,14 +392,25 @@ class PrivateMessageCreateEvent(PrivateMessageEvent, MessageCreateEvent):
     # <<inherited docstring from ShardEvent>>.
 
     message: messages.Message = attr.ib()
-
     # <<inherited docstring from MessageCreateEvent>>.
 
     @property
     def channel(self) -> typing.Optional[channels.DMChannel]:
-        # <<inherited docstring from MessagesEvent>>.
+        """Channel that the message was sent in, if known.
+
+        Returns
+        -------
+        typing.Optional[hikari.channels.DMChannel]
+            The DM channel that the message was sent in, if known and cached,
+            otherwise, `builtins.None`.
+        """
         return self.app.cache.get_dm(self.author_id)
 
+    @property
+    def author(self) -> users.User:
+        # <<inherited from MessageCreateEvent>>.
+        return self.message.author
+
 
 @base_events.requires_intents(intents.Intents.GUILD_MESSAGES)
 @attr_extensions.with_copy
@@ -337,7 +425,6 @@ class GuildMessageUpdateEvent(GuildMessageEvent, MessageUpdateEvent):
     # <<inherited docstring from ShardEvent>>.
 
     message: messages.PartialMessage = attr.ib()
-
     # <<inherited docstring from MessageUpdateEvent>>.
 
     @property
@@ -348,6 +435,21 @@ def guild_id(self) -> snowflakes.Snowflake:
         assert isinstance(guild_id, snowflakes.Snowflake)
         return guild_id
 
+    @property
+    def author(self) -> typing.Union[guilds.Member, users.User]:
+        # <<inherited from GuildMessageUpdateEvent>>.
+        member = self.message.member
+        if member is not undefined.UNDEFINED and member is not None:
+            return member
+        member = self.app.cache.get_member(self.guild_id, self.author_id)
+        if member is not None:
+            return member
+
+        # This should always be present.
+        author = self.message.author
+        assert isinstance(author, users.User), "expected author to be present"
+        return author
+
 
 @base_events.requires_intents(intents.Intents.PRIVATE_MESSAGES)
 @attr_extensions.with_copy
@@ -362,14 +464,20 @@ class PrivateMessageUpdateEvent(PrivateMessageEvent, MessageUpdateEvent):
     # <<inherited docstring from ShardEvent>>.
 
     message: messages.PartialMessage = attr.ib()
-
     # <<inherited docstring from MessageUpdateEvent>>.
 
     @property
     def channel(self) -> typing.Optional[channels.DMChannel]:
         # <<inherited docstring from MessagesEvent>>.
         return self.app.cache.get_dm(self.author_id)
 
+    @property
+    def author(self) -> typing.Optional[users.User]:
+        # Always present on an update event.
+        author = self.message.author
+        assert isinstance(author, users.User), "expected author to be present on PartialMessage"
+        return author
+
 
 @base_events.requires_intents(intents.Intents.GUILD_MESSAGES)
 @attr_extensions.with_copy
@@ -384,14 +492,15 @@ class GuildMessageDeleteEvent(GuildMessageEvent, MessageDeleteEvent):
     # <<inherited docstring from ShardEvent>>.
 
     message: messages.PartialMessage = attr.ib()
-
     # <<inherited docstring from MessageDeleteEvent>>.
 
     @property
     def guild_id(self) -> snowflakes.Snowflake:
         # <<inherited docstring from GuildMessageEvent>>.
         # Always present in this event.
-        return typing.cast("snowflakes.Snowflake", self.message.guild_id)
+        guild_id = self.message.guild_id
+        assert isinstance(guild_id, snowflakes.Snowflake), f"expected guild_id to be snowflake, not {guild_id}"
+        return guild_id
 
 
 @attr_extensions.with_copy
@@ -407,7 +516,6 @@ class PrivateMessageDeleteEvent(PrivateMessageEvent, MessageDeleteEvent):
     # <<inherited docstring from ShardEvent>>.
 
     message: messages.PartialMessage = attr.ib()
-
     # <<inherited docstring from MessageDeleteEvent>>.
 
     @property
@@ -473,9 +581,24 @@ class GuildMessageBulkDeleteEvent(MessageBulkDeleteEvent):
     """
 
     @property
-    def channel(self) -> typing.Optional[channels.GuildTextChannel]:
-        # <<inherited docstring from MessagesEvent>>.
-        return typing.cast("channels.GuildTextChannel", self.app.cache.get_guild_channel(self.channel_id))
+    def channel(self) -> typing.Union[None, channels.GuildTextChannel, channels.GuildNewsChannel]:
+        """Get the cached channel the messages were sent in, if known.
+
+        Returns
+        -------
+        typing.Union[builtins.None, hikari.channels.GuildTextChannel, hikari.channels.GuildNewsChannel]
+            The channel the messages were sent in, or `builtins.None` if not
+            known/cached.
+
+            This otherwise will always be a `hikari.channels.GuildTextChannel`
+            if it is a normal message, or `hikari.channels.GuildNewsChannel` if
+            sent in an announcement channel.
+        """
+        channel = self.app.cache.get_guild_channel(self.channel_id)
+        assert channel is None or isinstance(
+            channel, (channels.GuildTextChannel, channels.GuildNewsChannel)
+        ), f"expected cached channel to be None or a GuildTextChannel/GuildNewsChannel, not {channel}"
+        return channel
 
     @property
     def guild(self) -> typing.Optional[guilds.GatewayGuild]: