matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add roles parameter for pruning members.

Browse Source
This commit is contained in:
unknown 2020-04-29 16:09:20 +02:00 committed by Rapptz
parent 1f73e18bc6
commit b7c7c86a6b
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
discord/guild.py
View File

@ -1282,7 +1282,7 @@ class Guild(Hashable):
reason=e['reason']) reason=e['reason'])
for e in data] for e in data]
async def prune_members(self, *, days, compute_prune_count=True, reason=None): async def prune_members(self, *, days, compute_prune_count=True, roles=None, reason=None):
r"""|coro| r"""|coro|
Prunes the guild from its inactive members. Prunes the guild from its inactive members.
@ -1296,6 +1296,11 @@ class Guild(Hashable):
To check how many members you would prune without actually pruning, To check how many members you would prune without actually pruning,
see the :meth:`estimate_pruned_members` function. see the :meth:`estimate_pruned_members` function.
To prune members that have specific roles see the ``roles`` parameter.
.. versionchanged:: 1.4
The ``roles`` keyword-only parameter was added.
Parameters Parameters
----------- -----------
days: :class:`int` days: :class:`int`
@ -1307,6 +1312,9 @@ class Guild(Hashable):
which makes it prone to timeouts in very large guilds. In order which makes it prone to timeouts in very large guilds. In order
to prevent timeouts, you must set this to ``False``. If this is to prevent timeouts, you must set this to ``False``. If this is
set to ``False``\, then this function will always return ``None``. set to ``False``\, then this function will always return ``None``.
roles: Optional[List[:class:`abc.Snowflake`]]
A list of :class:`abc.Snowflake` that represent roles to include in the pruning process. If a member
has a role that is not specified, they'll be excluded.
Raises Raises
------- -------
@ -1327,7 +1335,10 @@ class Guild(Hashable):
if not isinstance(days, int): if not isinstance(days, int):
raise InvalidArgument('Expected int for ``days``, received {0.__class__.__name__} instead.'.format(days)) raise InvalidArgument('Expected int for ``days``, received {0.__class__.__name__} instead.'.format(days))
data = await self._state.http.prune_members(self.id, days, compute_prune_count=compute_prune_count, reason=reason) if roles:
roles = [role.id for role in roles]
data = await self._state.http.prune_members(self.id, days, compute_prune_count=compute_prune_count, roles=roles, reason=reason)
return data['pruned'] return data['pruned']
async def webhooks(self): async def webhooks(self):

5
discord/http.py
View File

@ -657,10 +657,11 @@ class HTTPClient:
def get_member(self, guild_id, member_id): def get_member(self, guild_id, member_id):
return self.request(Route('GET', '/guilds/{guild_id}/members/{member_id}', guild_id=guild_id, member_id=member_id)) return self.request(Route('GET', '/guilds/{guild_id}/members/{member_id}', guild_id=guild_id, member_id=member_id))
def prune_members(self, guild_id, days, compute_prune_count, *, reason=None): def prune_members(self, guild_id, days, compute_prune_count, roles, *, reason=None):
params = { params = {
'days': days, 'days': days,
'compute_prune_count': 'true' if compute_prune_count else 'false' 'compute_prune_count': 'true' if compute_prune_count else 'false',
'include_roles': roles
} }
return self.request(Route('POST', '/guilds/{guild_id}/prune', guild_id=guild_id), params=params, reason=reason) return self.request(Route('POST', '/guilds/{guild_id}/prune', guild_id=guild_id), params=params, reason=reason)