docs: Document the transport-hook contract and the built-in HTTPX client - #1013
Open
vdusek wants to merge 7 commits into
Open
docs: Document the transport-hook contract and the built-in HTTPX client#1013vdusek wants to merge 7 commits into
vdusek wants to merge 7 commits into
Conversation
vdusek
added
adhoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1013 +/- ##
==========================================
- Coverage 95.29% 95.27% -0.02%
==========================================
Files 59 59
Lines 5501 5501
==========================================
- Hits 5242 5241 -1
- Misses 259 260 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
vdusek
force-pushed
the
docs-custom-http-client-guide
branch
from
August 17, 2026 20:30
424c3f0 to
7d38520
Compare
vdusek
changed the base branch from
fix-transport-retry-classification
to
master
August 18, 2026 18:23
vdusek
force-pushed
the
docs-custom-http-client-guide
branch
from
August 19, 2026 06:25
7d38520 to
71bfaa3
Compare
This was referenced Aug 19, 2026
vdusek
force-pushed
the
docs-custom-http-client-guide
branch
from
August 19, 2026 06:57
71bfaa3 to
e51e3bd
Compare
github-actions
Bot
added
the
tested
vdusek
changed the title
vdusek
marked this pull request as ready for review
August 19, 2026 07:07
vdusek
marked this pull request as draft
August 19, 2026 07:45
vdusek
force-pushed
the
docs-custom-http-client-guide
branch
from
August 19, 2026 16:37
e51e3bd to
ccfd59f
Compare
vdusek
force-pushed
the
docs-custom-http-client-guide
branch
from
August 20, 2026 06:14
ccfd59f to
fe6130b
Compare
vdusek
added a commit
that referenced
this pull request
Aug 27, 2026
Adds `HttpxHttpClient` / `HttpxHttpClientAsync` as built-in alternatives to the default Impit transport, behind an optional extra: `pip install "apify-client[httpx]"`. Impit stays the default. The transport is [HTTPX2](https://github.com/pydantic/httpx2), Pydantic's maintained continuation of HTTPX (stable HTTPX has been parked at 0.28.1 since Dec 2024). The module imports it as `httpx`, so the client keeps the plain `Httpx*` naming. It verifies TLS via the OS trust store (`truststore`) rather than `certifi`. The adapters plug into the shared request pipeline from #1022 and implement only the transport hooks (`send_request`, `is_retryable_transport_error`, `is_timeout_error`, `close()` / `aclose()`), applying the same retry policy as Impit: every error from the library's own hierarchy is transient except the permanently-failing types. A response event hook keeps the shared cookie jar from leaking server cookies into later API requests. Unit tests run the built-in client matrix (Impit + HTTPX) through the parametrized fixtures. Note that HTTPX applies timeouts per socket operation, not to the request as a whole, so a slowly-arriving body can outlast the requested timeout. Impit enforces a whole-request deadline. Both class docstrings record this. Stack: #1022 (merged) → **#1004 (this)** → #1013 (docs — its `apify-client[httpx]` install lines now match; only the `conda-forge::httpx` line still points at the stale package instead of `httpx2`). *✍️ Drafted by Claude Code*
…ient-guide #1004 landed on master, so its files come from there: the HTTPX client, its tests, the `httpx` extra, and the README install note are taken from master's merged version, leaving this branch docs-only.
vdusek
marked this pull request as ready for review
August 27, 2026 11:07
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
2 participants
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.
Rewrites the HTTP clients concepts page around the three-layer hierarchy and the transport hooks, documents the built-in HTTPX client from #1004 (installation, sync/async examples, timeout semantics), and replaces the old HTTPX guide with "Build a custom HTTP client", which implements full AIOHTTP and requests clients including response adapters for the
HttpResponseprotocol.Stack: #1022 (pipeline) → #1004 (HTTPX client) → #1013 (this). Split out of #1006.
✍️ Drafted by Claude Code