Documenting the network backend API#699
Merged
lovelydinosaur merged 18 commits intomasterfrom Jun 7, 2023
Merged
Conversation
lovelydinosaur
added
the
documentation
Contributor
Author
|
This is ready for review from a docs-first perspective. |
Kludex
reviewed
May 25, 2023
Co-authored-by: Florimond Manca <florimond.manca@protonmail.com>
…cumented top-level API now
Contributor
Author
|
I've now updated the API in this pull request, in line with the docs so it's possible to properly work through the examples... Documentation: https://github.com/encode/httpcore/blob/network-backends-api/docs/network-backends.md Install from this branch in order to work through... $ python -m venv venv
$ venv/bin/pip install git+https://github.com/encode/httpcore.git@network-backends-api
$ venv/bin/python |
Contributor
Author
|
I've bumped a bunch of items into possible follow-ons. |
karpetrosyan
approved these changes
May 26, 2023
Contributor
Author
|
I have bumped out the following conversations on the back of this... |
Contributor
Author
|
Okay, let's have it. Thanks all for the review time on this. 😊 |
This was referenced Jun 14, 2023
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
4 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.
This pull request adds the network backends as public API.
This will help our users understand the architecture of
httpcore, allow for more in depth debugging, and allow for complex use cases such as network record/replay or custom DNS handling.The documentation I'm adding here doesn't follow the existing (internal) class names, but instead takes a docs-first approach to
TODO:
Ensure UDS case raises a descriptive warning if not implemented.- Already has aNotImplementedError.httpcore.backendscan become private.httpcore.<...>classes available, with conditionals forasynccases if needed.Notes to self:
start_tlsto in-place? (Would also need a docs update in extensions.md)sleepfrom the existing interface.AutoBackend?SOCKET_OPTIONSto the public API, because of the interface here.AsyncIOBackendnow.Closes #695