Add the 'proxy' parameter and deprecate 'proxies'. #2879

karpetrosyan · 2023-10-06T13:24:34Z

Summary

HTTPX supports proxies and mounts arguments, which are not the same, but mounts can simply replace proxies for complex routing, which is not always used.

So for simplicity, this PR deprecates proxies and adds proxy argument.
You can still use proxies, but it will warn you that it is deprecated and that you should use the new API.

Use...

proxy if you want to use a proxy server for all your requests.
mounts if you want to use a proxy server for requests matching the URL pattern you specified.

Proxy

import httpx

# instead of 
# httpx.Client(proxies="http://127.0.0.1:80")
# and
# httpx.Client(proxies={"all://": "http://127.0.0.1:80"})
# do ...
client = httpx.Client(proxy="http://127.0.0.1:80")

Mounts

import httpx

# instead of
# client = httpx.Client(
#    proxies={"http://": "http://127.0.0.1:80", "https://": "https://127.0.0.1:443"}
# )
# do ...
client = httpx.Client(
    mounts={
        "http://": httpx.HTTPTransport(proxy="http://127.0.0.1:80"),
        "https://": httpx.HTTPTransport(proxy="https://127.0.0.1:443"),
    }
)

karpetrosyan · 2023-10-07T06:39:18Z

@encode/maintainers If we want to switch to this API, I can work on the documentation.

I don't want to rush API changes, but if we believe the proxies API is not persistent, we should probably change it before 1.0.0, for example, deprecate it in the next release and remove it in 1.0.0.

lovelydinosaur · 2023-10-10T13:11:50Z

Yep seems like a clear API rationalisation to me, I'd be happy for us to make this switch for 1.0.

It woud probably also make sense for us to widen the available types for the proxy argument on httpx.HTTPTransport, so that the mount style is kept fairly simple...

client = httpx.Client(
    mounts={
        "http://": httpx.HTTPTransport(proxy="http://127.0.0.1:80"),
        "https://": httpx.HTTPTransport(proxy="https://127.0.0.1:443"),
    }
)

httpx/_transports/default.py

Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com>

karpetrosyan · 2023-10-11T09:06:27Z

Okay, so I can say that we should carefully consider how we will document this.
At this time, all of the routing staff described in the HTTP Proxies section do not make sense with the current implementation.
I propose that we change the documentation in a separate PR, and that we also document this feature there.

That new PR should answer this question:

What structure do we want for the HTTPX 1.0 documentation?
How do we want to document the deprecated things?
Do we want to describe custom transports more detailed? & Move the routing section into it.

I also want that PR will make HTTPX documentation more user-friendly and add some Mkdocs material features that can possibly make the documentation more readable and pleasant.

lovelydinosaur · 2023-10-11T10:25:59Z

Excellent questions, though quite wide ranging.

For the purposes of this pull request I'd suggest that...

The proxy routing docs move into the "mounting transports" section.
Deprecations are mentioned in the CHANGELOG.

httpx/_types.py

lovelydinosaur

Looking good.

The command-line client also currently uses --proxies - I'd suggest we change that also.

For example here...

httpx/httpx/_main.py

Line 72 in e63b659

"--proxies [cyan]URL",

as well as in a few other places in that module.

…roxies

karpetrosyan · 2023-10-12T09:07:59Z

Do we want to keep the proxies argument in the cli app?
The migration is so easy; the user should just change the proxies word to proxy, so we can entirely remove it.

lovelydinosaur · 2023-10-13T12:29:07Z

the user should just change the proxies word to proxy

I'm happy with making that change, yes.

CHANGELOG.md

docs/troubleshooting.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

lovelydinosaur · 2023-12-11T12:16:19Z

Looking great. Let's...

