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.

Sign up for GitHub

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

Jump to bottom

Add proxies parameter to top-level API functions #1198

Merged
merged 6 commits into from
Aug 20, 2020
Merged

Add proxies parameter to top-level API functions #1198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
76bd3ed
Add `proxies` parameter to top-level API functions
j178 Aug 19, 2020
1ec8d4d
Improve docs
j178 Aug 19, 2020
954de6c
Merge branch 'master' into top-level-proxies
j178 Aug 20, 2020
e16070e
Update docs
j178 Aug 20, 2020
600e692
Tweak
j178 Aug 20, 2020
35db3a7
Fix typo
j178 Aug 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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._

Expand Down
2 changes: 2 additions & 0 deletions docs/compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
22 changes: 20 additions & 2 deletions httpx/_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
CertTypes,
CookieTypes,
HeaderTypes,
ProxiesTypes,
QueryParamTypes,
RequestData,
RequestFiles,
Expand All @@ -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,
Expand Down Expand Up @@ -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.
Expand All @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -163,6 +168,7 @@ def get(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand All @@ -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,
Expand All @@ -199,6 +206,7 @@ def options(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand All @@ -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,
Expand All @@ -237,6 +246,7 @@ def head(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand All @@ -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,
Expand All @@ -276,6 +287,7 @@ def post(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand All @@ -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,
Expand All @@ -315,6 +328,7 @@ def put(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand All @@ -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,
Expand All @@ -354,6 +369,7 @@ def patch(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand All @@ -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,
Expand All @@ -390,6 +407,7 @@ def delete(
headers=headers,
cookies=cookies,
auth=auth,
proxies=proxies,
allow_redirects=allow_redirects,
cert=cert,
verify=verify,
Expand Down
2 changes: 1 addition & 1 deletion httpx/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down