Add --no-proxy Option #13051

martinezlc99 · 2024-10-27T21:26:38Z

This PR was originally done in #12011, which I cancelled due to age and associated pain of rebasing.

Originally this PR stalled in addressing #12011 (comment), but since then I have noticed the --proxy=PROXY option also sets session.trust_env = False as well, so the behavior is consistent.

martinezlc99 · 2024-11-07T17:07:23Z

Hi everyone - am I missing anything on this PR?

Also, I am thinking about logging a message if both --proxy=<PROXY> and --no-proxy options are simultaneously set.

notatallshaw · 2024-11-07T17:22:26Z

I'm going to put it on the 25.0 milestone so it doesn't get forgotten, but it will be up to a pip maintainer or release manager to review and decide whether it stays on there.

I don't have a lot of experience reviewing this type of PR but it looks simple and your note about existing use of session.trust_env makes sense to me (though I still think this should be documented somewhere, it at least keeps in line with existing behavior).

jdlangs · 2024-11-08T17:48:51Z

@martinezlc99, I just happened to be investigating this behavior today and it was a pleasant surprise to see this was active just yesterday. Thanks for driving this forward!

I did want to ask, wouldn't the ideal behavior be for the --no-proxy flag to take a value similar to the no_proxy env var, instead of turning off proxies entirely? I thought the general use case was people want to provide specific configuration scenarios of which index URLs require proxy use, just without the awkwardness of dynamically changing env vars. It also would be confusing IMO for a no_proxy option to be a boolean given how it's typically used.

Unfortunately, there seems to be buggy behavior in requests that means simple passing on a no_proxy value in session.proxies won't work today but that seems like the ideal behavior for me and my use case.

notatallshaw · 2024-11-08T18:11:46Z

@jdlangs I think what this PR has going for it is its simplicity. Generally pip should rely on sourcing behavior from the standard or vendored libraries.

I notice that uv has not implemented --proxy and instead points users to environmental variables, which is probably the right call as having these CLI flags means pip needs to make its own choices.

There is no standard definition of what no_proxy or NO_PROXY should do: https://about.gitlab.com/blog/2021/01/27/we-need-to-talk-no-proxy/. So any implementation would break someone's expectations. IMO I think pip should be pointing people towards using http_proxy / HTTP_PROXY / https_proxy / HTTPS_PROXY / no_proxy / NO_PROXY and let the http library pip vendors deal with figuring out how to interpret that.

jdlangs · 2024-11-08T19:42:33Z

Yeah, just using environment variables does seem like the most standard and robust method, but if pip provides a proxy argument, I think being able to configure no_proxy also seems reasonable.

I think what this PR has going for it is its simplicity

The simplest PR would actually be only passing a no_proxy value on to requests, I think, but unfortunately it seems that won't work until it's fixed upstream.

There is no standard definition of what no_proxy or NO_PROXY should do

Point taken, but is there any tool that treats no_proxy as a boolean flag? Maybe for this PR I'm just asking the name be reconsidered, especially if there's any chance in the future it would be reused to be a true no_proxy configuration

notatallshaw · 2024-11-08T22:21:33Z

Point taken, but is there any tool that treats no_proxy as a boolean flag? Maybe for this PR I'm just asking the name be reconsidered, especially if there's any chance in the future it would be reused to be a true no_proxy configuration

Yeah, I think it's an unfortunate naming collision , maybe --no-proxy-env would be more accurate? I don't want to bikeshed this though, there was discussion in the previous PR #12011, I would personally leave it up to @martinezlc99 to decide, but ultimately a pip maintainer needs to review this.

martinezlc99 · 2024-11-09T17:03:03Z

@notatallshaw @jdlangs my initial intent, and my understanding based on the original issue, was to bypass the proxy completely, so the boolean option made sense. But, I agree the --no-proxy option name is counter-intuitive to how the traditional no_proxy environmental variable is used.

I did a quick search to see how other tools handle this situation and found there is not a consensus:

