From df74492d1b5e7e739f56a3dcd9e2c5785da5ae73 Mon Sep 17 00:00:00 2001 From: cdeler Date: Wed, 5 Aug 2020 17:50:22 +0300 Subject: [PATCH] #1105 added deprecation warning, raised when we try to use proxies={"http": ...} instead of {"http://": ...}. Updated docs and added unit, which check the warning presence --- docs/advanced.md | 20 ++++++------- httpx/_utils.py | 4 +++ tests/client/test_proxies.py | 57 ++++++++++++++++++++++++------------ 3 files changed, 53 insertions(+), 28 deletions(-) diff --git a/docs/advanced.md b/docs/advanced.md index 51544e5547..cf9ab94bc3 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -284,8 +284,8 @@ For more advanced use cases, pass a proxies `dict`. For example, to route HTTP a ```python proxies = { - "http": "http://localhost:8030", - "https": "http://localhost:8031", + "http://": "http://localhost:8030", + "https://": "http://localhost:8031", } with httpx.Client(proxies=proxies) as client: @@ -295,7 +295,7 @@ with httpx.Client(proxies=proxies) as client: For detailed information about proxy routing, see the [Routing](#routing) section. !!! tip "Gotcha" - In most cases, the proxy URL for the `https` key _should_ use the `http://` scheme (that's not a typo!). + In most cases, the proxy URL for the `https://` key _should_ use the `http://` scheme (that's not a typo!). This is because HTTP proxying requires initiating a connection with the proxy server. While it's possible that your proxy supports doing it via HTTPS, most proxies only support doing it via HTTP. @@ -307,7 +307,7 @@ Proxy credentials can be passed as the `userinfo` section of the proxy URL. For ```python proxies = { - "http": "http://username:password@localhost:8030", + "http://": "http://username:password@localhost:8030", # ... } ``` @@ -316,7 +316,7 @@ proxies = { HTTPX provides fine-grained controls for deciding which requests should go through a proxy, and which shouldn't. This process is known as proxy routing. -The `proxies` dictionary maps URL patterns ("proxy keys") to proxy URLs. HTTPX matches requested URLs against proxy keys to decide which proxy should be used, if any. Matching is done from most specific proxy keys (e.g. `https://:`) to least specific ones (e.g. `https`). +The `proxies` dictionary maps URL patterns ("proxy keys") to proxy URLs. HTTPX matches requested URLs against proxy keys to decide which proxy should be used, if any. Matching is done from most specific proxy keys (e.g. `https://:`) to least specific ones (e.g. `https://`). HTTPX supports routing proxies based on **scheme**, **domain**, **port**, or a combination of these. @@ -326,7 +326,7 @@ Route everything through a proxy... ```python proxies = { - "all": "http://localhost:8030", + "all://": "http://localhost:8030", } ``` @@ -336,8 +336,8 @@ Route HTTP requests through one proxy, and HTTPS requests through another... ```python proxies = { - "http": "http://localhost:8030", - "https": "http://localhost:8031", + "http://": "http://localhost:8030", + "https://": "http://localhost:8031", } ``` @@ -402,7 +402,7 @@ To do so, pass `None` as the proxy URL. For example... ```python proxies = { # Route requests through a proxy by default... - "all": "http://localhost:8031", + "all://": "http://localhost:8031", # Except those for "example.com". "all://example.com": None, } @@ -415,7 +415,7 @@ You can combine the routing features outlined above to build complex proxy routi ```python proxies = { # Route all traffic through a proxy by default... - "all": "http://localhost:8030", + "all://": "http://localhost:8030", # But don't use proxies for HTTPS requests to "domain.io"... "https://domain.io": None, # And use another proxy for requests to "example.com" and its subdomains... diff --git a/httpx/_utils.py b/httpx/_utils.py index b09aebcfd7..5ba7530fab 100644 --- a/httpx/_utils.py +++ b/httpx/_utils.py @@ -478,6 +478,10 @@ def __init__(self, pattern: str) -> None: from ._models import URL if pattern and ":" not in pattern: + warn_deprecated( + f'Proxy keys should use proper URL forms rather than plain scheme strings. Instead of "{pattern}", ' + f'use "{pattern}://"' + ) pattern += "://" url = URL(pattern) diff --git a/tests/client/test_proxies.py b/tests/client/test_proxies.py index 3f014baa96..03d05bef37 100644 --- a/tests/client/test_proxies.py +++ b/tests/client/test_proxies.py @@ -20,16 +20,19 @@ def url_to_origin(url: str): @pytest.mark.parametrize( ["proxies", "expected_proxies"], [ - ("http://127.0.0.1", [("all", "http://127.0.0.1")]), - ({"all": "http://127.0.0.1"}, [("all", "http://127.0.0.1")]), + ("http://127.0.0.1", [("all://", "http://127.0.0.1")]), + ({"all://": "http://127.0.0.1"}, [("all://", "http://127.0.0.1")]), ( - {"http": "http://127.0.0.1", "https": "https://127.0.0.1"}, - [("http", "http://127.0.0.1"), ("https", "https://127.0.0.1")], + {"http://": "http://127.0.0.1", "https://": "https://127.0.0.1"}, + [("http://", "http://127.0.0.1"), ("https://", "https://127.0.0.1")], ), - (httpx.Proxy("http://127.0.0.1"), [("all", "http://127.0.0.1")]), + (httpx.Proxy("http://127.0.0.1"), [("all://", "http://127.0.0.1")]), ( - {"https": httpx.Proxy("https://127.0.0.1"), "all": "http://127.0.0.1"}, - [("all", "http://127.0.0.1"), ("https", "https://127.0.0.1")], + { + "https://": httpx.Proxy("https://127.0.0.1"), + "all://": "http://127.0.0.1", + }, + [("all://", "http://127.0.0.1"), ("https://", "https://127.0.0.1")], ), ], ) @@ -54,7 +57,7 @@ def test_proxies_parameter(proxies, expected_proxies): [ ("http://example.com", None, None), ("http://example.com", {}, None), - ("http://example.com", {"https": PROXY_URL}, None), + ("http://example.com", {"https://": PROXY_URL}, None), ("http://example.com", {"http://example.net": PROXY_URL}, None), # Using "*" should match any domain name. ("http://example.com", {"http://*": PROXY_URL}, PROXY_URL), @@ -71,9 +74,9 @@ def test_proxies_parameter(proxies, expected_proxies): ("http://wwwexample.com", {"http://*example.com": PROXY_URL}, None), # ... ("http://example.com:443", {"http://example.com": PROXY_URL}, PROXY_URL), - ("http://example.com", {"all": PROXY_URL}, PROXY_URL), - ("http://example.com", {"all": PROXY_URL, "http://example.com": None}, None), - ("http://example.com", {"http": PROXY_URL}, PROXY_URL), + ("http://example.com", {"all://": PROXY_URL}, PROXY_URL), + ("http://example.com", {"all://": PROXY_URL, "http://example.com": None}, None), + ("http://example.com", {"http://": PROXY_URL}, PROXY_URL), ("http://example.com", {"all://example.com": PROXY_URL}, PROXY_URL), ("http://example.com", {"all://example.com:80": PROXY_URL}, None), ("http://example.com", {"http://example.com": PROXY_URL}, PROXY_URL), @@ -83,8 +86,8 @@ def test_proxies_parameter(proxies, expected_proxies): ( "http://example.com", { - "all": PROXY_URL + ":1", - "http": PROXY_URL + ":2", + "all://": PROXY_URL + ":1", + "http://": PROXY_URL + ":2", "all://example.com": PROXY_URL + ":3", "http://example.com": PROXY_URL + ":4", }, @@ -93,15 +96,15 @@ def test_proxies_parameter(proxies, expected_proxies): ( "http://example.com", { - "all": PROXY_URL + ":1", - "http": PROXY_URL + ":2", + "all://": PROXY_URL + ":1", + "http://": PROXY_URL + ":2", "all://example.com": PROXY_URL + ":3", }, PROXY_URL + ":3", ), ( "http://example.com", - {"all": PROXY_URL + ":1", "http": PROXY_URL + ":2"}, + {"all://": PROXY_URL + ":1", "http://": PROXY_URL + ":2"}, PROXY_URL + ":2", ), ], @@ -120,12 +123,12 @@ def test_transport_for_request(url, proxies, expected): @pytest.mark.asyncio async def test_async_proxy_close(): - client = httpx.AsyncClient(proxies={"all": PROXY_URL}) + client = httpx.AsyncClient(proxies={"all://": PROXY_URL}) await client.aclose() def test_sync_proxy_close(): - client = httpx.Client(proxies={"all": PROXY_URL}) + client = httpx.Client(proxies={"all://": PROXY_URL}) client.close() @@ -244,3 +247,21 @@ def test_proxies_environ(monkeypatch, client_class, url, env, expected): assert transport == client._transport else: assert transport.proxy_origin == url_to_origin(expected) + + +@pytest.mark.parametrize( + ["proxies", "expected_scheme"], + [ + ({"http": "http://127.0.0.1"}, ["http://"]), + ({"https": "http://127.0.0.1"}, ["https://"]), + ({"all": "http://127.0.0.1"}, ["all://"]), + ], +) +def test_for_deprecated_proxy_params(proxies, expected_scheme): + with pytest.deprecated_call() as block: + httpx.AsyncClient(proxies=proxies) + + warning_message = str(block.pop(DeprecationWarning)) + + for scheme in expected_scheme: + assert scheme in warning_message