rethink-public/dpy_logger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: DL-1 validate the int-path channel is a TextChannel; normalize fetch errors

Browse Source 
the construction-channel int path now applies the same isinstance(TextChannel) check the
settings path enforces, so a Voice/Category/Forum channel fails loud at setup instead of
AttributeError-ing on .send later. settings-path fetch_channel discord exceptions
normalize to ValueError; README error contract updated to match.

Signed-off-by: disqualifier <dev@disqualifier.me>
This commit is contained in:
disqualifier 2026-06-29 21:35:00 -04:00
parent 7b98214c68
commit 3cb741f668
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -72,13 +72,13 @@ await bot.log.debug("noisy", log_to_file=False) # -> Discord only
## Errors ## Errors
Resolution failures (unresolvable guild/channel, bad config) raise from `initialize()` Resolution failures (unresolvable guild/channel, bad config, a non-text channel) raise
— a misconfigured logger should fail loudly at setup. The raised type is usually `ValueError` from `initialize()` — a misconfigured logger should fail loudly at setup.
`ValueError`, but an underlying `discord` exception (`NotFound` / `Forbidden` / Underlying `discord` exceptions (`NotFound` / `Forbidden` / `HTTPException`) from
`HTTPException`) from `fetch_guild`/`fetch_channel` can also propagate. On a **per-call** `fetch_guild`/`fetch_channel` are normalized to that `ValueError` so callers see one
send, neither resolution nor send failures propagate: they fall back to the stdlib error type. On a **per-call** send, neither resolution nor send failures propagate: they
logger so a transient Discord failure (or a per-call `guild=` that doesn't resolve) fall back to the stdlib logger so a transient Discord failure (or a per-call `guild=`
never breaks the caller's command. that doesn't resolve) never breaks the caller's command.
## Construction contract ## Construction contract

20
src/dpy_logger/dpy_logger.py
View File

@ -139,16 +139,26 @@ class DPYLogger:
if isinstance(self.channel, discord.TextChannel): if isinstance(self.channel, discord.TextChannel):
return self.channel return self.channel
if isinstance(self.channel, int): if isinstance(self.channel, int):
return await guild.fetch_channel(self.channel) channel = await guild.fetch_channel(self.channel)
if not isinstance(channel, discord.TextChannel):
# fetch_channel can return a Voice/Category/Forum channel; fail loud
# at setup like the settings path, not later via an AttributeError on .send
raise ValueError(f"[dpy_logger] channel {self.channel} is not a text channel")
return channel
try: try:
channel_id = self.bot.settings[guild.id]["channels"]["logs"] channel_id = self.bot.settings[guild.id]["channels"]["logs"]
channel = await guild.fetch_channel(channel_id)
if not isinstance(channel, discord.TextChannel):
raise ValueError(f"[dpy_logger] configured channel {channel_id} is not a text channel")
return channel
except KeyError: except KeyError:
raise ValueError(f"[dpy_logger] no log channel configured for guild {guild.id}") raise ValueError(f"[dpy_logger] no log channel configured for guild {guild.id}")
try:
channel = await guild.fetch_channel(channel_id)
except discord.HTTPException as error:
# fetch_channel raises NotFound/Forbidden/HTTPException; normalize to the
# lib's ValueError so a bad configured id fails loud with one error type
raise ValueError(f"[dpy_logger] could not fetch channel {channel_id}: {error}") from error
if not isinstance(channel, discord.TextChannel):
raise ValueError(f"[dpy_logger] configured channel {channel_id} is not a text channel")
return channel
def build_embed(self, level, action, actor, details): def build_embed(self, level, action, actor, details):
"""build the embed for a log call """build the embed for a log call