Docs on local_address wildcards (#147)

encode · Aug 11, 2020 · bf88f29 · bf88f29
1 parent d82896b
commit bf88f29
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/httpcore/_async/connection_pool.py b/httpcore/_async/connection_pool.py
@@ -77,7 +77,11 @@ class AsyncConnectionPool(AsyncHTTPTransport):
     * **keepalive_expiry** - `Optional[float]` - The maximum time to allow
     before closing a keep-alive connection.
     * **http2** - `bool` - Enable HTTP/2 support.
-    * **local_address** - `Optional[str]` - Local address to connect from.
+    * **local_address** - `Optional[str]` - Local address to connect from. Can
+    also be used to connect using a particular address family. Using
+    `local_address="0.0.0.0"` will connect using an `AF_INET` address (IPv4),
+    while using `local_address="::"` will connect using an `AF_INET6` address
+    (IPv6).
     """
 
     def __init__(

diff --git a/httpcore/_sync/connection_pool.py b/httpcore/_sync/connection_pool.py
@@ -77,7 +77,11 @@ class SyncConnectionPool(SyncHTTPTransport):
     * **keepalive_expiry** - `Optional[float]` - The maximum time to allow
     before closing a keep-alive connection.
     * **http2** - `bool` - Enable HTTP/2 support.
-    * **local_address** - `Optional[str]` - Local address to connect from.
+    * **local_address** - `Optional[str]` - Local address to connect from. Can
+    also be used to connect using a particular address family. Using
+    `local_address="0.0.0.0"` will connect using an `AF_INET` address (IPv4),
+    while using `local_address="::"` will connect using an `AF_INET6` address
+    (IPv6).
     """
 
     def __init__(