encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add proxies parameter to top-level API functions (#1198)

Browse Source 
* Add `proxies` parameter to top-level API functions

* Fix typo
This commit is contained in:
Joe 2020-08-20 15:55:35 +08:00 committed by GitHub
parent 25507acdc9
commit 84ca2010e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/advanced.md
View File

@ -262,7 +262,7 @@ client = httpx.Client(trust_env=False)
## HTTP Proxying
HTTPX supports setting up [HTTP proxies](https://en.wikipedia.org/wiki/Proxy_server#Web_proxy_servers) via the `proxies` parameter to be passed on client initialization.
HTTPX supports setting up [HTTP proxies](https://en.wikipedia.org/wiki/Proxy_server#Web_proxy_servers) via the `proxies` parameter to be passed on client initialization or top-level API functions like `httpx.get(..., proxies=...)`.
_Note: SOCKS proxies are not supported yet._

2
docs/compatibility.md
View File

@ -42,6 +42,8 @@ This is different to the `requests` usage of `proxies={"http": ..., "https": ...
This change is for better consistency with more complex mappings, that might also include domain names, such as `proxies={"all://": ..., "all://www.example.com": None}` which maps all requests onto a proxy, except for requests to "www.example.com" which have an explicit exclusion.
Also note that `requests.Session.request(...)` allows a `proxies=...` parameter, whereas `httpx.Client.request(...)` does not.
## SSL configuration
When using a `Client` instance, the `trust_env`, `verify`, and `cert` arguments should always be passed on client instantiation, rather than passed to the request method.

22
httpx/_api.py
View File

@ -8,6 +8,7 @@ from ._types import (
CertTypes,
CookieTypes,
HeaderTypes,
ProxiesTypes,
QueryParamTypes,
RequestData,
RequestFiles,
@ -28,6 +29,7 @@ def request(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
allow_redirects: bool = True,
verify: VerifyTypes = True,
@ -56,6 +58,7 @@ def request(
request.
* **auth** - *(optional)* An authentication class to use when sending the
request.
* **proxies** - *(optional)* A dictionary mapping proxy keys to proxy URLs.
* **timeout** - *(optional)* The timeout configuration to use when sending
the request.
* **allow_redirects** - *(optional)* Enables or disables HTTP redirects.
@ -81,7 +84,7 @@ def request(
```
"""
with Client(
cert=cert, verify=verify, timeout=timeout, trust_env=trust_env,
proxies=proxies, cert=cert, verify=verify, timeout=timeout, trust_env=trust_env,
) as client:
return client.request(
method=method,
@ -108,13 +111,14 @@ def stream(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
allow_redirects: bool = True,
verify: VerifyTypes = True,
cert: CertTypes = None,
trust_env: bool = True,
) -> StreamContextManager:
client = Client(cert=cert, verify=verify, trust_env=trust_env)
client = Client(proxies=proxies, cert=cert, verify=verify, trust_env=trust_env)
request = Request(
method=method,
url=url,
@ -142,6 +146,7 @@ def get(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -163,6 +168,7 @@ def get(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
@ -178,6 +184,7 @@ def options(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -199,6 +206,7 @@ def options(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
@ -214,6 +222,7 @@ def head(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -237,6 +246,7 @@ def head(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
@ -255,6 +265,7 @@ def post(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -276,6 +287,7 @@ def post(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
@ -294,6 +306,7 @@ def put(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -315,6 +328,7 @@ def put(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
@ -333,6 +347,7 @@ def patch(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -354,6 +369,7 @@ def patch(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
@ -369,6 +385,7 @@ def delete(
headers: HeaderTypes = None,
cookies: CookieTypes = None,
auth: AuthTypes = None,
proxies: ProxiesTypes = None,
allow_redirects: bool = True,
cert: CertTypes = None,
verify: VerifyTypes = True,
@ -390,6 +407,7 @@ def delete(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,

2
httpx/_client.py
View File

@ -467,7 +467,7 @@ class Client(BaseClient):
to authenticate the client. Either a path to an SSL certificate file, or
two-tuple of (certificate file, key file), or a three-tuple of (certificate
file, key file, password).
* **proxies** - *(optional)* A dictionary mapping HTTP protocols to proxy
* **proxies** - *(optional)* A dictionary mapping proxy keys to proxy
URLs.
* **timeout** - *(optional)* The timeout configuration to use when sending
requests.