curl has a --noproxy option, which appends to the no_proxy environmental variable:

--noproxy <no-proxy-list> List of hosts which do not use proxy

Chromium has a --no-proxy-server boolean option, which bypasses the proxy completely:

--no-proxy-server This tells Chrome not to use a Proxy. It overrides any other proxy settings provided.

The Chromium --no-proxy-server option name is at least distinct from the no_proxy environmental variable so this design is noteworthy. Chromium also has a --proxy-bypass-list which "tells chrome to bypass any specified proxy for the given semi-colon-separated list of hosts. This flag must be used (or rather, only has an effect) in tandem with --proxy-server.".

Chromium also supports --proxy-server=direct:// which will cause all connections to not use a proxy.

A nice medium may be adding support for --proxy=direct:// to completely bypass all proxies, and having --no-proxy behave inline with no_proxy environmental variable, with the requests limitation pointed out by @jdlangs .

Open to thoughts/suggestions.

notatallshaw · 2024-11-09T17:58:07Z

my initial intent, and my understanding based on the original issue, was to bypass the proxy completely, so the boolean option made sense.

But in this implementation you still take the proxy options provided to pip (which I assume can be either CLI or config), so it doesn't bypass the proxy options completely. Which is fine, there is precedence for this in the existing options --no-binary :all: can be overridden with --only-binary <specific package> and vice versa.

I don't know how much other CLIs here are that informative as it's not exactly the same behavior. I would prefer to keep it something simple, but preferably a little more accurate, naming is hard, I'd stick to the current name unless something is obviously better. I really don't think pip should be trying to do it's own emulation of big complex tools, e.g. --proxy=direct://.

martinezlc99 · 2024-11-09T18:09:29Z

Thanks @notatallshaw - agree with all your points...forgot this implementation will take the proxy from the CLI as well 😎

So I think the name of the option is the only outstanding item. I like your suggestion of --no-proxy-env or even no-proxy-config. I have no preference, so I am fine with --no-proxy-env if its agreed to be the most clear/concise.

sbidoul · 2025-01-19T12:36:11Z

It looks like the discussion here is still ongoing. So I'll postpone this to the next release.

ichard26 · 2025-03-30T23:18:32Z

To restart the discussion on this PR, I'm fine with --no-proxy-env as the name if we're explicitly trying to avoid replicating the "standard" no_proxy envvar behaviour and we still accept --proxy on the CLI.

pfmoore · 2025-04-01T10:24:51Z

@notatallshaw it looks like you have been working on this - do you plan to merge it for 25.1? If not, I suggest we just remove the milestone, and it can go in when it's ready.

notatallshaw · 2025-04-01T12:46:39Z

I agree with @ichard26 , let's change the name. I'll move it to the next milestone, but will try and review if it gets updated quickly.

martinezlc99 · 2025-04-14T15:36:00Z

@notatallshaw - apologies for not tracking this response, been a bit busy. I will update the name ASAP.

…to option function

ichard26

Having come back to review this again, the main wrinkle with this design is that it's not true all proxy configuration set via environment variables will be ignored. All of pip's options can be set via environment variables. PIP_PROXY=myproxy is equivalent to pip --proxy=myproxy

I don't know common ignoring PIP_PROXY would be, but this flag has the potential to be confusing. Thoughts?

ichard26 · 2025-04-21T01:05:30Z

src/pip/_internal/cli/index_command.py

+        # Handle no proxy option
+        if options.no_proxy:
+            # Handle case of both --no-proxy-env being set along with --proxy=<proxy>.
+            # In this case, the proxies from the environmental variables will be
+            # ignored, but the command line proxy will be used.
+            http_proxy = options.proxy if options.proxy else None
+            https_proxy = options.proxy if options.proxy else None
+            session.proxies = {
+                "http": http_proxy,
+                "https": https_proxy,
+            }
+            session.trust_env = False
+


This could be merged into the pre-existing proxy logic in the following way, but would be this too magical?

