Compare commits
2
Commits
v0.1.0
..
7935ea4511
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7935ea4511 | ||
|
|
48de7d7065 |
@@ -28,11 +28,11 @@ from dpy_logger import DPYLogger
|
|||||||
|
|
||||||
bot.log = DPYLogger(
|
bot.log = DPYLogger(
|
||||||
bot, guild_id, channel_id,
|
bot, guild_id, channel_id,
|
||||||
colors=log_colors, # optional; merged over sensible defaults
|
colors=cfg.log_colors, # optional; merged over sensible defaults
|
||||||
pings=authorized_devs, # mentioned on critical()
|
pings=cfg.authorized_devs, # mentioned on critical()
|
||||||
timezone=tz,
|
timezone=cfg.timezone,
|
||||||
footer=bot_footer,
|
footer=cfg.bot_footer,
|
||||||
avatar=bot_avatar,
|
avatar=cfg.bot_avatar,
|
||||||
)
|
)
|
||||||
await bot.log.initialize() # resolves ids -> objects, call once
|
await bot.log.initialize() # resolves ids -> objects, call once
|
||||||
|
|
||||||
@@ -70,13 +70,10 @@ 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) raise `ValueError` at
|
||||||
— a misconfigured logger should fail loudly at setup. The raised type is usually
|
`initialize`/call time — a misconfigured logger should fail loudly at setup. Per-call
|
||||||
`ValueError`, but an underlying `discord` exception (`NotFound` / `Forbidden` /
|
**send** failures do **not** propagate: they fall back to the stdlib logger so a
|
||||||
`HTTPException`) from `fetch_guild`/`fetch_channel` can also propagate. On a **per-call**
|
transient Discord failure never breaks the caller's command.
|
||||||
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
|
## Construction contract
|
||||||
|
|
||||||
|
|||||||
@@ -12,11 +12,11 @@ command that mutates bot.settings changes routing without a restart.
|
|||||||
|
|
||||||
bot.log = DPYLogger(
|
bot.log = DPYLogger(
|
||||||
bot, guild_id, channel_id,
|
bot, guild_id, channel_id,
|
||||||
colors=log_colors, # optional, falls back to defaults
|
colors=cfg.log_colors, # optional, falls back to defaults
|
||||||
pings=authorized_devs, # mentioned on critical()
|
pings=cfg.authorized_devs, # mentioned on critical()
|
||||||
timezone=tz,
|
timezone=cfg.timezone,
|
||||||
footer=bot_footer,
|
footer=cfg.bot_footer,
|
||||||
avatar=bot_avatar,
|
avatar=cfg.bot_avatar,
|
||||||
)
|
)
|
||||||
await bot.log.initialize() # resolves ids -> objects
|
await bot.log.initialize() # resolves ids -> objects
|
||||||
await bot.log.success("user promoted", action="promote", actor=ctx.author)
|
await bot.log.success("user promoted", action="promote", actor=ctx.author)
|
||||||
@@ -41,10 +41,9 @@ extending: this base has no feed/announcement method by design. a project
|
|||||||
that wants one subclasses DPYLogger and adds it, reusing _resolve.
|
that wants one subclasses DPYLogger and adds it, reusing _resolve.
|
||||||
|
|
||||||
errors: resolution failures (unresolvable guild/channel, bad config) raise
|
errors: resolution failures (unresolvable guild/channel, bad config) raise
|
||||||
ValueError from `initialize()` — a misconfigured logger should fail loudly at
|
ValueError at initialize/call time — a misconfigured logger should fail loudly.
|
||||||
setup. on a per-call send, resolution AND send failures do NOT propagate: they
|
per-call send failures do NOT propagate: they fall back to the stdlib logger so
|
||||||
fall back to the stdlib logger so a transient discord failure (or a per-call
|
a transient discord failure never breaks the caller's command.
|
||||||
`guild=` that doesn't resolve) never breaks the caller's command.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
@@ -129,7 +128,7 @@ class DPYLogger:
|
|||||||
if not guild:
|
if not guild:
|
||||||
raise ValueError("[dpy_logger] cannot resolve channel without a guild")
|
raise ValueError("[dpy_logger] cannot resolve channel without a guild")
|
||||||
|
|
||||||
if not override and getattr(guild, "id", guild) == getattr(self.guild, "id", self.guild):
|
if not override and guild == self.guild:
|
||||||
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):
|
||||||
|
|||||||
Reference in New Issue
Block a user