]> git.ipfire.org Git - thirdparty/httpx.git/commitdiff
Drop proxies parameter from the high level API (#485)
authorYeray Diaz Diaz <yeraydiazdiaz@fastmail.com>
Sat, 19 Oct 2019 12:51:27 +0000 (13:51 +0100)
committerFlorimond Manca <florimond.manca@gmail.com>
Sat, 19 Oct 2019 12:51:27 +0000 (14:51 +0200)
* Drop `proxies` argument from high level API

* Update state of Digest auth in docs

* Add note on not supporting proxies at request level

* Grammar tweak

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>
docs/advanced.md
docs/index.md
httpx/api.py

index e4aa3acf59def1f19af26b4843e46447b17709fa..327edbd17d6f0860b276141a741da43ce73b1a31 100644 (file)
@@ -198,6 +198,11 @@ with httpx.Client(proxies=proxy) as client:
     r = client.get("http://example.com")
 ```
 
+!!! note
+
+    Per request proxy configuration, i.e. `client.get(url, proxies=...)`,
+    has not been implemented yet. To use proxies you must pass the proxy
+    information at `Client` initialization.
 
 ## Timeout fine-tuning
 HTTPX offers various request timeout management options. Three types of timeouts are available: **connect** timeouts, 
index 84e25543c58eeeac6f05a28aa8d15a14af0718c8..b09394b1396eb13aab0ae54fa2138395a3c0a341 100644 (file)
@@ -66,7 +66,7 @@ Plus all the standard features of `requests`...
 * Keep-Alive & Connection Pooling
 * Sessions with Cookie Persistence
 * Browser-style SSL Verification
-* Basic/Digest Authentication *(Digest is still TODO)*
+* Basic/Digest Authentication
 * Elegant Key/Value Cookies
 * Automatic Decompression
 * Automatic Content Decoding
index 3afb65faf013ad788a737489b431d23bb86beb56..5d134b0c9a309455d8bd3f26b53ccb65b27812b8 100644 (file)
@@ -6,7 +6,6 @@ from .models import (
     AuthTypes,
     CookieTypes,
     HeaderTypes,
-    ProxiesTypes,
     QueryParamTypes,
     RequestData,
     RequestFiles,
@@ -32,7 +31,6 @@ def request(
     verify: VerifyTypes = True,
     stream: bool = False,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     with Client(http_versions=["HTTP/1.1"]) as client:
         return client.request(
@@ -67,7 +65,6 @@ def get(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "GET",
@@ -98,7 +95,6 @@ def options(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "OPTIONS",
@@ -129,7 +125,6 @@ def head(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "HEAD",
@@ -163,7 +158,6 @@ def post(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "POST",
@@ -200,7 +194,6 @@ def put(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "PUT",
@@ -237,7 +230,6 @@ def patch(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "PATCH",
@@ -271,7 +263,6 @@ def delete(
     verify: VerifyTypes = True,
     timeout: TimeoutTypes = None,
     trust_env: bool = None,
-    proxies: ProxiesTypes = None,
 ) -> Response:
     return request(
         "DELETE",