# Handle configured proxies, including --no-proxy-env if options.proxy or options.no_proxy_env: session.proxies = { "http": options.proxy or None, "https": options.proxy or None, } session.trust_env = False

ichard26 · 2025-04-21T01:06:48Z

src/pip/_internal/cli/cmdoptions.py

+no_proxy: Callable[..., Option] = partial(
+    Option,
+    "--no-proxy-env",
+    dest="no_proxy",
+    action="store_true",
+    default=False,
+    help="Ignore all configured proxy settings, including environmental variables.",
+)


Suggested change

no_proxy: Callable[..., Option] = partial(

Option,

"--no-proxy-env",

dest="no_proxy",

action="store_true",

default=False,

help="Ignore all configured proxy settings, including environmental variables.",

)

no_proxy_env: Callable[..., Option] = partial(

Option,

"--no-proxy-env",

dest="no_proxy_env",

action="store_true",

default=False,

help="Do not read proxy configuration from environment variables.",

)

ichard26 · 2025-04-21T01:06:59Z

src/pip/_internal/cli/cmdoptions.py

@@ -1048,6 +1057,7 @@ def check_list_path_option(options: Values) -> None:
        no_input,
        keyring_provider,
        proxy,
+        no_proxy,


Suggested change

no_proxy,

no_proxy_env,

ichard26 · 2025-04-21T01:07:45Z

news/5378.feature.rst

@@ -0,0 +1 @@
+Add ``--no-proxy-env`` option to bypass http proxy.  Using this option will ignore any configured http proxies, including any environmental variables


Suggested change

Add ``--no-proxy-env`` option to bypass http proxy. Using this option will ignore any configured http proxies, including any environmental variables

Add ``--no-proxy-env`` option to bypass proxies set via environment variables.

martinezlc99 · 2025-04-21T20:57:02Z

Having come back to review this again, the main wrinkle with this design is that it's not true all proxy configuration set via environment variables will be ignored. All of pip's options can be set via environment variables. PIP_PROXY=myproxy is equivalent to pip --proxy=myproxy

I don't know common ignoring PIP_PROXY would be, but this flag has the potential to be confusing. Thoughts?

Thanks @ichard26. From my perspective, overriding PIP_PROXY is ok since my use case was constantly transitioning from my work VPN environment to my home environment without a corporate proxy. Or are you saying PIP_PROXY persists while other environmental variables are overwritten?

The renaming of the option name to include environment seems like it would also cover the PIP_PORXY case as well.

ichard26 · 2025-04-22T21:00:50Z

Or are you saying PIP_PROXY persists while other environmental variables are overwritten?

This, because pip's CLI infrastructure treats PIP_PROXY=myproxy pip install ... as equivalent to pip --proxy myproxy install ...

martinezlc99 · 2025-04-22T22:52:28Z

Or are you saying PIP_PROXY persists while other environmental variables are overwritten?

This, because pip's CLI infrastructure treats PIP_PROXY=myproxy pip install ... as equivalent to pip --proxy myproxy install ...

@ichard26 - you are correct.

Given this PR allows --proxy=https://proxy.company.com:9090 to be used in conjunction with --no-proxy-env, and for the proxy to be set by --proxy in this case, there is an argument/precedent for the --no-proxy-env to be working as designed when PIP_PROXY is set.

So as to not restart the discussions from scratch, I propose we clarify the documentation to indicate which environmental variables are ignored with this option; however, open to updating to ignore other means of pip setting the proxy as this was the initial intent.

P.S. I had previously set trust_env to False as part of the initial --no-proxy implementation to convince requests to not use the http_proxy, https_proxy, and no_proxy environmental variables. This spawned the discussion on the trust_env implications and hence the rename of the option to --no-proxy-env.

It seems in the timeframe of the initial PR and now, the --proxy option also sets trust_env to False, effectively also ignoring any other requests environmental configurations when this option is set.

I mention this only to state the two converse proxy options are consistent now.

add --no-proxy option

