aboutsummaryrefslogtreecommitdiffstats
path: root/botcore/utils/members.py
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2022-11-05 13:39:52 +0000
committerGravatar Chris Lovering <[email protected]>2022-11-05 14:05:00 +0000
commit962968fecedca3bef33ba9524d87ffedf815f16d (patch)
tree3dd7b6c6cae4f01c8a5aae3e2371bd3a5e9dd0e7 /botcore/utils/members.py
parentUpdate pyproject.toml module meta data (diff)
Rename package due to naming conflict
Diffstat (limited to 'botcore/utils/members.py')
-rw-r--r--botcore/utils/members.py57
1 files changed, 0 insertions, 57 deletions
diff --git a/botcore/utils/members.py b/botcore/utils/members.py
deleted file mode 100644
index 1536a8d1..00000000
--- a/botcore/utils/members.py
+++ /dev/null
@@ -1,57 +0,0 @@
-"""Useful helper functions for interactin with :obj:`discord.Member` objects."""
-import typing
-from collections import abc
-
-import discord
-
-from botcore.utils import logging
-
-log = logging.get_logger(__name__)
-
-
-async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> typing.Optional[discord.Member]:
- """
- Attempt to get a member from cache; on failure fetch from the API.
-
- Returns:
- The :obj:`discord.Member` or :obj:`None` to indicate the member could not be found.
- """
- if member := guild.get_member(member_id):
- log.trace(f"{member} retrieved from cache.")
- else:
- try:
- member = await guild.fetch_member(member_id)
- except discord.errors.NotFound:
- log.trace(f"Failed to fetch {member_id} from API.")
- return None
- log.trace(f"{member} fetched from API.")
- return member
-
-
-async def handle_role_change(
- member: discord.Member,
- coro: typing.Callable[[discord.Role], abc.Coroutine],
- role: discord.Role
-) -> None:
- """
- Await the given ``coro`` with ``role`` as the sole argument.
-
- Handle errors that we expect to be raised from
- :obj:`discord.Member.add_roles` and :obj:`discord.Member.remove_roles`.
-
- Args:
- member: The member that is being modified for logging purposes.
- coro: This is intended to be :obj:`discord.Member.add_roles` or :obj:`discord.Member.remove_roles`.
- role: The role to be passed to ``coro``.
- """
- try:
- await coro(role)
- except discord.NotFound:
- log.error(f"Failed to change role for {member} ({member.id}): member not found")
- except discord.Forbidden:
- log.error(
- f"Forbidden to change role for {member} ({member.id}); "
- f"possibly due to role hierarchy"
- )
- except discord.HTTPException as e:
- log.error(f"Failed to change role for {member} ({member.id}): {e.status} {e.code}")