# SPDX-License-Identifier: MIT from __future__ import annotations import asyncio import time from typing import TYPE_CHECKING, Callable, Dict, Iterable, List, Literal, Optional, Sequence, Union from .abc import GuildChannel, Messageable from .enums import ChannelType, ThreadArchiveDuration, try_enum, try_enum_to_int from .errors import ClientException from .flags import ChannelFlags from .mixins import Hashable from .partial_emoji import PartialEmoji, _EmojiTag from .utils import MISSING, _get_as_snowflake, _unique, parse_time, snowflake_time __all__ = ( "Thread", "ThreadMember", "ForumTag", ) if TYPE_CHECKING: import datetime from typing_extensions import Self from .abc import Snowflake, SnowflakeTime from .channel import CategoryChannel, ForumChannel, TextChannel from .emoji import Emoji from .guild import Guild from .member import Member from .message import Message, PartialMessage from .permissions import Permissions from .role import Role from .state import ConnectionState from .types.snowflake import SnowflakeList from .types.threads import ( ForumTag as ForumTagPayload, PartialForumTag as PartialForumTagPayload, Thread as ThreadPayload, ThreadArchiveDurationLiteral, ThreadMember as ThreadMemberPayload, ThreadMetadata, ) AnyThreadArchiveDuration = Union[ThreadArchiveDuration, ThreadArchiveDurationLiteral] ThreadType = Literal[ ChannelType.news_thread, ChannelType.public_thread, ChannelType.private_thread ] class Thread(Messageable, Hashable): """Represents a Discord thread. .. container:: operations .. describe:: x == y Checks if two threads are equal. .. describe:: x != y Checks if two threads are not equal. .. describe:: hash(x) Returns the thread's hash. .. describe:: str(x) Returns the thread's name. .. versionadded:: 2.0 Attributes ---------- name: :class:`str` The thread name. guild: :class:`Guild` The guild the thread belongs to. id: :class:`int` The thread ID. parent_id: :class:`int` The parent :class:`TextChannel` or :class:`ForumChannel` ID this thread belongs to. owner_id: Optional[:class:`int`] The user's ID that created this thread. last_message_id: Optional[:class:`int`] The last message ID of the message sent to this thread. It may *not* point to an existing or valid message. slowmode_delay: :class:`int` The number of seconds a member must wait between sending messages in this thread. A value of `0` denotes that it is disabled. Bots, and users with :attr:`~Permissions.manage_channels` or :attr:`~Permissions.manage_messages`, bypass slowmode. message_count: Optional[:class:`int`] An approximate number of messages in this thread. .. note:: If the thread was created before July 1, 2022, this could be inaccurate. member_count: Optional[:class:`int`] An approximate number of members in this thread. This caps at 50. total_message_sent: Optional[:class:`int`] The total number of messages sent in the thread, including deleted messages. .. versionadded:: 2.6 .. note:: If the thread was created before July 1, 2022, this could be inaccurate. me: Optional[:class:`ThreadMember`] A thread member representing yourself, if you've joined the thread. This could not be available. archived: :class:`bool` Whether the thread is archived. locked: :class:`bool` Whether the thread is locked. invitable: :class:`bool` Whether non-moderators can add other non-moderators to this thread. This is always ``True`` for public threads. auto_archive_duration: :class:`int` The duration in minutes until the thread is automatically archived due to inactivity. Usually a value of 60, 1440, 4320 and 10080. archive_timestamp: :class:`datetime.datetime` An aware timestamp of when the thread's archived status was last updated in UTC. create_timestamp: Optional[:class:`datetime.datetime`] An aware timestamp of when the thread was created in UTC. This is only available for threads created after 2022-01-09. .. versionadded:: 2.4 last_pin_timestamp: Optional[:class:`datetime.datetime`] The time the most recent message was pinned, or ``None`` if no message is currently pinned. .. versionadded:: 2.5 """ __slots__ = ( "name", "id", "guild", "owner_id", "parent_id", "last_message_id", "message_count", "total_message_sent", "member_count", "slowmode_delay", "me", "locked", "archived", "invitable", "auto_archive_duration", "archive_timestamp", "create_timestamp", "last_pin_timestamp", "_flags", "_applied_tags", "_type", "_state", "_members", ) def __init__(self, *, guild: Guild, state: ConnectionState, data: ThreadPayload) -> None: self._state: ConnectionState = state self.guild: Guild = guild self._members: Dict[int, ThreadMember] = {} self._from_data(data) async def _get_channel(self): return self def __repr__(self) -> str: return ( f"" ) def __str__(self) -> str: return self.name def _from_data(self, data: ThreadPayload) -> None: self.id: int = int(data["id"]) self.parent_id: int = int(data["parent_id"]) self.owner_id: Optional[int] = _get_as_snowflake(data, "owner_id") self.name: str = data["name"] self._type: ThreadType = try_enum(ChannelType, data["type"]) # type: ignore self.last_message_id: Optional[int] = _get_as_snowflake(data, "last_message_id") self.slowmode_delay: int = data.get("rate_limit_per_user", 0) self.message_count: int = data.get("message_count") or 0 self.total_message_sent: int = data.get("total_message_sent") or 0 self.member_count: Optional[int] = data.get("member_count") self.last_pin_timestamp: Optional[datetime.datetime] = parse_time( data.get("last_pin_timestamp") ) self._flags: int = data.get("flags", 0) self._applied_tags: List[int] = list(map(int, data.get("applied_tags", []))) self._unroll_metadata(data["thread_metadata"]) try: member = data["member"] except KeyError: self.me = None else: self.me = ThreadMember(self, member) def _unroll_metadata(self, data: ThreadMetadata) -> None: self.archived: bool = data["archived"] self.auto_archive_duration: ThreadArchiveDurationLiteral = data["auto_archive_duration"] self.archive_timestamp: datetime.datetime = parse_time(data["archive_timestamp"]) self.locked: bool = data.get("locked", False) self.invitable: bool = data.get("invitable", True) self.create_timestamp: Optional[datetime.datetime] = parse_time( data.get("create_timestamp") ) def _update(self, data: ThreadPayload) -> None: try: self.name = data["name"] except KeyError: pass self.slowmode_delay = data.get("rate_limit_per_user", 0) self._flags = data.get("flags", 0) self._applied_tags = list(map(int, data.get("applied_tags", []))) try: self._unroll_metadata(data["thread_metadata"]) except KeyError: pass @property def type(self) -> ThreadType: """:class:`ChannelType`: The channel's Discord type. This always returns :attr:`ChannelType.public_thread`, :attr:`ChannelType.private_thread`, or :attr:`ChannelType.news_thread`. """ return self._type @property def parent(self) -> Optional[Union[TextChannel, ForumChannel]]: """Optional[Union[:class:`TextChannel`, :class:`ForumChannel`]]: The parent channel this thread belongs to.""" return self.guild.get_channel(self.parent_id) # type: ignore @property def owner(self) -> Optional[Member]: """Optional[:class:`Member`]: The member this thread belongs to.""" if self.owner_id is None: return None return self.guild.get_member(self.owner_id) @property def mention(self) -> str: """:class:`str`: The string that allows you to mention the thread.""" return f"<#{self.id}>" @property def members(self) -> List[ThreadMember]: """List[:class:`ThreadMember`]: A list of thread members in this thread. This requires :attr:`Intents.members` to be properly filled. Most of the time however, this data is not provided by the gateway and a call to :meth:`fetch_members` is needed. """ return list(self._members.values()) @property def last_message(self) -> Optional[Message]: """Gets the last message in this channel from the cache. The message might not be valid or point to an existing message. .. admonition:: Reliable Fetching :class: helpful For a slightly more reliable method of fetching the last message, consider using either :meth:`history` or :meth:`fetch_message` with the :attr:`last_message_id` attribute. Returns ------- Optional[:class:`Message`] The last message in this channel or ``None`` if not found. """ return self._state._get_message(self.last_message_id) if self.last_message_id else None @property def category(self) -> Optional[CategoryChannel]: """The category channel the parent channel belongs to, if applicable. Raises ------ ClientException The parent channel was not cached and returned ``None``. Returns ------- Optional[:class:`CategoryChannel`] The parent channel's category. """ parent = self.parent if parent is None: raise ClientException("Parent channel not found") return parent.category @property def category_id(self) -> Optional[int]: """The category channel ID the parent channel belongs to, if applicable. Raises ------ ClientException The parent channel was not cached and returned ``None``. Returns ------- Optional[:class:`int`] The parent channel's category ID. """ parent = self.parent if parent is None: raise ClientException("Parent channel not found") return parent.category_id @property def created_at(self) -> datetime.datetime: """:class:`datetime.datetime`: Returns the thread's creation time in UTC. .. versionchanged:: 2.4 If create_timestamp is provided by discord, that will be used instead of the time in the ID. """ return self.create_timestamp or snowflake_time(self.id) @property def flags(self) -> ChannelFlags: """:class:`.ChannelFlags`: The channel flags for this thread. .. versionadded:: 2.5 """ return ChannelFlags._from_value(self._flags) @property def jump_url(self) -> str: """A URL that can be used to jump to this thread. .. versionadded:: 2.4 """ return f"https://discord.com/channels/{self.guild.id}/{self.id}" def is_private(self) -> bool: """Whether the thread is a private thread. A private thread is only viewable by those that have been explicitly invited or have :attr:`~.Permissions.manage_threads` permissions. :return type: :class:`bool` """ return self._type is ChannelType.private_thread def is_news(self) -> bool: """Whether the thread is a news thread. A news thread is a thread that has a parent that is a news channel, i.e. :meth:`.TextChannel.is_news` is ``True``. :return type: :class:`bool` """ return self._type is ChannelType.news_thread def is_nsfw(self) -> bool: """Whether the thread is NSFW or not. An NSFW thread is a thread that has a parent that is an NSFW channel, i.e. :meth:`.TextChannel.is_nsfw` is ``True``. :return type: :class:`bool` """ parent = self.parent return parent is not None and parent.is_nsfw() def is_pinned(self) -> bool: """Whether the thread is pinned in a :class:`ForumChannel` Pinned threads are not affected by the auto archive duration. This is a shortcut to :attr:`self.flags.pinned `. .. versionadded:: 2.5 :return type: :class:`bool` """ return self.flags.pinned @property def applied_tags(self) -> List[ForumTag]: """List[:class:`ForumTag`]: The tags currently applied to this thread. Only applicable to threads in :class:`ForumChannel`\\s. .. versionadded:: 2.6 """ from .channel import ForumChannel # cyclic import parent = self.parent if not isinstance(parent, ForumChannel): return [] # threads may have tag IDs for tags that don't exist anymore return list(filter(None, map(parent._available_tags.get, self._applied_tags))) def permissions_for( self, obj: Union[Member, Role], /, *, ignore_timeout: bool = MISSING, ) -> Permissions: """Handles permission resolution for the :class:`~disnake.Member` or :class:`~disnake.Role`. Since threads do not have their own permissions, they inherit them from the parent channel. However, the permission context is different compared to a normal channel, so this method has different behavior than calling the parent's :attr:`GuildChannel.permissions_for <.abc.GuildChannel.permissions_for>` method directly. .. versionchanged:: 2.9 Properly takes :attr:`Permissions.send_messages_in_threads` into consideration. Parameters ---------- obj: Union[:class:`~disnake.Member`, :class:`~disnake.Role`] The object to resolve permissions for. This could be either a member or a role. If it's a role then member overwrites are not computed. ignore_timeout: :class:`bool` Whether or not to ignore the user's timeout. Defaults to ``False``. .. versionadded:: 2.4 .. note:: This only applies to :class:`~disnake.Member` objects. .. versionchanged:: 2.6 The default was changed to ``False``. Raises ------ ClientException The parent channel was not cached and returned ``None`` Returns ------- :class:`~disnake.Permissions` The resolved permissions for the member or role. """ parent = self.parent if parent is None: raise ClientException("Parent channel not found") # n.b. GuildChannel is used here so implicit overrides are not applied based on send_messages base = GuildChannel.permissions_for(parent, obj, ignore_timeout=ignore_timeout) # if you can't send a message in a channel then you can't have certain # permissions as well if not base.send_messages_in_threads: base.send_tts_messages = False base.send_voice_messages = False base.mention_everyone = False base.embed_links = False base.attach_files = False # if you can't view a channel then you have no permissions there if not base.view_channel: denied = Permissions.all_channel() base.value &= ~denied.value return base async def delete_messages(self, messages: Iterable[Snowflake]) -> None: """|coro| Deletes a list of messages. This is similar to :meth:`Message.delete` except it bulk deletes multiple messages. As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it's more than two, then bulk delete is used. You cannot bulk delete more than 100 messages or messages that are older than 14 days old. You must have the :attr:`~Permissions.manage_messages` permission to use this. Usable only by bot accounts. Parameters ---------- messages: Iterable[:class:`abc.Snowflake`] An iterable of messages denoting which ones to bulk delete. Raises ------ ClientException The number of messages to delete was more than 100. Forbidden You do not have proper permissions to delete the messages or you're not using a bot account. NotFound If single delete, then the message was already deleted. HTTPException Deleting the messages failed. """ if not isinstance(messages, (list, tuple)): messages = list(messages) if len(messages) == 0: return # do nothing if len(messages) == 1: message_id = messages[0].id await self._state.http.delete_message(self.id, message_id) return if len(messages) > 100: raise ClientException("Can only bulk delete messages up to 100 messages") message_ids: SnowflakeList = [m.id for m in messages] await self._state.http.delete_messages(self.id, message_ids) async def purge( self, *, limit: Optional[int] = 100, check: Callable[[Message], bool] = MISSING, before: Optional[SnowflakeTime] = None, after: Optional[SnowflakeTime] = None, around: Optional[SnowflakeTime] = None, oldest_first: Optional[bool] = False, bulk: bool = True, ) -> List[Message]: """|coro| Purges a list of messages that meet the criteria given by the predicate ``check``. If a ``check`` is not provided then all messages are deleted without discrimination. You must have the :attr:`~Permissions.manage_messages` permission to delete messages even if they are your own (unless you are a user account). The :attr:`~Permissions.read_message_history` permission is also needed to retrieve message history. Examples -------- Deleting bot's messages :: def is_me(m): return m.author == client.user deleted = await thread.purge(limit=100, check=is_me) await thread.send(f'Deleted {len(deleted)} message(s)') Parameters ---------- limit: Optional[:class:`int`] The number of messages to search through. This is not the number of messages that will be deleted, though it can be. check: Callable[[:class:`Message`], :class:`bool`] The function used to check if a message should be deleted. It must take a :class:`Message` as its sole parameter. before: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]] Same as ``before`` in :meth:`history`. after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]] Same as ``after`` in :meth:`history`. around: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]] Same as ``around`` in :meth:`history`. oldest_first: Optional[:class:`bool`] Same as ``oldest_first`` in :meth:`history`. bulk: :class:`bool` If ``True``, use bulk delete. Setting this to ``False`` is useful for mass-deleting a bot's own messages without :attr:`Permissions.manage_messages`. When ``True``, will fall back to single delete if messages are older than two weeks. Raises ------ Forbidden You do not have proper permissions to do the actions required. HTTPException Purging the messages failed. Returns ------- List[:class:`.Message`] The list of messages that were deleted. """ if check is MISSING: check = lambda m: True iterator = self.history( limit=limit, before=before, after=after, oldest_first=oldest_first, around=around ) ret: List[Message] = [] count = 0 minimum_time = int((time.time() - 14 * 24 * 60 * 60) * 1000.0 - 1420070400000) << 22 async def _single_delete_strategy(messages: Iterable[Message]) -> None: for m in messages: await m.delete() strategy = self.delete_messages if bulk else _single_delete_strategy async for message in iterator: if count == 100: to_delete = ret[-100:] await strategy(to_delete) count = 0 await asyncio.sleep(1) if not check(message): continue if message.id < minimum_time: # older than 14 days old if count == 1: await ret[-1].delete() elif count >= 2: to_delete = ret[-count:] await strategy(to_delete) count = 0 strategy = _single_delete_strategy count += 1 ret.append(message) # SOme messages remaining to poll if count >= 2: # more than 2 messages -> bulk delete to_delete = ret[-count:] await strategy(to_delete) elif count == 1: # delete a single message await ret[-1].delete() return ret async def edit( self, *, name: str = MISSING, archived: bool = MISSING, locked: bool = MISSING, invitable: bool = MISSING, slowmode_delay: int = MISSING, auto_archive_duration: AnyThreadArchiveDuration = MISSING, pinned: bool = MISSING, flags: ChannelFlags = MISSING, applied_tags: Sequence[Snowflake] = MISSING, reason: Optional[str] = None, ) -> Thread: """|coro| Edits the thread. Editing the thread requires :attr:`.Permissions.manage_threads`. The thread creator can also edit ``name``, ``archived``, ``auto_archive_duration`` and ``applied_tags``. Note that if the thread is locked then only those with :attr:`.Permissions.manage_threads` can unarchive a thread. The thread must be unarchived to be edited. Parameters ---------- name: :class:`str` The new name of the thread. archived: :class:`bool` Whether to archive the thread or not. locked: :class:`bool` Whether to lock the thread or not. invitable: :class:`bool` Whether non-moderators can add other non-moderators to this thread. Only available for private threads. auto_archive_duration: Union[:class:`int`, :class:`ThreadArchiveDuration`] The new duration in minutes before a thread is automatically archived for inactivity. Must be one of ``60``, ``1440``, ``4320``, or ``10080``. slowmode_delay: :class:`int` Specifies the slowmode rate limit for users in this thread, in seconds. A value of ``0`` disables slowmode. The maximum value possible is ``21600``. pinned: :class:`bool` Whether to pin the thread or not. This is only available for threads created in a :class:`ForumChannel`. .. versionadded:: 2.5 flags: :class:`ChannelFlags` The new channel flags to set for this thread. This will overwrite any existing flags set on this channel. If parameter ``pinned`` is provided, that will override the setting of :attr:`ChannelFlags.pinned`. .. versionadded:: 2.6 applied_tags: Sequence[:class:`abc.Snowflake`] The new tags of the thread. Maximum of 5. Can also be used to reorder existing tags. This is only available for threads in a :class:`ForumChannel`. If :attr:`~ForumTag.moderated` tags are edited, :attr:`Permissions.manage_threads` permissions are required. See also :func:`add_tags` and :func:`remove_tags`. .. versionadded:: 2.6 reason: Optional[:class:`str`] The reason for editing this thread. Shows up on the audit log. .. versionadded:: 2.5 Raises ------ Forbidden You do not have permissions to edit the thread. HTTPException Editing the thread failed. Returns ------- :class:`Thread` The newly edited thread. """ payload = {} if name is not MISSING: payload["name"] = str(name) if archived is not MISSING: payload["archived"] = archived if auto_archive_duration is not MISSING: payload["auto_archive_duration"] = try_enum_to_int(auto_archive_duration) if locked is not MISSING: payload["locked"] = locked if invitable is not MISSING: payload["invitable"] = invitable if slowmode_delay is not MISSING: payload["rate_limit_per_user"] = slowmode_delay if pinned is not MISSING: # create base flags if flags are provided, otherwise use the internal flags. flags = ChannelFlags._from_value(self._flags if flags is MISSING else flags.value) flags.pinned = pinned if flags is not MISSING: if not isinstance(flags, ChannelFlags): raise TypeError("flags field must be of type ChannelFlags") payload["flags"] = flags.value if applied_tags is not MISSING: payload["applied_tags"] = [t.id for t in applied_tags] data = await self._state.http.edit_channel(self.id, **payload, reason=reason) # The data payload will always be a Thread payload return Thread(data=data, state=self._state, guild=self.guild) # type: ignore async def join(self) -> None: """|coro| Joins this thread. You must have :attr:`~Permissions.send_messages_in_threads` to join a thread. If the thread is private, :attr:`~Permissions.manage_threads` is also needed. Raises ------ Forbidden You do not have permissions to join the thread. HTTPException Joining the thread failed. """ await self._state.http.join_thread(self.id) async def leave(self) -> None: """|coro| Leaves this thread. Raises ------ HTTPException Leaving the thread failed. """ await self._state.http.leave_thread(self.id) async def add_user(self, user: Snowflake) -> None: """|coro| Adds a user to this thread. You must have :attr:`~.Permissions.send_messages` permission to add a user to a public thread. If the thread is private then :attr:`~.Permissions.send_messages` and either :attr:`~.Permissions.create_private_threads` or :attr:`~.Permissions.manage_messages` permissions is required to add a user to the thread. Parameters ---------- user: :class:`abc.Snowflake` The user to add to the thread. Raises ------ Forbidden You do not have permissions to add the user to the thread. HTTPException Adding the user to the thread failed. """ await self._state.http.add_user_to_thread(self.id, user.id) async def remove_user(self, user: Snowflake) -> None: """|coro| Removes a user from this thread. You must have :attr:`~Permissions.manage_threads` or be the creator of the thread to remove a user. Parameters ---------- user: :class:`abc.Snowflake` The user to add to the thread. Raises ------ Forbidden You do not have permissions to remove the user from the thread. HTTPException Removing the user from the thread failed. """ await self._state.http.remove_user_from_thread(self.id, user.id) async def fetch_member(self, member_id: int, /) -> ThreadMember: """|coro| Retrieves a single :class:`ThreadMember` from this thread. Parameters ---------- member_id: :class:`int` The ID of the member to fetch. Raises ------ NotFound The specified member was not found. HTTPException Retrieving the member failed. Returns ------- :class:`ThreadMember` The thread member asked for. """ member_data = await self._state.http.get_thread_member(self.id, member_id) return ThreadMember(parent=self, data=member_data) async def fetch_members(self) -> List[ThreadMember]: """|coro| Retrieves all :class:`ThreadMember` that are in this thread. This requires :attr:`Intents.members` to get information about members other than yourself. Raises ------ HTTPException Retrieving the members failed. Returns ------- List[:class:`ThreadMember`] All thread members in the thread. """ members = await self._state.http.get_thread_members(self.id) return [ThreadMember(parent=self, data=data) for data in members] async def delete(self, *, reason: Optional[str] = None) -> None: """|coro| Deletes this thread. You must have :attr:`~Permissions.manage_threads` to delete threads. Alternatively, you may delete a thread if it's in a :class:`ForumChannel`, you are the thread creator, and there are no messages other than the initial message. Parameters ---------- reason: Optional[:class:`str`] The reason for deleting this thread. Shows up on the audit log. .. versionadded:: 2.5 Raises ------ Forbidden You do not have permissions to delete this thread. HTTPException Deleting the thread failed. """ await self._state.http.delete_channel(self.id, reason=reason) async def add_tags(self, *tags: Snowflake, reason: Optional[str] = None) -> None: """|coro| Adds the given tags to this thread, up to 5 in total. The thread must be in a :class:`ForumChannel`. Adding tags requires you to have :attr:`.Permissions.manage_threads` permissions, or be the owner of the thread. However, adding :attr:`~ForumTag.moderated` tags always requires :attr:`.Permissions.manage_threads` permissions. .. versionadded:: 2.6 Parameters ---------- *tags: :class:`abc.Snowflake` An argument list of :class:`abc.Snowflake` representing the :class:`ForumTag`\\s to add to the thread. reason: Optional[:class:`str`] The reason for editing this thread. Shows up on the audit log. Raises ------ Forbidden You do not have permission to add these tags. HTTPException Editing the thread failed. """ if not tags: return new_tags: List[int] = self._applied_tags.copy() new_tags.extend(t.id for t in tags) new_tags = _unique(new_tags) await self._state.http.edit_channel(self.id, applied_tags=new_tags, reason=reason) async def remove_tags(self, *tags: Snowflake, reason: Optional[str] = None) -> None: """|coro| Removes the given tags from this thread. The thread must be in a :class:`ForumChannel`. Removing tags requires you to have :attr:`.Permissions.manage_threads` permissions, or be the owner of the thread. However, removing :attr:`~ForumTag.moderated` tags always requires :attr:`.Permissions.manage_threads` permissions. .. versionadded:: 2.6 Parameters ---------- *tags: :class:`abc.Snowflake` An argument list of :class:`abc.Snowflake` representing the :class:`ForumTag`\\s to remove from the thread. reason: Optional[:class:`str`] The reason for editing this thread. Shows up on the audit log. Raises ------ Forbidden You do not have permission to remove these tags. HTTPException Editing the thread failed. """ if not tags: return to_remove = {t.id for t in tags} new_tags: List[int] = [tag_id for tag_id in self._applied_tags if tag_id not in to_remove] await self._state.http.edit_channel(self.id, applied_tags=new_tags, reason=reason) def get_partial_message(self, message_id: int, /) -> PartialMessage: """Creates a :class:`PartialMessage` from the message ID. This is useful if you want to work with a message and only have its ID without doing an unnecessary API call. .. versionadded:: 2.0 Parameters ---------- message_id: :class:`int` The message ID to create a partial message for. Returns ------- :class:`PartialMessage` The partial message. """ from .message import PartialMessage return PartialMessage(channel=self, id=message_id) def _add_member(self, member: ThreadMember) -> None: self._members[member.id] = member def _pop_member(self, member_id: int) -> Optional[ThreadMember]: return self._members.pop(member_id, None) class ThreadMember(Hashable): """Represents a Discord thread member. .. container:: operations .. describe:: x == y Checks if two thread members are equal. .. describe:: x != y Checks if two thread members are not equal. .. describe:: hash(x) Returns the thread member's hash. .. describe:: str(x) Returns the thread member's name. .. versionadded:: 2.0 Attributes ---------- id: :class:`int` The thread member's ID. thread_id: :class:`int` The thread's ID. joined_at: :class:`datetime.datetime` The time the member joined the thread in UTC. """ __slots__ = ( "id", "thread_id", "joined_at", "flags", "_state", "parent", ) def __init__(self, parent: Thread, data: ThreadMemberPayload) -> None: self.parent = parent self._state = parent._state self._from_data(data) def __repr__(self) -> str: return ( f"" ) def _from_data(self, data: ThreadMemberPayload) -> None: try: self.id = int(data["user_id"]) except KeyError as err: if (self_id := self._state.self_id) is None: raise AssertionError("self_id is None when updating our own ThreadMember.") from err self.id = self_id try: self.thread_id = int(data["id"]) except KeyError: self.thread_id = self.parent.id self.joined_at = parse_time(data["join_timestamp"]) self.flags = data["flags"] @property def thread(self) -> Thread: """:class:`Thread`: The thread this member belongs to.""" return self.parent class ForumTag(Hashable): """Represents a tag for threads in forum channels. .. container:: operations .. describe:: x == y Checks if two tags are equal. .. describe:: x != y Checks if two tags are not equal. .. describe:: hash(x) Returns the tag's hash. .. describe:: str(x) Returns the tag's name. .. versionadded:: 2.6 Examples -------- Creating a new tag: .. code-block:: python3 tags = forum.available_tags tags.append(ForumTag(name="cool new tag", moderated=True)) await forum.edit(available_tags=tags) Editing an existing tag: .. code-block:: python3 tags = [] for tag in forum.available_tags: if tag.id == 1234: tag = tag.with_changes(name="whoa new name") tags.append(tag) await forum.edit(available_tags=tags) Attributes ---------- id: :class:`int` The tag's ID. Note that if this tag was manually constructed, this will be ``0``. name: :class:`str` The tag's name. moderated: :class:`bool` Whether only moderators can add this tag to threads or remove it. Defaults to ``False``. emoji: Optional[Union[:class:`Emoji`, :class:`PartialEmoji`]] The emoji associated with this tag, if any. Due to a Discord limitation, this will have an empty :attr:`~PartialEmoji.name` if it is a custom :class:`PartialEmoji`. """ __slots__ = ("id", "name", "moderated", "emoji") def __init__( self, *, name: str, emoji: Optional[Union[str, PartialEmoji, Emoji]] = None, moderated: bool = False, ) -> None: self.id: int = 0 self.name: str = name self.moderated: bool = moderated self.emoji: Optional[Union[Emoji, PartialEmoji]] = None if emoji is None: self.emoji = None elif isinstance(emoji, str): self.emoji = PartialEmoji.from_str(emoji) elif isinstance(emoji, _EmojiTag): self.emoji = emoji else: raise TypeError("emoji must be None, a str, PartialEmoji, or Emoji instance.") def __str__(self) -> str: return self.name def __repr__(self) -> str: return ( f"" ) def to_dict(self) -> PartialForumTagPayload: emoji_name, emoji_id = PartialEmoji._emoji_to_name_id(self.emoji) data: PartialForumTagPayload = { "name": self.name, "emoji_id": emoji_id, "emoji_name": emoji_name, "moderated": self.moderated, } if self.id: data["id"] = self.id return data @classmethod def _from_data(cls, *, data: ForumTagPayload, state: ConnectionState) -> Self: emoji = state._get_emoji_from_fields( name=data.get("emoji_name"), id=_get_as_snowflake(data, "emoji_id"), ) self = cls( name=data["name"], emoji=emoji, moderated=data["moderated"], ) self.id = int(data["id"]) return self def with_changes( self, *, name: str = MISSING, emoji: Optional[Union[str, Emoji, PartialEmoji]] = MISSING, moderated: bool = MISSING, ) -> Self: """Returns a new instance with the given changes applied, for easy use with :func:`ForumChannel.edit`. All other fields will be kept intact. Returns ------- :class:`ForumTag` The new tag instance. """ new_self = self.__class__( name=self.name if name is MISSING else name, emoji=self.emoji if emoji is MISSING else emoji, moderated=self.moderated if moderated is MISSING else moderated, ) new_self.id = self.id return new_self