Merge pull request #123 from nerdguyahmad/raw-thread-delete

Add Raw thread delete event

Author: CodeWithSwastik

discord/raw_models.py

@@ -26,6 +26,8 @@
 
 from typing import TYPE_CHECKING, Optional, Set, List
 
+from .enums import ChannelType, try_enum
+
 if TYPE_CHECKING:
     from .types.raw_models import (
         MessageDeleteEvent,
@@ -34,11 +36,14 @@
         MessageUpdateEvent,
         ReactionClearEvent,
         ReactionClearEmojiEvent,
-        IntegrationDeleteEvent
+        IntegrationDeleteEvent,
+        ThreadDeleteEvent,
     )
     from .message import Message
     from .partial_emoji import PartialEmoji
     from .member import Member
+    from .threads import Thread
+
 
 
 __all__ = (
@@ -49,6 +54,7 @@
     'RawReactionClearEvent',
     'RawReactionClearEmojiEvent',
     'RawIntegrationDeleteEvent',
+    'RawThreadDeleteEvent',
 )
 
 
@@ -276,3 +282,33 @@ def __init__(self, data: IntegrationDeleteEvent) -> None:
             self.application_id: Optional[int] = int(data['application_id'])
         except KeyError:
             self.application_id: Optional[int] = None
+
+class RawThreadDeleteEvent(_RawReprMixin):
+    """Represents the payload for :func:`on_raw_thread_delete` event.
+
+    .. versionadded:: 2.0
+    
+    Attributes
+    ----------
+
+    thread_id: :class:`int`
+        The ID of the thread that was deleted.
+    thread_type: :class:`discord.ChannelType`
+        The channel type of the deleted thread.
+    guild_id: :class:`int`
+        The ID of the guild the deleted thread belonged to.
+    parent_id: :class:`int`
+        The ID of the channel the thread belonged to.
+    thread: Optional[:class:`discord.Thread`]
+        The thread that was deleted. This may be ``None`` if deleted thread is not found in internal cache.
+    """
+    __slots__ = ('thread_id', 'thread_type', 'guild_id', 'parent_id', 'thread')
+
+    def __init__(self, data: ThreadDeleteEvent) -> None:
+        self.thread_id: int = int(data['id'])
+        self.thread_type: ChannelType = try_enum(ChannelType, int(data['type']))
+        self.guild_id: int = int(data['guild_id'])
+        self.parent_id: int = int(data['parent_id'])
+        self.thread: Optional[Thread] = None
+
+   

discord/state.py

@@ -850,12 +850,18 @@ def parse_thread_update(self, data) -> None:
     def parse_thread_delete(self, data) -> None:
         guild_id = int(data['guild_id'])
         guild = self._get_guild(guild_id)
+
         if guild is None:
             _log.debug('THREAD_DELETE referencing an unknown guild ID: %s. Discarding', guild_id)
             return
 
-        thread_id = int(data['id'])
-        thread = guild.get_thread(thread_id)
+        raw = RawThreadDeleteEvent(data)
+        thread = guild.get_thread(raw.thread_id)
+        raw.thread = thread
+
+        self.dispatch('raw_thread_delete', raw)
+
+
         if thread is not None:
             guild._remove_thread(thread)  # type: ignore
             self.dispatch('thread_delete', thread)

discord/types/raw_models.py

@@ -85,3 +85,10 @@ class _IntegrationDeleteEventOptional(TypedDict, total=False):
 class IntegrationDeleteEvent(_IntegrationDeleteEventOptional):
     id: Snowflake
     guild_id: Snowflake
+
+class ThreadDeleteEvent(TypedDict, total=False):
+    thread_id: Snowflake
+    thread_type: int
+    guild_id: Snowflake
+    parent_id: Snowflake
+

docs/api.rst

@@ -759,7 +759,9 @@ to handle it, which defaults to print a traceback and ignoring the exception.
 
 .. function:: on_thread_delete(thread)
 
-    Called whenever a thread is deleted.
+    Called whenever a thread is deleted.  If the deleted thread isn't found in internal cache 
+    then this will not be called. Archived threads are not in the cache. Consider using :func:`on_raw_thread_delete`
+
 
     Note that you can get the guild from :attr:`Thread.guild`.
 
@@ -770,6 +772,14 @@ to handle it, which defaults to print a traceback and ignoring the exception.
     :param thread: The thread that got deleted.
     :type thread: :class:`Thread`
 
+.. function:: on_raw_thread_delete(payload)
+    
+    Called whenever a thread is deleted. Unlike :func:`on_thread_delete` this is called
+    regardless of the state of the internal cache.
+
+    :param payload: The raw event payload data.
+    :type payload: :class:`RawThreadDeleteEvent`
+
 .. function:: on_thread_member_join(member)
               on_thread_member_remove(member)
 
@@ -3943,6 +3953,14 @@ RawIntegrationDeleteEvent
 .. autoclass:: RawIntegrationDeleteEvent()
     :members:
 
+RawThreadDeleteEvent
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. attributetable:: RawThreadDeleteEvent
+
+.. autoclass:: RawThreadDeleteEvent()
+    :members:
+
 PartialWebhookGuild
 ~~~~~~~~~~~~~~~~~~~~