release: 1.0.0

first stable release. pre-1.0.0 verification complete: all surviving MED regressions and
gaps resolved and independently re-fired, tree audited clean across the suite.

Signed-off-by: disqualifier <dev@disqualifier.me>

README.md

@@ -13,16 +13,16 @@ send to the core — inheriting rotation, proxy, retry, and result for free.
 ## Install
 
 ```
-aiowebhooks @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiowebhooks.git@v0.1.5
+aiowebhooks @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiowebhooks.git@v1.0.0
 # discord embeds / identity helpers need the extra:
-aiowebhooks[discord] @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiowebhooks.git@v0.1.5
+aiowebhooks[discord] @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiowebhooks.git@v1.0.0
 ```
 
 The base pulls `aiohttp` and `commons` (for the retry/backoff engine). Only
-`aiowebhooks[discord]` adds `discord.py` (>=2.3, mainline — not discord.py-self), and
+`aiowebhooks[discord]` adds `discord.py` (>=2.3, mainline, not discord.py-self), and
 only for `DiscordWebhook`.
 
-Drop the `@v0.1.5` suffix from the line above to install the latest unpinned.
+Drop the `@v1.0.0` suffix from the line above to install the latest unpinned.
 
 ## Core sender
 
@@ -148,6 +148,30 @@ Without the extra installed, importing `aiowebhooks` still works; constructing o
 
 ## Changelog
 
