rethink-public/dpy_webhooks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: annotate send/send_any as Optional[WebhookMessage], document wait=True (dpywebhooks-2)

Browse Source 
Both were annotated -> discord.WebhookMessage and README-documented that
way, but discord.py's Webhook.send defaults wait=False and returns None
unless the caller passes wait=True - so the annotation overpromised and a
consumer chaining .id off the result without knowing to pass wait=True would
get an AttributeError. Widen both annotations to Optional and add a
one-line note (module docstring + README) on the wait=True requirement.

Signed-off-by: disqualifier <dev@disqualifier.me>
This commit is contained in:
dsql
2026-07-06 00:15:11 -04:00
parent ee3c38972b
commit 94b25d51ce
2 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -4
View File
@@ -21,6 +21,10 @@ await hooks.send(channel, content="hi", embeds=[e]) # get-or-create + send
wh = await hooks.get_or_create(channel) # reuse the webhook directly
```
`send`/`send_any` forward `wait` straight to discord.py's `Webhook.send`, which defaults
`wait=False` and returns `None` in that case; pass `wait=True` to get back the sent
`discord.WebhookMessage` (e.g. to read `.id` or edit it later).
With a persistence store so webhooks survive a restart:
```python
@@ -72,14 +76,15 @@ The module docstring (`help(dpy_webhooks)` / IDE hover) is the source of truth.
- `get_or_create(channel, *, evict_oldest=False) -> discord.Webhook`
- `get(channel) -> discord.Webhook | None` — cache then store; never creates
- `send(channel, **kwargs) -> discord.WebhookMessage` — get-or-create then send, with
self-heal
- `send(channel, **kwargs) -> discord.WebhookMessage | None` — get-or-create then send, with
self-heal; `None` unless `wait=True`
- `clear(channel) -> None` — delete server-side + store record (idempotent)
- `count(channel) -> int` — webhooks currently on the channel
- `list(channel) -> list[discord.Webhook]` — all live webhooks on the channel (no create)
- `pick(channel, *, strategy="first") -> discord.Webhook | None` — select an existing one
- `send_any(channel, *, strategy="round_robin", **kwargs) -> discord.WebhookMessage` — send
via a picked existing webhook, falling back to `get_or_create`
- `send_any(channel, *, strategy="round_robin", **kwargs) -> discord.WebhookMessage | None` —
send via a picked existing webhook, falling back to `get_or_create`; `None` unless
`wait=True`
**Self-heal.** If `send` hits a dead webhook (deleted server-side / invalid token), the lib
clears the record, recreates the webhook, and retries the send **once**; a second failure