Compare commits
6
Commits
7935ea4511
..
v0.1.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e20c7bbda3 | ||
|
|
f480a7c077 | ||
|
|
dd56009add | ||
|
|
988464ef12 | ||
|
|
7a5684e065 | ||
|
|
a90a0061b0 |
@@ -10,13 +10,13 @@ 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.0
|
||||
dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.1
|
||||
```
|
||||
|
||||
Direct:
|
||||
|
||||
```bash
|
||||
pip install "dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.0"
|
||||
pip install "dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.1"
|
||||
```
|
||||
|
||||
Requires `discord.py` (pulled transitively).
|
||||
@@ -28,11 +28,11 @@ from dpy_logger import DPYLogger
|
||||
|
||||
bot.log = DPYLogger(
|
||||
bot, guild_id, channel_id,
|
||||
colors=cfg.log_colors, # optional; merged over sensible defaults
|
||||
pings=cfg.authorized_devs, # mentioned on critical()
|
||||
timezone=cfg.timezone,
|
||||
footer=cfg.bot_footer,
|
||||
avatar=cfg.bot_avatar,
|
||||
colors=log_colors, # optional; merged over sensible defaults
|
||||
pings=authorized_devs, # mentioned on critical()
|
||||
timezone=tz,
|
||||
footer=bot_footer,
|
||||
avatar=bot_avatar,
|
||||
)
|
||||
await bot.log.initialize() # resolves ids -> objects, call once
|
||||
|
||||
@@ -70,10 +70,13 @@ await bot.log.debug("noisy", log_to_file=False) # -> Discord only
|
||||
|
||||
## Errors
|
||||
|
||||
Resolution failures (unresolvable guild/channel, bad config) raise `ValueError` at
|
||||
`initialize`/call time — a misconfigured logger should fail loudly at setup. Per-call
|
||||
**send** failures do **not** propagate: they fall back to the stdlib logger so a
|
||||
transient Discord failure never breaks the caller's command.
|
||||
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.
|
||||
|
||||
## Construction contract
|
||||
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "dpy_logger"
|
||||
version = "0.1.0"
|
||||
version = "0.1.1"
|
||||
description = "Leveled Discord channel logger for discord.py — config-free, injectable, installable."
|
||||
requires-python = ">=3.10"
|
||||
dependencies = [
|
||||
|
||||
@@ -12,11 +12,11 @@ command that mutates bot.settings changes routing without a restart.
|
||||
|
||||
bot.log = DPYLogger(
|
||||
bot, guild_id, channel_id,
|
||||
colors=cfg.log_colors, # optional, falls back to defaults
|
||||
pings=cfg.authorized_devs, # mentioned on critical()
|
||||
timezone=cfg.timezone,
|
||||
footer=cfg.bot_footer,
|
||||
avatar=cfg.bot_avatar,
|
||||
colors=log_colors, # optional, falls back to defaults
|
||||
pings=authorized_devs, # mentioned on critical()
|
||||
timezone=tz,
|
||||
footer=bot_footer,
|
||||
avatar=bot_avatar,
|
||||
)
|
||||
await bot.log.initialize() # resolves ids -> objects
|
||||
await bot.log.success("user promoted", action="promote", actor=ctx.author)
|
||||
@@ -41,9 +41,10 @@ extending: this base has no feed/announcement method by design. a project
|
||||
that wants one subclasses DPYLogger and adds it, reusing _resolve.
|
||||
|
||||
errors: resolution failures (unresolvable guild/channel, bad config) raise
|
||||
ValueError at initialize/call time — a misconfigured logger should fail loudly.
|
||||
per-call send failures do NOT propagate: they fall back to the stdlib logger so
|
||||
a transient discord failure never breaks the caller's command.
|
||||
ValueError from `initialize()` — a misconfigured logger should fail loudly at
|
||||
setup. on a per-call send, resolution AND send failures do NOT 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.
|
||||
"""
|
||||
|
||||
import logging
|
||||
@@ -128,7 +129,7 @@ class DPYLogger:
|
||||
if not guild:
|
||||
raise ValueError("[dpy_logger] cannot resolve channel without a guild")
|
||||
|
||||
if not override and guild == self.guild:
|
||||
if not override and getattr(guild, "id", guild) == getattr(self.guild, "id", self.guild):
|
||||
if isinstance(self.channel, discord.TextChannel):
|
||||
return self.channel
|
||||
if isinstance(self.channel, int):
|
||||
@@ -205,8 +206,12 @@ class DPYLogger:
|
||||
|
||||
failure = fail
|
||||
|
||||
async def task(self, log, action=None, guild=None, log_to_file=None):
|
||||
"""log a task-level message with SYSTEM/TASK as the actor"""
|
||||
async def task(self, log, action=None, actor=None, guild=None, log_to_file=None):
|
||||
"""log a task-level message with SYSTEM/TASK as the actor
|
||||
|
||||
actor is accepted for caller compatibility and ignored — task actions are
|
||||
always attributed to SYSTEM/TASK regardless of the caller-supplied actor
|
||||
"""
|
||||
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):
|
||||
|
||||
Reference in New Issue
Block a user