docs: document the aiohttp version requirement and its rationale - #255
Merged
Conversation
The aiohttp floor was raised to >=3.14.3 to clear known advisories in the HTTP parsers. Record the requirement in the README alongside the install instructions, where a consumer who pins aiohttp themselves will encounter it, and state the reason so the constraint isn't mistaken for an arbitrary version preference and pinned lower. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #254, which raised the
aiohttpfloor to>=3.14.3to clear 14 outstanding security advisories.Adds a
Requirementssubsection underInstallrecording both supported-version facts (Python >=3.11, aiohttp >=3.14.3) and, for aiohttp, why the floor is where it is — an out-of-bounds read in the C response parser triggerable by a malformed chunked response (CVE-2026-69244), plus other parser advisories.The rationale is the point of the note. Without it the floor reads as an arbitrary version preference, and the failure mode is a consumer pinning
aiohttpbelow 3.14.3 in their own project and silently reintroducing the vulnerability. Placing it beside the install instructions puts it where someone who pins their own dependencies will meet it before making that choice, rather than after.Testing
Documentation-only change; no source or packaging files touched. CI sequence run locally regardless:
poetry run ruff check→ all checks passedpoetry run ruff format --check→ 13 files already formattedpoetry run pytest→ 30 passed🤖 Generated with Claude Code