Compare commits
No commits in common. "main" and "v0.1.1" have entirely different histories.
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,5 +1,5 @@
|
|||||||
# claude
|
# claude
|
||||||
.claude/
|
CLAUDE.md
|
||||||
|
|
||||||
# python
|
# python
|
||||||
__pycache__/
|
__pycache__/
|
||||||
|
|||||||
22
README.md
22
README.md
@ -10,19 +10,17 @@ live from `bot.settings` so it can change at runtime via a command.
|
|||||||
`requirements.txt`:
|
`requirements.txt`:
|
||||||
|
|
||||||
```
|
```
|
||||||
dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.2
|
dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Direct:
|
Direct:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install "dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.2"
|
pip install "dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
Requires `discord.py` (pulled transitively).
|
Requires `discord.py` (pulled transitively).
|
||||||
|
|
||||||
Drop the `@v0.1.2` suffix from the line above to install the latest unpinned.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```python
|
```python
|
||||||
@ -72,13 +70,13 @@ await bot.log.debug("noisy", log_to_file=False) # -> Discord only
|
|||||||
|
|
||||||
## Errors
|
## Errors
|
||||||
|
|
||||||
Resolution failures (unresolvable guild/channel, bad config, a non-text channel) raise
|
Resolution failures (unresolvable guild/channel, bad config) raise from `initialize()`
|
||||||
`ValueError` from `initialize()` — a misconfigured logger should fail loudly at setup.
|
— a misconfigured logger should fail loudly at setup. The raised type is usually
|
||||||
Underlying `discord` exceptions (`NotFound` / `Forbidden` / `HTTPException`) from
|
`ValueError`, but an underlying `discord` exception (`NotFound` / `Forbidden` /
|
||||||
`fetch_guild`/`fetch_channel` are normalized to that `ValueError` so callers see one
|
`HTTPException`) from `fetch_guild`/`fetch_channel` can also propagate. On a **per-call**
|
||||||
error type. On a **per-call** send, neither resolution nor send failures propagate: they
|
send, neither resolution nor send failures propagate: they fall back to the stdlib
|
||||||
fall back to the stdlib logger so a transient Discord failure (or a per-call `guild=`
|
logger so a transient Discord failure (or a per-call `guild=` that doesn't resolve)
|
||||||
that doesn't resolve) never breaks the caller's command.
|
never breaks the caller's command.
|
||||||
|
|
||||||
## Construction contract
|
## Construction contract
|
||||||
|
|
||||||
@ -141,4 +139,4 @@ class FeedLogger(DPYLogger):
|
|||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
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.
|
Tagged `vX.Y.Z`. Pin the tag in `requirements.txt`.
|
||||||
|
|||||||
@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "dpy_logger"
|
name = "dpy_logger"
|
||||||
version = "0.1.2"
|
version = "0.1.1"
|
||||||
description = "Leveled Discord channel logger for discord.py — config-free, injectable, installable."
|
description = "Leveled Discord channel logger for discord.py — config-free, injectable, installable."
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
|||||||
@ -116,16 +116,10 @@ class DPYLogger:
|
|||||||
"""resolve a guild from id-or-object, raising if unresolvable"""
|
"""resolve a guild from id-or-object, raising if unresolvable"""
|
||||||
if guild:
|
if guild:
|
||||||
if isinstance(guild, int):
|
if isinstance(guild, int):
|
||||||
resolved = self.bot.get_guild(guild)
|
resolved = self.bot.get_guild(guild) or await self.bot.fetch_guild(guild)
|
||||||
if resolved is not None:
|
if not resolved:
|
||||||
|
raise ValueError(f"[dpy_logger] failed to fetch guild {guild}")
|
||||||
return resolved
|
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):
|
if isinstance(guild, discord.Guild):
|
||||||
return guild
|
return guild
|
||||||
raise ValueError("[dpy_logger] no guild available for logging")
|
raise ValueError("[dpy_logger] no guild available for logging")
|
||||||
@ -139,26 +133,16 @@ 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):
|
||||||
channel = await guild.fetch_channel(self.channel)
|
return 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"]
|
||||||
except KeyError:
|
|
||||||
raise ValueError(f"[dpy_logger] no log channel configured for guild {guild.id}")
|
|
||||||
try:
|
|
||||||
channel = await guild.fetch_channel(channel_id)
|
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):
|
if not isinstance(channel, discord.TextChannel):
|
||||||
raise ValueError(f"[dpy_logger] configured channel {channel_id} is not a text channel")
|
raise ValueError(f"[dpy_logger] configured channel {channel_id} is not a text channel")
|
||||||
return channel
|
return channel
|
||||||
|
except KeyError:
|
||||||
|
raise ValueError(f"[dpy_logger] no log channel configured for guild {guild.id}")
|
||||||
|
|
||||||
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
|
||||||
@ -175,13 +159,7 @@ class DPYLogger:
|
|||||||
em.add_field(name="Action", value=f"`{action}`", inline=True)
|
em.add_field(name="Action", value=f"`{action}`", inline=True)
|
||||||
if actor:
|
if actor:
|
||||||
em.add_field(name="Actor", value=f"`{actor}`", inline=True)
|
em.add_field(name="Actor", value=f"`{actor}`", inline=True)
|
||||||
# discord rejects an empty field value (50035) and truncates nothing itself, so
|
em.add_field(name="Log", value=details, inline=False)
|
||||||
# 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 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.timestamp = datetime.now(self.timezone)
|
||||||
em.set_footer(text=f"{self.footer} Logging".strip(), icon_url=self.avatar)
|
em.set_footer(text=f"{self.footer} Logging".strip(), icon_url=self.avatar)
|
||||||
return em
|
return em
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user