+### v0.1.8
+
+- Compressed 5 residual internal/trivial docstrings (`MAX_RETRY_AFTER`, `_Retryable`,
+  `_proxy_string`, `_retry_after`, `_attempt`) to one or two lines; no behavior change.
+
+### v0.1.7
+
+- Docstrings/comments compressed (module docstrings and internal-method prose); no
+  behavior change. Public method contracts (`Webhook.send`, `WebhookResult` field
+  docs) are unchanged.
+- Em-dash characters replaced with hyphens across the source.
+
+### v0.1.6
+
+- **429 `retry_after` no longer sleeps on an exhausted final attempt:** the wait is
+  now carried to the START of the next attempt instead of slept immediately after
+  seeing the 429. Previously the last (exhausted) attempt slept the full
+  `retry_after` before giving up — a pointless wait since no retry followed. The
+  wait is still honored (additive with aretry's backoff) before every attempt that
+  actually runs.
+- Docs: `errors.py` no longer implies the missing-`[discord]`-extra raise is one of
+  the exported error types — it's a plain `RuntimeError`.
+- Docstrings/comments compressed; no behavior change.
+
 ### v0.1.5
 
 - **429 `retry_after` bounded:** a non-finite server-controlled wait (`inf`/`nan`, from

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "aiowebhooks"
-version = "0.1.5"
+version = "1.0.0"
 description = "async webhook sender (aiohttp) with round-robin urls, retry, and proxy rotation; optional discord.py embeds"
 requires-python = ">=3.10"
 dependencies = [

src/aiowebhooks/__init__.py

@@ -1,24 +1,19 @@
-"""aiowebhooks — async webhook sender (aiohttp), optional discord.py embeds.
+"""aiowebhooks - async webhook sender (aiohttp), optional discord.py embeds.
 
-post a json payload to a webhook url (or a round-robin pool) with 429/5xx retry and
+post a json payload to a webhook url (or round-robin pool); every send returns a
-optional proxy rotation; every send returns a WebhookResult and never raises on a
+WebhookResult and never raises on a send failure. see README for usage. the
-send failure. the [discord] extra adds DiscordWebhook (username/avatar + Embed
+[discord] extra adds DiscordWebhook (aiowebhooks.discord).
-handling) layered over the same core.
-
-    from aiowebhooks import Webhook
-
-    wh = Webhook("https://example.com/hook")
-    result = await wh.send({"content": "hello"})
-    if not result.ok:
-        ...
-
-DiscordWebhook lives in aiowebhooks.discord and needs the [discord] extra.
 """
 
+from importlib.metadata import PackageNotFoundError, version
+
 from .errors import NoUrlsError, WebhookError
 from .result import WebhookResult
 from .sender import Webhook
 
 __all__ = ["Webhook", "WebhookResult", "WebhookError", "NoUrlsError"]
 
-__version__ = "0.1.4"
+try:
+    __version__ = version("aiowebhooks")
+except PackageNotFoundError:
+    __version__ = "0.0.0+unknown"

src/aiowebhooks/discord.py

@@ -2,9 +2,8 @@
 
 `DiscordWebhook` wraps a core `Webhook`, adds discord identity (username/avatar,
 overridable per send) and `Embed` handling, builds the discord webhook json, and
-delegates the POST to the core — inheriting rotation / proxy / retry / result.
+delegates the POST to the core. importing this module without discord.py installed
-importing this module without discord.py installed is fine; constructing or sending
+is fine; constructing or sending raises a clear RuntimeError naming the extra.
-raises a clear RuntimeError naming the extra.
 """
 
 import logging
@@ -25,7 +24,7 @@ _MISSING = "discord support requires aiowebhooks[discord]"
 
 
 class DiscordWebhook:
-    """discord webhook sender — builds payloads, delegates sending to a core Webhook"""
+    """discord webhook sender - builds payloads, delegates sending to a core Webhook"""
 
     def __init__(
         self,

src/aiowebhooks/errors.py

@@ -1,10 +1,8 @@
 """exception types for aiowebhooks.
 
-these are surfaced for callers that want to branch on a specific failure cause.
+`Webhook.send` never raises on a send failure (returns `WebhookResult(ok=False)`
-note the core `Webhook.send` does NOT raise on a send failure — it returns a
+instead); these cover bad construction. the missing-`[discord]`-extra path raises a
-`WebhookResult` with `ok=False` and the cause captured in `error`. these types
+plain `RuntimeError`, not one of these.
-exist for the few raise paths (bad construction, missing extra) and as a base for
-any future raising surface.
 """
 
 

src/aiowebhooks/result.py

@@ -1,9 +1,4 @@
-"""the result object every send returns.
+"""the result object every send returns; `Webhook.send` never raises, callers branch on `ok`."""
-
-`Webhook.send` never raises on a send failure; it always returns a `WebhookResult`.
-callers branch on `result.ok`. success and every failure mode (4xx/5xx, timeout,
-exhausted proxies) populate the same shape so call sites stay uniform.
-"""
 
 from dataclasses import dataclass
 from typing import Dict, Optional, Union

src/aiowebhooks/sender.py

@@ -1,15 +1,9 @@
 """core async webhook sender (aiohttp only, no discord knowledge).
 
 `Webhook` posts a JSON dict to a url (or round-robins a pool), handling 429/5xx
-retries, connection/timeout retries, and optional proxy rotation, and always
+retries, connection/timeout retries, and optional proxy rotation; always returns a
-returns a `WebhookResult` — it never raises on a send failure. the discord layer
+`WebhookResult`, never raises on a send failure. the discord layer delegates its
-builds payloads and delegates the actual POST here so it inherits rotation / proxy
+POST here so it inherits rotation/proxy/retry/result.
-/ retry / result.
-
-a 429's server-controlled `retry_after` wait is bounded: non-finite values
-(inf/nan) are rejected and finite values are clamped to `MAX_RETRY_AFTER`, so an
-adversarial or misconfigured server can never stall a send() past a bounded
-ceiling.
 """
 
 import asyncio
@@ -27,23 +21,11 @@ from .result import WebhookResult
 log = logging.getLogger(__name__)
 
 MAX_RETRY_AFTER = 300.0
-"""ceiling (seconds) honored from a server-controlled 429 retry_after/Retry-After
+"""ceiling (seconds) honored from a 429 retry_after/Retry-After; non-finite values (inf/nan) rejected outright"""
-
-a server can send an arbitrarily large or non-finite wait (float('inf'), a
-Cloudflare-scale value, or a ms-vs-s unit mismatch turning 5s into 5000s); sleeping
-that verbatim would stall a send() far past its ClientTimeout and outside
-max_retries accounting, breaking the 'always returns a WebhookResult' contract.
-non-finite values are rejected outright (treated as unparseable); finite values are
-clamped to this ceiling.
-"""
 
 
 class _Retryable(Exception):
-    """internal signal: a retryable HTTP status (429/5xx); carries the response
+    """internal signal for commons.aretry on a retryable 429/5xx, carrying the real response"""
-
-    raised inside an attempt so commons.aretry drives the backoff + cap; the loop
-    catches the final one to return the REAL last response, not a synthetic result.
-    """
 
     def __init__(self, result: WebhookResult):
         super().__init__(f"retryable status {result.status}")
@@ -51,11 +33,7 @@ class _Retryable(Exception):
 
 
 def _proxy_string(proxies_dict: Optional[Dict[str, str]]) -> Optional[str]:
-    """canonical host:port:user:pass (or host:port) from an aiohttp proxies dict
+    """canonical host:port:user:pass (or host:port) from an aiohttp proxies dict, or None if unparseable"""
-
-    duck-typed: reads whatever the provider's get() returned without importing it.
-    returns None if the dict is empty or unparseable.
-    """
     if not proxies_dict:
         return None
     url = proxies_dict.get("http") or proxies_dict.get("https")
@@ -108,12 +86,7 @@ class Webhook:
 
     @staticmethod
     def _retry_after(status: int, headers, body) -> Optional[float]:
-        """seconds to wait on a 429, from body retry_after then Retry-After header
+        """seconds to wait on a 429 from body retry_after then Retry-After header, clamped to MAX_RETRY_AFTER"""
-
-        non-finite values (inf/nan) are rejected as unparseable; finite values are
-        clamped to MAX_RETRY_AFTER so a server-controlled wait can never stall a
-        send() past a bounded ceiling.
-        """
         if status != 429:
             return None
         if isinstance(body, dict) and body.get("retry_after") is not None:
@@ -156,30 +129,19 @@ class Webhook:
     async def _send_loop(
         self, session: aiohttp.ClientSession, url: str, payload: Dict
     ) -> WebhookResult:
-        """status-retry (via commons.aretry) wrapping proxy rotation; never raises
+        """status-retry (commons.aretry, on _Retryable) wrapping proxy rotation; never raises"""
-
-        commons.aretry owns the 429/5xx/no-provider-connection-error backoff schedule
-        + retry cap (max_retries), retrying on the internal _Retryable signal. on
-        exhaustion it re-raises the last _Retryable, whose carried result is the REAL
-        last response (not a synthetic status-0). proxy rotation on connection errors
-        lives inside the attempt and is capped separately (max_proxy_retries); once a
-        provider's rotation cap is hit that failure is terminal, not retried again
-        via aretry.
-        """
         counter = [0]
+        pending_wait: List[Optional[float]] = [None]
         try:
             return await aretry(
-                lambda: self._attempt(session, url, payload, counter),
+                lambda: self._attempt(session, url, payload, counter, pending_wait),
                 attempts=self.max_retries + 1,
                 on=(_Retryable,),
             )
         except _Retryable as exhausted:
             return exhausted.result
         except Exception as error:
-            # never-raises safety net: an unexpected error that escapes the attempt (a
+            # never-raises net: anything else (closed session, bad proxy url, ...) -> failed result
-            # closed injected session -> RuntimeError, a malformed proxy url -> ValueError,
-            # anything not aiohttp.ClientError/TimeoutError) must come back as a failed
-            # result, not propagate out of send()
             log.warning("webhook send failed unexpectedly on %s: %s", url, error, exc_info=True)
             return WebhookResult(
                 ok=False, status=None, url=url, attempts=counter[0] or 1,
@@ -187,28 +149,24 @@ class Webhook:
             )
 
     async def _attempt(
-        self, session: aiohttp.ClientSession, url: str, payload: Dict, counter: List[int]
+        self, session: aiohttp.ClientSession, url: str, payload: Dict, counter: List[int],
+        pending_wait: List[Optional[float]],
     ) -> WebhookResult:
         """one logical send: proxy rotation + a single POST; may raise _Retryable
 
-        raises _Retryable (carrying the real response) on a 429/5xx so the caller's
+        `counter`/`pending_wait` are per-call mutable cells threaded from `_send_loop`, not
-        aretry applies backoff; honors an explicit 429 retry_after by sleeping it
+        instance state - a plain local wouldn't survive aretry calling this fresh each retry.
-        before signalling. a connection/timeout error also raises _Retryable when no
-        proxy provider is set, so it retries under aretry's backoff + max_retries
-        instead of failing one-shot; with a provider, the same error first drives
-        burn+rotate up to max_proxy_retries, and only becomes terminal (not retried
-        via aretry) once that cap is hit. returns a final WebhookResult on success or
-        a terminal (non-retryable) failure — never lets a provider error escape.
-
-        `counter` is a per-call mutable cell ([0]) owned by the calling `_send_loop`,
-        so the attempt count is local to one `send()` and concurrent sends on the
-        same instance don't corrupt each other's tally.
         """
         timeout = aiohttp.ClientTimeout(total=self.timeout)
         last_proxy: Optional[str] = None
         proxy_tries = 0
 
         while True:
+            if pending_wait[0] is not None:
+                wait = pending_wait[0]
+                pending_wait[0] = None
+                log.warning("webhook 429 on %s; honoring retry_after %.3fs", url, wait)
+                await asyncio.sleep(wait)
             counter[0] += 1
             attempts = counter[0]
             proxy_url = None
@@ -216,8 +174,7 @@ class Webhook:
                 try:
                     proxy_dict = self._proxies.get()
                 except Exception:
-                    # duck-typed provider; any error from get() means no proxy is
+                    # duck-typed provider: any get() error means no proxy available
-                    # available — fail cleanly rather than escaping send().
                     log.warning("webhook: proxy get() failed; no proxy available",
                                 exc_info=True)
                     return WebhookResult(
@@ -246,19 +203,11 @@ class Webhook:
                     )
 
                     if status == 429:
-                        # every 429 is retryable; honor an explicit retry_after by
+                        # every 429 retries; retry_after (if any) is carried to the NEXT
-                        # sleeping it, but a 429 with no parseable wait (edge/Cloudflare/
+                        # attempt's sleep, additive with aretry's backoff
-                        # generic webhook) still retries under aretry's backoff + cap.
-                        # note: aretry ALSO sleeps its backoff between retries, so an
-                        # honored retry_after is additive (retry_after + backoff) — this
-                        # only ever over-waits, never under-waits the server's hint.
-                        # non-finite values (inf/nan) are rejected and finite values are
-                        # clamped to MAX_RETRY_AFTER by _retry_after, so a server-controlled
-                        # wait can never stall this attempt past a bounded ceiling
                         wait = self._retry_after(status, resp.headers, body)
                         if wait is not None:
-                            log.warning("webhook 429 on %s; honoring retry_after %.3fs", url, wait)
+                            pending_wait[0] = wait
-                            await asyncio.sleep(wait)
                         else:
                             log.warning("webhook 429 on %s; no retry_after, backing off", url)
                         raise _Retryable(result)
@@ -280,27 +229,14 @@ class Webhook:
                         ok=False, status=None, url=url, attempts=attempts,
                         error=f"{type(error).__name__}: {error}", proxy=last_proxy,
                     )
-                # no proxy provider: a connection/timeout error is the single most
+                # no proxy provider: retry like a 5xx, under aretry's backoff + max_retries
-                # retry-worthy failure class (the 5xx equivalent already retries under
-                # aretry) — raise _Retryable so aretry applies backoff + max_retries
-                # instead of failing one-shot. aretry re-raises this same _Retryable on
-                # exhaustion, and _send_loop's `except _Retryable` returns its carried
-                # result, so the never-raises / always-returns-a-WebhookResult contract
-                # still holds after retries run out.
                 raise _Retryable(WebhookResult(
                     ok=False, status=None, url=url, attempts=attempts,
                     error=f"{type(error).__name__}: {error}", proxy=last_proxy,
                 ))
 
     def _burn(self, proxy: Optional[str]) -> bool:
-        """burn the current proxy; return False if it can't be rotated
+        """burn the current proxy; return False (never raise) if it can't be rotated"""
-
-        the provider is duck-typed and never imported, so we cannot catch its
-        exception types by class. ANY exception from burn (a ProxiesExhaustedError
-        on a dead pool, a ValueError when the proxy isn't in the pool, etc.) means
-        we can't rotate — return False so the caller ends the loop with a failed
-        result rather than letting it escape send() (which must never raise).
-        """
         try:
             self._proxies.burn(proxy)
             return True