Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add httpx.NetworkOptions configuration. #3052

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Conversation

tomchristie
Copy link
Member

@tomchristie tomchristie commented Jan 12, 2024

Refs #947 (comment)

Here's how the proposed documentation looks...


Network Options

There are several advanced network options that are made available through the httpx.NetworkOptions configuration class.

# Configure an HTTPTransport with some specific network options.
network_options = httpx.NetworkOptions(
    connection_retries=1,
    local_address="0.0.0.0",
)
transport = httpx.HTTPTransport(network_options=network_options)

# Instantiate a client with the configured transport.
client = httpx.Client(transport=transport)

Configuration

The options available on this class are...

connection_retries

Configure a number of retries that may be attempted when initially establishing a TCP connection. Defaults to 0.

local_address

Configure the local address that the socket should be bound too. The most common usage is for enforcing binding to either IPv4 local_address="0.0.0.0" or IPv6 local_address="::".

socket_options

TODO: Example

uds

Connect to a Unix Domain Socket, rather than over the network. Should be a string providing the path to the UDS.


Design options that we have here...

  • We could allow a httpx.Client(network_options=...) shortcut, in the same way we do for eg. ssl_context=..., proxy=..., limits=..., version=....
  • We could have Limits and NetworkOptions all be part of the same single config class. Including max_keepalive_connections, max_connections, keepalive_expiry on this class.

@tomchristie tomchristie added the 1.0 proposal Pull requests proposing 1.0 API changes label Jan 12, 2024
@tomchristie tomchristie changed the title Add NetworkOptions Add httpx.NetworkOptions configuration. Jan 12, 2024
@tomchristie tomchristie mentioned this pull request Jan 12, 2024
@jeffsilverm
Copy link

jeffsilverm commented Jan 16, 2024

I would like to ask that something be added to the documentation at advanced usage, please. I would like you to add something such as: "This is how you force httpx to use IPv4 even if it can use IPv6. Using IPv6 is the default. My proposed change will make it so that if somebody searches for "IPv4", it will be found. Currently, it was very hard to find until I was told what to look for. Of course, once I was told what to look for, it was immediately obvious. Thank you.

Commendation to karpetrosyan for his quick response to my question!

My earlier comment about IPv4 mapped IPv6 addresses is not a function of httpx. It is a "feature" of nginx. I was able to verify using tcpdump that httpx works correctly as explained to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0 proposal Pull requests proposing 1.0 API changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants