Compare commits
1
Commits
v0.1.1
..
9b6cf3bd05
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9b6cf3bd05 |
@@ -10,13 +10,13 @@ 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.1
|
dpy_logger @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_logger.git@v0.1.0
|
||||||
```
|
```
|
||||||
|
|
||||||
Direct:
|
Direct:
|
||||||
|
|
||||||
```bash
|
```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.0"
|
||||||
```
|
```
|
||||||
|
|
||||||
Requires `discord.py` (pulled transitively).
|
Requires `discord.py` (pulled transitively).
|
||||||
@@ -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
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "dpy_logger"
|
name = "dpy_logger"
|
||||||
version = "0.1.1"
|
version = "0.1.0"
|
||||||
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 = [
|
||||||
|
|||||||
@@ -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):
|
||||||
@@ -206,12 +205,8 @@ class DPYLogger:
|
|||||||
|
|
||||||
failure = fail
|
failure = fail
|
||||||
|
|
||||||
async def task(self, log, action=None, actor=None, guild=None, log_to_file=None):
|
async def task(self, log, action=None, guild=None, log_to_file=None):
|
||||||
"""log a task-level message with SYSTEM/TASK as the actor
|
"""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)
|
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):
|
async def critical(self, log, action=None, actor=None, guild=None, log_to_file=None):
|
||||||
|
|||||||
Reference in New Issue
Block a user