e7abbd8

psf-chronographer bot added the bot:chronographer:provided label Oct 27, 2024

martinezlc99 mentioned this pull request Oct 27, 2024

Add --no-proxy option #12011

Closed

notatallshaw added this to the 25.0 milestone Nov 7, 2024

This comment was marked as off-topic.

Sign in to view

ichard26 mentioned this pull request Dec 29, 2024

How to configure pip3 to ignore proxy settings or do not use proxy settings? #12479

Closed

1 task

sbidoul modified the milestones: 25.0, 25.1 Jan 19, 2025

notatallshaw modified the milestones: 25.1, 25.2 Apr 1, 2025

rename no proxy option to --no-proxy-env to provide stronger hint as …

6abfebe

…to option function

ichard26 reviewed Apr 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --no-proxy Option #13051

Add --no-proxy Option #13051

martinezlc99 commented Oct 27, 2024

martinezlc99 commented Nov 7, 2024

notatallshaw commented Nov 7, 2024

jdlangs commented Nov 8, 2024

notatallshaw commented Nov 8, 2024 •

edited

Loading

jdlangs commented Nov 8, 2024

notatallshaw commented Nov 8, 2024 •

edited

Loading

martinezlc99 commented Nov 9, 2024 •

edited

Loading

notatallshaw commented Nov 9, 2024 •

edited

Loading

martinezlc99 commented Nov 9, 2024

This comment was marked as off-topic.

This comment was marked as off-topic.

sbidoul commented Jan 19, 2025

ichard26 commented Mar 30, 2025

pfmoore commented Apr 1, 2025

notatallshaw commented Apr 1, 2025

martinezlc99 commented Apr 14, 2025

ichard26 left a comment

ichard26 Apr 21, 2025 •

edited

Loading

ichard26 Apr 21, 2025

ichard26 Apr 21, 2025

ichard26 Apr 21, 2025

martinezlc99 commented Apr 21, 2025

ichard26 commented Apr 22, 2025

martinezlc99 commented Apr 22, 2025

		@@ -0,0 +1 @@
		Add ``--no-proxy-env`` option to bypass http proxy. Using this option will ignore any configured http proxies, including any environmental variables

Add --no-proxy Option #13051

Are you sure you want to change the base?

Add --no-proxy Option #13051

Conversation

martinezlc99 commented Oct 27, 2024

martinezlc99 commented Nov 7, 2024

notatallshaw commented Nov 7, 2024

jdlangs commented Nov 8, 2024

notatallshaw commented Nov 8, 2024 • edited Loading

jdlangs commented Nov 8, 2024

notatallshaw commented Nov 8, 2024 • edited Loading

martinezlc99 commented Nov 9, 2024 • edited Loading

notatallshaw commented Nov 9, 2024 • edited Loading

martinezlc99 commented Nov 9, 2024

This comment was marked as off-topic.

This comment was marked as off-topic.

sbidoul commented Jan 19, 2025

ichard26 commented Mar 30, 2025

pfmoore commented Apr 1, 2025

notatallshaw commented Apr 1, 2025

martinezlc99 commented Apr 14, 2025

ichard26 left a comment

Choose a reason for hiding this comment

ichard26 Apr 21, 2025 • edited Loading

Choose a reason for hiding this comment

ichard26 Apr 21, 2025

Choose a reason for hiding this comment

ichard26 Apr 21, 2025

Choose a reason for hiding this comment

ichard26 Apr 21, 2025

Choose a reason for hiding this comment

martinezlc99 commented Apr 21, 2025

ichard26 commented Apr 22, 2025

martinezlc99 commented Apr 22, 2025

notatallshaw commented Nov 8, 2024 •

edited

Loading

notatallshaw commented Nov 8, 2024 •

edited

Loading

martinezlc99 commented Nov 9, 2024 •

edited

Loading

notatallshaw commented Nov 9, 2024 •

edited

Loading

ichard26 Apr 21, 2025 •

edited

Loading