mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 20:28:38 +00:00
Code Issues Projects Releases Wiki Activity

Add reason to Thread.delete_messages and Thread.purge

Browse Source
This commit is contained in:
Rapptz 2022-04-02 10:36:39 -04:00
parent 994660faad
commit b049cf77f2
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
discord/threads.py
View File

@ -367,7 +367,7 @@ class Thread(Messageable, Hashable):
raise ClientException('Parent channel not found') raise ClientException('Parent channel not found')
return parent.permissions_for(obj) return parent.permissions_for(obj)
async def delete_messages(self, messages: Iterable[Snowflake], /) -> None: async def delete_messages(self, messages: Iterable[Snowflake], /, *, reason: Optional[str] = None) -> None:
"""|coro| """|coro|
Deletes a list of messages. This is similar to :meth:`Message.delete` Deletes a list of messages. This is similar to :meth:`Message.delete`
@ -383,12 +383,12 @@ class Thread(Messageable, Hashable):
You must have the :attr:`~Permissions.manage_messages` permission to You must have the :attr:`~Permissions.manage_messages` permission to
use this. use this.
Usable only by bot accounts.
Parameters Parameters
----------- -----------
messages: Iterable[:class:`abc.Snowflake`] messages: Iterable[:class:`abc.Snowflake`]
An iterable of messages denoting which ones to bulk delete. An iterable of messages denoting which ones to bulk delete.
reason: Optional[:class:`str`]
The reason for deleting the messages. Shows up on the audit log.
Raises Raises
------ ------
@ -410,14 +410,14 @@ class Thread(Messageable, Hashable):
if len(messages) == 1: if len(messages) == 1:
message_id = messages[0].id message_id = messages[0].id
await self._state.http.delete_message(self.id, message_id) await self._state.http.delete_message(self.id, message_id, reason=reason)
return return
if len(messages) > 100: if len(messages) > 100:
raise ClientException('Can only bulk delete messages up to 100 messages') raise ClientException('Can only bulk delete messages up to 100 messages')
message_ids: SnowflakeList = [m.id for m in messages] message_ids: SnowflakeList = [m.id for m in messages]
await self._state.http.delete_messages(self.id, message_ids) await self._state.http.delete_messages(self.id, message_ids, reason=reason)
async def purge( async def purge(
self, self,
@ -429,6 +429,7 @@ class Thread(Messageable, Hashable):
around: Optional[SnowflakeTime] = None, around: Optional[SnowflakeTime] = None,
oldest_first: Optional[bool] = False, oldest_first: Optional[bool] = False,
bulk: bool = True, bulk: bool = True,
reason: Optional[str] = None,
) -> List[Message]: ) -> List[Message]:
"""|coro| """|coro|
@ -472,6 +473,8 @@ class Thread(Messageable, Hashable):
If ``True``, use bulk delete. Setting this to ``False`` is useful for mass-deleting 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 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. fall back to single delete if messages are older than two weeks.
reason: Optional[:class:`str`]
The reason for purging the messages. Shows up on the audit log.
Raises Raises
------- -------
@ -495,7 +498,7 @@ class Thread(Messageable, Hashable):
minimum_time = int((time.time() - 14 * 24 * 60 * 60) * 1000.0 - 1420070400000) << 22 minimum_time = int((time.time() - 14 * 24 * 60 * 60) * 1000.0 - 1420070400000) << 22
async def _single_delete_strategy(messages: Iterable[Message]): async def _single_delete_strategy(messages: Iterable[Message], *, reason: Optional[str] = None):
for m in messages: for m in messages:
await m.delete() await m.delete()
@ -504,7 +507,7 @@ class Thread(Messageable, Hashable):
async for message in iterator: async for message in iterator:
if count == 100: if count == 100:
to_delete = ret[-100:] to_delete = ret[-100:]
await strategy(to_delete) await strategy(to_delete, reason=reason)
count = 0 count = 0
await asyncio.sleep(1) await asyncio.sleep(1)
@ -517,7 +520,7 @@ class Thread(Messageable, Hashable):
await ret[-1].delete() await ret[-1].delete()
elif count >= 2: elif count >= 2:
to_delete = ret[-count:] to_delete = ret[-count:]
await strategy(to_delete) await strategy(to_delete, reason=reason)
count = 0 count = 0
strategy = _single_delete_strategy strategy = _single_delete_strategy
@ -529,7 +532,7 @@ class Thread(Messageable, Hashable):
if count >= 2: if count >= 2:
# more than 2 messages -> bulk delete # more than 2 messages -> bulk delete
to_delete = ret[-count:] to_delete = ret[-count:]
await strategy(to_delete) await strategy(to_delete, reason=reason)
elif count == 1: elif count == 1:
# delete a single message # delete a single message
await ret[-1].delete() await ret[-1].delete()