Update the description to indicate that proxies=... will continue to work at this point in time, but will issue a warning. (That's correct yeah?)
Should we drop proxies from the docstrings at this point, given that it's deprecated. Perhaps code comments alongside proxies=... indicating "# Deprecated. Remains functional, but will raise a warning if used."`?

karpetrosyan · 2023-12-11T12:35:14Z

That's correct yeah?

Yes

Should we drop proxies from the docstrings at this point, given that it's deprecated. Perhaps code comments alongside proxies=... indicating "# Deprecated. Remains functional, but will raise a warning if used."`?

Is there a reason we need to get rid of docstring? I thought we were going to remove everything related to proxies with the major release.
We can look at how other encode projects deprecate things, but I don't think it's necessary.

Fixes: https://gitlab.com/apt-mirror2/apt-mirror2/-/issues/24 See-Also: encode/httpx#2879

I implemented transition as suggest in encode/httpx#2879

* Add the proxy parameter and deprecate proxies * Make the Client.proxy and HTTPTransport.proxy types the same * Update httpx/_transports/default.py Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com> * Update httpx/_transports/default.py Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com> * Drop unneeded noqa * Changelog * update documentation * Allow None in mounts * typos * Update httpx/_types.py * Changes proxies to proxy in CLI app * Add proxy to request function * Update CHANGELOG.md Co-authored-by: Tom Christie <tom@tomchristie.com> * Update docs/troubleshooting.md Co-authored-by: Tom Christie <tom@tomchristie.com> * Update docs/troubleshooting.md Co-authored-by: Tom Christie <tom@tomchristie.com> * Lint --------- Co-authored-by: Tom Christie <tom@tomchristie.com> Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com>

see encode/httpx#2879 for more info

Add the proxy parameter and deprecate proxies

170cbef

karpetrosyan added the api change PRs that contain breaking public API changes label Oct 6, 2023

lovelydinosaur and others added 2 commits October 10, 2023 14:11

Merge branch 'master' into drop-proxies

189a4f2

Make the Client.proxy and HTTPTransport.proxy types the same

88eb99b

karpetrosyan marked this pull request as draft October 10, 2023 13:54

karpetrosyan force-pushed the drop-proxies branch from d71deba to 88eb99b Compare October 10, 2023 13:58

T-256 approved these changes Oct 11, 2023

View reviewed changes

httpx/_transports/default.py Outdated Show resolved Hide resolved

httpx/_transports/default.py Show resolved Hide resolved

lovelydinosaur and others added 2 commits October 11, 2023 09:35

Update httpx/_transports/default.py

11bec08

Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com>

Update httpx/_transports/default.py

fad66cf

Co-authored-by: T-256 <132141463+T-256@users.noreply.github.com>

karpetrosyan added 5 commits October 11, 2023 14:27

Drop unneeded noqa

d16f9f3

Changelog

64a4596

update documentation

541cc31

Allow None in mounts

812a70b

typos

ccf1803

karpetrosyan marked this pull request as ready for review October 12, 2023 07:29

karpetrosyan commented Oct 12, 2023

View reviewed changes

httpx/_types.py Outdated Show resolved Hide resolved

Update httpx/_types.py

bacd8b2

lovelydinosaur requested changes Oct 12, 2023

View reviewed changes

karpetrosyan added 3 commits October 12, 2023 11:50

Changes proxies to proxy in CLI app

d5fa2b0

Add proxy to request function

17c6cde

Merge branch 'drop-proxies' of github.com:karosis88/httpx into drop-p…

5aed92e

…roxies

karpetrosyan requested a review from lovelydinosaur October 13, 2023 09:00

karpetrosyan and others added 2 commits October 29, 2023 04:43

Merge branch 'master' into drop-proxies

6e5e4ac

Merge branch 'master' into drop-proxies

2672d8a

lovelydinosaur reviewed Dec 11, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

lovelydinosaur reviewed Dec 11, 2023

View reviewed changes

docs/troubleshooting.md Outdated Show resolved Hide resolved

lovelydinosaur reviewed Dec 11, 2023

View reviewed changes

docs/troubleshooting.md Outdated Show resolved Hide resolved

karpetrosyan and others added 4 commits December 11, 2023 16:11

Update CHANGELOG.md

0b73817

Co-authored-by: Tom Christie <tom@tomchristie.com>

Update docs/troubleshooting.md

1e3bf1e

Co-authored-by: Tom Christie <tom@tomchristie.com>

Update docs/troubleshooting.md

725a32e

Co-authored-by: Tom Christie <tom@tomchristie.com>

Merge branch 'master' into drop-proxies

cbd63da

Lint

c7971ce

lovelydinosaur approved these changes Dec 11, 2023

View reviewed changes

karpetrosyan merged commit f8981f3 into encode:master Dec 11, 2023

karpetrosyan mentioned this pull request Dec 18, 2023

Version 0.26.0 #3009

Merged

zevisert mentioned this pull request Jan 4, 2024

httpx 0.26 supertokens/supertokens-python#468

Closed

lovelydinosaur mentioned this pull request Jan 8, 2024

Version 1.0 #947

Open

lovelydinosaur mentioned this pull request Jan 22, 2024

Draft 1.0 release notes #3069

Closed

SigureMo mentioned this pull request Jan 26, 2024

👽️ refactor: replace proxies with proxy yutto-dev/yutto#227

Merged

15 tasks

nE0sIghT added a commit to nE0sIghT/apt-mirror2 that referenced this pull request Nov 22, 2024

download: http: fixed proxy usage with httpx < 0.26

ef97384

Fixes: https://gitlab.com/apt-mirror2/apt-mirror2/-/issues/24 See-Also: encode/httpx#2879

This was referenced Nov 29, 2024

Drop-in replacement for proxies argument in (httpx.post) #3424

Closed

Support Python 3.13 & Restrict httpx version qqaatw/LibJciHitachi#23

Merged

davidbrochart mentioned this pull request Nov 29, 2024

Fix extension manager failure with new httpx versions, bump httpx to v0.28.0 jupyterlab/jupyterlab#17013

Merged

markotoplak added a commit to markotoplak/orange3 that referenced this pull request Nov 29, 2024

httpx 0.28 support: use mounts instead od proxies

eb6b130

I implemented transition as suggest in encode/httpx#2879

markotoplak mentioned this pull request Nov 29, 2024

[FIX] httpx 0.28 support: use mounts instead of proxies biolab/orange3#6943

Merged

3 tasks

changchiyou mentioned this pull request Nov 30, 2024

fix: remove httpx's deprecated parameter proxies mahrtayyab/tweety#231

Merged

agahen mentioned this pull request Dec 5, 2024

[Bug]: microsoft/msticpy#808

Closed

FliegendeWurst mentioned this pull request Apr 7, 2025

Yewtube needs httpx less than 0.28 NixOS/nixpkgs#396811

Closed

13 tasks

fat-tire mentioned this pull request May 2, 2025

Update server-fetch proxy implementation for httpx 0.28+ modelcontextprotocol/servers#1146

Open

Zocker1999NET added a commit to Zocker1999NET/youtube-search-python that referenced this pull request May 23, 2025

migrate httpx calls from proxies= to mounts=

4f40625

see encode/httpx#2879 for more info

3215656174 mentioned this pull request Oct 7, 2025

Timeout issue lexiforest/curl_cffi#649

Open

Uh oh!

Add the 'proxy' parameter and deprecate 'proxies'. #2879

Add the 'proxy' parameter and deprecate 'proxies'. #2879

Uh oh!

Conversation

karpetrosyan commented Oct 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Proxy

Mounts

Uh oh!

karpetrosyan commented Oct 7, 2023

Uh oh!

lovelydinosaur commented Oct 10, 2023

Uh oh!

Uh oh!

Uh oh!

karpetrosyan commented Oct 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lovelydinosaur commented Oct 11, 2023

Uh oh!

Uh oh!

lovelydinosaur left a comment

Choose a reason for hiding this comment

Uh oh!

karpetrosyan commented Oct 12, 2023

Uh oh!

lovelydinosaur commented Oct 13, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lovelydinosaur commented Dec 11, 2023

Uh oh!

karpetrosyan commented Dec 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

karpetrosyan commented Oct 6, 2023 •

edited

Loading

karpetrosyan commented Oct 11, 2023 •

edited

Loading