From 060bad105dc2569fc485adb03b985aa2ab5d367e Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Tue, 22 Feb 2022 23:47:09 +0000 Subject: Move new utilities to the util namespace --- botcore/utils/members.py | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 botcore/utils/members.py (limited to 'botcore/utils/members.py') diff --git a/botcore/utils/members.py b/botcore/utils/members.py new file mode 100644 index 00000000..abe7e5e1 --- /dev/null +++ b/botcore/utils/members.py @@ -0,0 +1,48 @@ +import typing + +import discord + +from botcore.utils import loggers + +log = loggers.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. + + Return `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[..., typing.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.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}") -- cgit v1.2.3 From aa2f9685c29d46a2666654c545d4461763c903b6 Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Wed, 23 Feb 2022 00:59:09 +0000 Subject: Alter docstrings to look better in autodocs --- botcore/utils/channel.py | 13 +++++++++++-- botcore/utils/extensions.py | 4 ++-- botcore/utils/loggers.py | 10 +++++----- botcore/utils/members.py | 14 +++++++++++--- botcore/utils/scheduling.py | 2 +- 5 files changed, 30 insertions(+), 13 deletions(-) (limited to 'botcore/utils/members.py') diff --git a/botcore/utils/channel.py b/botcore/utils/channel.py index 7e0fc387..6a630c94 100644 --- a/botcore/utils/channel.py +++ b/botcore/utils/channel.py @@ -1,4 +1,4 @@ -"""Utilities for interacting with discord channels.""" +"""Useful helper functions for interacting with various discord.py channel objects.""" import discord from discord.ext.commands import Bot @@ -9,7 +9,16 @@ log = loggers.get_logger(__name__) def is_in_category(channel: discord.TextChannel, category_id: int) -> bool: - """Return True if `channel` is within a category with `category_id`.""" + """ + Return whether the given channel has the category_id. + + Args: + channel: The channel to check. + category_id: The category to check for. + + Returns: + A bool depending on whether the channel is in the category. + """ return getattr(channel, "category_id", None) == category_id diff --git a/botcore/utils/extensions.py b/botcore/utils/extensions.py index c8f200ad..3f8d6e6d 100644 --- a/botcore/utils/extensions.py +++ b/botcore/utils/extensions.py @@ -9,7 +9,7 @@ from typing import NoReturn def unqualify(name: str) -> str: """ - Return an unqualified name given a qualified module/package `name`. + Return an unqualified name given a qualified module/package ``name``. Args: name: The module name to unqualify. @@ -22,7 +22,7 @@ def unqualify(name: str) -> str: def walk_extensions(module: types.ModuleType) -> frozenset[str]: """ - Yield extension names from the bot.exts subpackage. + Yield extension names from the given module. Args: module (types.ModuleType): The module to look for extensions in. diff --git a/botcore/utils/loggers.py b/botcore/utils/loggers.py index ac1db920..740c20d4 100644 --- a/botcore/utils/loggers.py +++ b/botcore/utils/loggers.py @@ -1,4 +1,4 @@ -"""Custom logging class.""" +"""Custom :obj:`logging.Logger` class that implements a new ``"TRACE"`` level.""" import logging import typing @@ -12,11 +12,11 @@ TRACE_LEVEL = 5 class CustomLogger(LoggerClass): - """Custom implementation of the `Logger` class with an added `trace` method.""" + """Custom implementation of the :obj:`logging.Logger` class with an added :obj:`trace` method.""" def trace(self, msg: str, *args, **kwargs) -> None: """ - Log 'msg % args' with severity 'TRACE'. + Log the given message with the severity ``"TRACE"``. To pass exception information, use the keyword argument exc_info with a true value: @@ -34,12 +34,12 @@ class CustomLogger(LoggerClass): def get_logger(name: typing.Optional[str] = None) -> CustomLogger: """ - Utility to make mypy recognise that logger is of type `CustomLogger`. + Utility to make mypy recognise that logger is of type :obj:`CustomLogger`. Args: name: The name given to the logger. Returns: - An instance of the `CustomLogger` class. + An instance of the :obj:`CustomLogger` class. """ return typing.cast(CustomLogger, logging.getLogger(name)) diff --git a/botcore/utils/members.py b/botcore/utils/members.py index abe7e5e1..e7b31342 100644 --- a/botcore/utils/members.py +++ b/botcore/utils/members.py @@ -1,3 +1,5 @@ +"""Useful helper functions for interactin with :obj:`discord.Member` objects.""" + import typing import discord @@ -11,7 +13,8 @@ async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> typing.Op """ Attempt to get a member from cache; on failure fetch from the API. - Return `None` to indicate the member could not be found. + 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.") @@ -31,9 +34,14 @@ async def handle_role_change( role: discord.Role ) -> None: """ - Change `member`'s cooldown role via awaiting `coro` and handle errors. + Await the given ``coro`` with ``member`` as the sole argument. + + Handle errors that we expect to be raised from + :obj:`discord.Member.add_roles` and :obj:`discord.Member.remove_roles`. - `coro` is intended to be `discord.Member.add_roles` or `discord.Member.remove_roles`. + Args: + member: The member to pass to ``coro``. + coro: This is intended to be :obj:`discord.Member.add_roles` or :obj:`discord.Member.remove_roles`. """ try: await coro(role) diff --git a/botcore/utils/scheduling.py b/botcore/utils/scheduling.py index 947df0d9..d6969302 100644 --- a/botcore/utils/scheduling.py +++ b/botcore/utils/scheduling.py @@ -215,7 +215,7 @@ def create_task( **kwargs, ) -> asyncio.Task: """ - Wrapper for creating asyncio `Tasks` which logs exceptions raised in the task. + Wrapper for creating an :obj:`asyncio.Task` which logs exceptions raised in the task. If the loop kwarg is provided, the task is created from that event loop, otherwise the running loop is used. -- cgit v1.2.3 From f7dac414b098900b340b2c36b0e69fce6b6c69ba Mon Sep 17 00:00:00 2001 From: Chris Lovering Date: Thu, 24 Feb 2022 16:10:47 +0000 Subject: Rename loggers.py to logging.py to allow for more generic utils in future --- botcore/utils/__init__.py | 4 ++-- botcore/utils/channel.py | 4 ++-- botcore/utils/loggers.py | 45 --------------------------------------------- botcore/utils/logging.py | 45 +++++++++++++++++++++++++++++++++++++++++++++ botcore/utils/members.py | 4 ++-- botcore/utils/scheduling.py | 6 +++--- 6 files changed, 54 insertions(+), 54 deletions(-) delete mode 100644 botcore/utils/loggers.py create mode 100644 botcore/utils/logging.py (limited to 'botcore/utils/members.py') diff --git a/botcore/utils/__init__.py b/botcore/utils/__init__.py index 554e8ad1..71354334 100644 --- a/botcore/utils/__init__.py +++ b/botcore/utils/__init__.py @@ -1,12 +1,12 @@ """Useful utilities and tools for discord bot development.""" -from botcore.utils import (caching, channel, extensions, loggers, members, regex, scheduling) +from botcore.utils import (caching, channel, extensions, logging, members, regex, scheduling) __all__ = [ caching, channel, extensions, - loggers, + logging, members, regex, scheduling, diff --git a/botcore/utils/channel.py b/botcore/utils/channel.py index 6a630c94..db155911 100644 --- a/botcore/utils/channel.py +++ b/botcore/utils/channel.py @@ -3,9 +3,9 @@ import discord from discord.ext.commands import Bot -from botcore.utils import loggers +from botcore.utils import logging -log = loggers.get_logger(__name__) +log = logging.get_logger(__name__) def is_in_category(channel: discord.TextChannel, category_id: int) -> bool: diff --git a/botcore/utils/loggers.py b/botcore/utils/loggers.py deleted file mode 100644 index 740c20d4..00000000 --- a/botcore/utils/loggers.py +++ /dev/null @@ -1,45 +0,0 @@ -"""Custom :obj:`logging.Logger` class that implements a new ``"TRACE"`` level.""" - -import logging -import typing - -if typing.TYPE_CHECKING: - LoggerClass = logging.Logger -else: - LoggerClass = logging.getLoggerClass() - -TRACE_LEVEL = 5 - - -class CustomLogger(LoggerClass): - """Custom implementation of the :obj:`logging.Logger` class with an added :obj:`trace` method.""" - - def trace(self, msg: str, *args, **kwargs) -> None: - """ - Log the given message with the severity ``"TRACE"``. - - To pass exception information, use the keyword argument exc_info with a true value: - - .. code-block:: py - - logger.trace("Houston, we have an %s", "interesting problem", exc_info=1) - - Args: - msg: The message to be logged. - args, kwargs: Passed to the base log function as is. - """ - if self.isEnabledFor(TRACE_LEVEL): - self.log(TRACE_LEVEL, msg, *args, **kwargs) - - -def get_logger(name: typing.Optional[str] = None) -> CustomLogger: - """ - Utility to make mypy recognise that logger is of type :obj:`CustomLogger`. - - Args: - name: The name given to the logger. - - Returns: - An instance of the :obj:`CustomLogger` class. - """ - return typing.cast(CustomLogger, logging.getLogger(name)) diff --git a/botcore/utils/logging.py b/botcore/utils/logging.py new file mode 100644 index 00000000..740c20d4 --- /dev/null +++ b/botcore/utils/logging.py @@ -0,0 +1,45 @@ +"""Custom :obj:`logging.Logger` class that implements a new ``"TRACE"`` level.""" + +import logging +import typing + +if typing.TYPE_CHECKING: + LoggerClass = logging.Logger +else: + LoggerClass = logging.getLoggerClass() + +TRACE_LEVEL = 5 + + +class CustomLogger(LoggerClass): + """Custom implementation of the :obj:`logging.Logger` class with an added :obj:`trace` method.""" + + def trace(self, msg: str, *args, **kwargs) -> None: + """ + Log the given message with the severity ``"TRACE"``. + + To pass exception information, use the keyword argument exc_info with a true value: + + .. code-block:: py + + logger.trace("Houston, we have an %s", "interesting problem", exc_info=1) + + Args: + msg: The message to be logged. + args, kwargs: Passed to the base log function as is. + """ + if self.isEnabledFor(TRACE_LEVEL): + self.log(TRACE_LEVEL, msg, *args, **kwargs) + + +def get_logger(name: typing.Optional[str] = None) -> CustomLogger: + """ + Utility to make mypy recognise that logger is of type :obj:`CustomLogger`. + + Args: + name: The name given to the logger. + + Returns: + An instance of the :obj:`CustomLogger` class. + """ + return typing.cast(CustomLogger, logging.getLogger(name)) diff --git a/botcore/utils/members.py b/botcore/utils/members.py index e7b31342..e89b4618 100644 --- a/botcore/utils/members.py +++ b/botcore/utils/members.py @@ -4,9 +4,9 @@ import typing import discord -from botcore.utils import loggers +from botcore.utils import logging -log = loggers.get_logger(__name__) +log = logging.get_logger(__name__) async def get_or_fetch_member(guild: discord.Guild, member_id: int) -> typing.Optional[discord.Member]: diff --git a/botcore/utils/scheduling.py b/botcore/utils/scheduling.py index d6969302..e2952e6c 100644 --- a/botcore/utils/scheduling.py +++ b/botcore/utils/scheduling.py @@ -7,7 +7,7 @@ import typing from datetime import datetime from functools import partial -from botcore.utils import loggers +from botcore.utils import logging class Scheduler: @@ -36,7 +36,7 @@ class Scheduler: """ self.name = name - self._log = loggers.get_logger(f"{__name__}.{name}") + self._log = logging.get_logger(f"{__name__}.{name}") self._scheduled_tasks: typing.Dict[typing.Hashable, asyncio.Task] = {} def __contains__(self, task_id: typing.Hashable) -> bool: @@ -242,5 +242,5 @@ def _log_task_exception(task: asyncio.Task, *, suppressed_exceptions: typing.Tup exception = task.exception() # Log the exception if one exists. if exception and not isinstance(exception, suppressed_exceptions): - log = loggers.get_logger(__name__) + log = logging.get_logger(__name__) log.error(f"Error in task {task.get_name()} {id(task)}!", exc_info=exception) -- cgit v1.2.3