Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1ea1cb5b63 | ||
|
|
43f82d2774 | ||
|
|
bfabd1c31d | ||
|
|
3cb741f668 | ||
|
|
7b98214c68 | ||
|
|
a633138e4e | ||
|
|
3a580e8239 |
+1
-1
@@ -1,5 +1,5 @@
|
||||
# claude
|
||||
CLAUDE.md
|
||||
.claude/
|
||||
|
||||
# python
|
||||
__pycache__/
|
||||
|
||||
@@ -10,17 +10,19 @@ live from `bot.settings` so it can change at runtime via a command.
|
||||
`requirements.txt`:
|
||||
|
||||
```
|
||||
dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.1
|
||||
dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.4
|
||||
```
|
||||
|
||||
Direct:
|
||||
|
||||
```bash
|
||||
pip install "dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.1"
|
||||
pip install "dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.4"
|
||||
```
|
||||
|
||||
Requires `discord.py` (pulled transitively).
|
||||
|
||||
Drop the `@v0.1.4` suffix from the line above to install the latest unpinned.
|
||||
|
||||
## Usage
|
||||
|
||||
```python
|
||||
@@ -70,13 +72,13 @@ await bot.log.debug("noisy", log_to_file=False) # -> Discord only
|
||||
|
||||
## Errors
|
||||
|
||||
Resolution failures (unresolvable guild/channel, bad config) raise from `initialize()`
|
||||
— a misconfigured logger should fail loudly at setup. The raised type is usually
|
||||
`ValueError`, but an underlying `discord` exception (`NotFound` / `Forbidden` /
|
||||
`HTTPException`) from `fetch_guild`/`fetch_channel` can also propagate. On a **per-call**
|
||||
send, neither resolution nor send failures propagate: they fall back to the stdlib
|
||||
logger so a transient Discord failure (or a per-call `guild=` that doesn't resolve)
|
||||
never breaks the caller's command.
|
||||
Resolution failures (unresolvable guild/channel, bad config, a non-text channel) raise
|
||||
`ValueError` from `initialize()` — a misconfigured logger should fail loudly at setup.
|
||||
Underlying `discord` exceptions (`NotFound` / `Forbidden` / `HTTPException`) from
|
||||
`fetch_guild`/`fetch_channel` are normalized to that `ValueError` so callers see one
|
||||
error type. On a **per-call** send, neither resolution nor send failures propagate: they
|
||||
fall back to the stdlib logger so a transient Discord failure (or a per-call `guild=`
|
||||
that doesn't resolve) never breaks the caller's command.
|
||||
|
||||
## Construction contract
|
||||
|
||||
@@ -139,4 +141,4 @@ class FeedLogger(DPYLogger):
|
||||
|
||||
## Versioning
|
||||
|
||||
Tagged `vX.Y.Z`. Pin the tag in `requirements.txt`.
|
||||
Releases are tagged `vX.Y.Z`. The install line above pins a release; drop the `@vX.Y.Z` suffix to install the latest unpinned. Pin deliberately for reproducible installs.
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "dpy_logger"
|
||||
version = "0.1.1"
|
||||
version = "0.1.4"
|
||||
description = "Leveled Discord channel logger for discord.py — config-free, injectable, installable."
|
||||
requires-python = ">=3.10"
|
||||
dependencies = [
|
||||
|
||||
@@ -111,15 +111,29 @@ class DPYLogger:
|
||||
if not self.guild:
|
||||
raise ValueError(f"[dpy_logger] cannot resolve channel {self.channel} without a guild")
|
||||
self.channel = await self._get_channel(self.guild)
|
||||
# a channel object passed with no guild (e.g. bot.get_channel(id)) would pass
|
||||
# setup silently but then fail every send at _get_guild(None) — swallowed, so
|
||||
# nothing reaches discord. derive the guild from the channel it already carries,
|
||||
# or fail loud at setup (matching the int-channel guard above) rather than later.
|
||||
if self.guild is None and isinstance(self.channel, discord.TextChannel):
|
||||
self.guild = self.channel.guild
|
||||
if self.guild is None and self.channel is not None:
|
||||
raise ValueError("[dpy_logger] channel provided without a resolvable guild")
|
||||
|
||||
async def _get_guild(self, guild):
|
||||
"""resolve a guild from id-or-object, raising if unresolvable"""
|
||||
if guild:
|
||||
if isinstance(guild, int):
|
||||
resolved = self.bot.get_guild(guild) or await self.bot.fetch_guild(guild)
|
||||
if not resolved:
|
||||
raise ValueError(f"[dpy_logger] failed to fetch guild {guild}")
|
||||
return resolved
|
||||
resolved = self.bot.get_guild(guild)
|
||||
if resolved is not None:
|
||||
return resolved
|
||||
# fetch_guild never returns None — it raises NotFound/Forbidden/
|
||||
# HTTPException; normalize those to the lib's ValueError so callers see
|
||||
# one error type at setup
|
||||
try:
|
||||
return await self.bot.fetch_guild(guild)
|
||||
except discord.HTTPException as error:
|
||||
raise ValueError(f"[dpy_logger] failed to fetch guild {guild}: {error}") from error
|
||||
if isinstance(guild, discord.Guild):
|
||||
return guild
|
||||
raise ValueError("[dpy_logger] no guild available for logging")
|
||||
@@ -133,16 +147,26 @@ class DPYLogger:
|
||||
if isinstance(self.channel, discord.TextChannel):
|
||||
return self.channel
|
||||
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:
|
||||
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:
|
||||
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):
|
||||
"""build the embed for a log call
|
||||
@@ -155,11 +179,19 @@ class DPYLogger:
|
||||
if self._embed_builder is not None:
|
||||
return self._embed_builder(self, level, action, actor, details)
|
||||
em = discord.Embed(color=self.colors[level])
|
||||
if action:
|
||||
# test `is not None` so a falsy-but-valid value (0, False) still renders; only a
|
||||
# genuinely absent field (None) or an empty string is dropped/substituted below
|
||||
if action is not None and str(action) != "":
|
||||
em.add_field(name="Action", value=f"`{action}`", inline=True)
|
||||
if actor:
|
||||
if actor is not None and str(actor) != "":
|
||||
em.add_field(name="Actor", value=f"`{actor}`", inline=True)
|
||||
em.add_field(name="Log", value=details, inline=False)
|
||||
# discord rejects an empty field value (50035) and truncates nothing itself, so
|
||||
# an empty or >1024-char message would 400 the send; substitute + cap to keep
|
||||
# every logging call producing a valid embed
|
||||
log_value = str(details) if details is not None and str(details) != "" else "(no message)"
|
||||
if len(log_value) > 1024:
|
||||
log_value = log_value[:1021] + "..."
|
||||
em.add_field(name="Log", value=log_value, inline=False)
|
||||
em.timestamp = datetime.now(self.timezone)
|
||||
em.set_footer(text=f"{self.footer} Logging".strip(), icon_url=self.avatar)
|
||||
return em
|
||||
@@ -170,20 +202,28 @@ class DPYLogger:
|
||||
|
||||
def _emit_stdlib(self, level, action, actor, log_msg):
|
||||
"""mirror the log line to the stdlib logger (routed to file/console by the app)"""
|
||||
parts = [p for p in (action, str(actor) if actor else None, log_msg) if p]
|
||||
# render falsy-but-valid parts (0, False); drop only genuinely-absent (None) ones
|
||||
raw = (action, str(actor) if actor is not None else None, log_msg)
|
||||
parts = [str(p) for p in raw if p is not None and str(p) != ""]
|
||||
_log.log(LEVEL_MAP.get(level, logging.INFO), f"[{level}] " + " | ".join(parts))
|
||||
|
||||
async def _send(self, level, log_msg, action=None, actor=None, guild=None, log_to_file=None):
|
||||
async def _send(self, level, log_msg, action=None, actor=None, guild=None,
|
||||
log_to_file=None, content=None):
|
||||
"""resolve channel and dispatch a leveled embed; mirror to stdlib unless opted out
|
||||
|
||||
stdlib emit happens first so the record survives even if the discord send fails.
|
||||
a failed send falls back to stdlib rather than propagating into the caller.
|
||||
`content` carries the critical-level ping/@here text (None for the other levels),
|
||||
so every level shares this one send/error contract.
|
||||
"""
|
||||
if self.log_to_file if log_to_file is None else log_to_file:
|
||||
self._emit_stdlib(level, action, actor, log_msg)
|
||||
try:
|
||||
channel = await self._resolve(guild)
|
||||
return await channel.send(embed=self.build_embed(level, action, actor, log_msg))
|
||||
return await channel.send(
|
||||
content=content,
|
||||
embed=self.build_embed(level, action, actor, log_msg),
|
||||
)
|
||||
except Exception:
|
||||
_log.exception(f"[dpy_logger] failed to send {level} log: {log_msg}")
|
||||
return None
|
||||
@@ -215,21 +255,15 @@ class DPYLogger:
|
||||
return await self._send("task", log, action, "SYSTEM/TASK", guild, log_to_file)
|
||||
|
||||
async def critical(self, log, action=None, actor=None, guild=None, log_to_file=None):
|
||||
"""log a critical-level message and ping configured devs"""
|
||||
if self.log_to_file if log_to_file is None else log_to_file:
|
||||
self._emit_stdlib("critical", action, actor, log)
|
||||
"""log a critical-level message and ping configured devs
|
||||
|
||||
delegates to _send with the ping/@here content so the send + error contract has a
|
||||
single source of truth; critical only adds the alert `content`.
|
||||
"""
|
||||
if self.pings:
|
||||
content = "alert: " + " ".join(f"<@{u}>" for u in self.pings)
|
||||
elif self.alert_here:
|
||||
content = "alert: @here"
|
||||
else:
|
||||
content = None
|
||||
try:
|
||||
channel = await self._resolve(guild)
|
||||
return await channel.send(
|
||||
content=content,
|
||||
embed=self.build_embed("critical", action, actor, log),
|
||||
)
|
||||
except Exception:
|
||||
_log.exception(f"[dpy_logger] failed to send critical log: {log}")
|
||||
return None
|
||||
return await self._send("critical", log, action, actor, guild, log_to_file, content)
|
||||
|
||||
Reference in New Issue
Block a user