From 06a704aae87ecd0d4a9e65263be25185eee66b69 Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 25 Dec 2021 22:11:49 +0000 Subject: Add member util functions This adds some useful utils, get_or_fetch and handle role change. These utils handle errors themselves, so can simplify implementations within the commands. --- bot/utils/members.py | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 bot/utils/members.py (limited to 'bot/utils/members.py') diff --git a/bot/utils/members.py b/bot/utils/members.py new file mode 100644 index 00000000..9c8c8dd8 --- /dev/null +++ b/bot/utils/members.py @@ -0,0 +1,47 @@ +import logging +import typing as t + +import discord + +log = logging.getLogger(__name__) + + +async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> t.Optional[discord.Member]: + """ + Attempt to get a member from cache; on failure fetch from the API. + + Return `None` to indicate the member could not be found. + """ + if member := guild.get_member(member_id): + log.trace("%s retrieved from cache.", member) + else: + try: + member = await guild.fetch_member(member_id) + except discord.errors.NotFound: + log.trace("Failed to fetch %d from API.", member_id) + return None + log.trace("%s fetched from API.", member) + return member + + +async def handle_role_change( + member: discord.Member, + coro: t.Callable[..., t.Coroutine], + role: discord.Role +) -> None: + """ + Change `member`'s cooldown role via awaiting `coro` and handle errors. + + `coro` is intended to be `discord.Member.add_roles` or `discord.Member.remove_roles`. + """ + try: + await coro(role) + except discord.NotFound: + log.debug(f"Failed to change role for {member} ({member.id}): member not found") + except discord.Forbidden: + log.debug( + 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}") -- cgit v1.2.3 From 0c043c825482578e4a940ce2a8f0d4b5a952fe29 Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Wed, 29 Dec 2021 13:35:10 +0000 Subject: Raise error when bot can't modify the given role in member helper util --- bot/utils/members.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'bot/utils/members.py') diff --git a/bot/utils/members.py b/bot/utils/members.py index 9c8c8dd8..de5850ca 100644 --- a/bot/utils/members.py +++ b/bot/utils/members.py @@ -39,7 +39,7 @@ async def handle_role_change( except discord.NotFound: log.debug(f"Failed to change role for {member} ({member.id}): member not found") except discord.Forbidden: - log.debug( + log.error( f"Forbidden to change role for {member} ({member.id}); " f"possibly due to role hierarchy" ) -- cgit v1.2.3