Skip to content

gh-72327: Suggest using system terminal for pip install in PyREPL #136328

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.

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

Merged
merged 4 commits into from
Jul 15, 2025

Conversation

ichard26
Copy link
Contributor

@ichard26 ichard26 commented Jul 5, 2025

Users new to Python packaging often try to use pip from the REPL only to be met with a confusing SyntaxError. If this happens, guide the user to use a system terminal instead to invoke pip. The pip project still receives the occasional issue from users lamenting that "pip is not working!" (pypa/pip#13409)

image

This is an updated version of #8536.

cc @ncoghlan

Users new to Python packaging often try to use pip from the REPL only to
be met with a confusing SyntaxError. If this happens, guide the user to
use a system terminal instead to invoke pip.

Co-authored-by: Tom Viner <tom@viner.tv>
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
@brianschubert
Copy link
Member

The new REPL has a similar special case for when await is used at the top-level:

except SyntaxError as e:
if e.args[0] == "'await' outside function":
python = os.path.basename(sys.executable)
e.add_note(
f"Try the asyncio REPL ({python} -m asyncio) to use"
f" top-level 'await' and run background asyncio tasks."
)
self.showsyntaxerror(filename, source=source)

Maybe this could be done in a similar way?

Something like this might work:

:...skipping...
diff --git a/Lib/_pyrepl/console.py b/Lib/_pyrepl/console.py
index 8956fb1242e..833e79ef3c2 100644
--- a/Lib/_pyrepl/console.py
+++ b/Lib/_pyrepl/console.py
@@ -195,7 +195,15 @@ def runsource(self, source, filename="<input>", symbol="single"):
                 ast.PyCF_ONLY_AST,
                 incomplete_input=False,
             )
-        except (SyntaxError, OverflowError, ValueError):
+        except SyntaxError as e:
+            if "pip install" in source:  # maybe use a more general regex?
+                e.add_note(
+                    "Did you mean to run the 'pip' command?."
+                    " If so, <insert tip message here>"
+                )
+            self.showsyntaxerror(filename, source=source)
+            return False
+        except (OverflowError, ValueError):
             self.showsyntaxerror(filename, source=source)
             return False
         if tree.body:

@adqm
Copy link

adqm commented Jul 7, 2025

I teach Python at the university level, and this is a pretty common issue, so I think this would be a good addition! Maybe checking if "pip install" shows up anywhere in the source string is too general, though? That would fire on input like print('pip install"), which I'm not sure is helpful.

I feel like this might want to be a more specific check, like matching the source string against something like ^\s*(py(thon3?)? -m pip|pip3?) install. I suppose you could even check for a variant involving sys.executable, though that's probably overkill (since the likely culprit here is copy/pasting general instructions from somewhere).

@ichard26
Copy link
Contributor Author

ichard26 commented Jul 7, 2025

Ah crap, I forgot that force-pushing is frown upon here. Sorry about that!

@brianschubert thanks for the suggestion. Implementing this via the new REPL is much cleaner! I've updated my patch to use your approach.

@ichard26 ichard26 changed the title gh-72327: Suggest using system terminal for pip install in REPL gh-72327: Suggest using system terminal for pip install in PyREPL Jul 7, 2025
@ichard26 ichard26 marked this pull request as ready for review July 7, 2025 20:59
@jason-fine
Copy link

It may be nice to include "or pip3" depending on which version they want to use.

@ichard26
Copy link
Contributor Author

ichard26 commented Jul 9, 2025

I really don't want to get into the weeds of how to invoke pip (because the answer is "it depends" and I don't want to make this more complicated). The point of saying "try the 'pip' command" is that it can't simply be copied. The onus is on the user to invoke pip appropriately for their system. In most cases, I expect them to re-copy and paste what they just pasted/typed in.

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Copy link
Contributor

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but I'll leave it open for a bit due to that potential slight tweak to the regex layout.

@adqm
Copy link

adqm commented Jul 14, 2025

Do we also maybe want to check for variants that start try to use sudo? So, like ^\s*(sudo )?(pip3?|py(thon3?)? -m pip) install.*?

@ichard26
Copy link
Contributor Author

I've never encountered someone doing that. Have your students done that before? @adqm

@adqm
Copy link

adqm commented Jul 14, 2025

I'm not sure how common it is anymore, but I feel like it used to be fairly normal to suggest using sudo pip install to install things to your system's Python installation, so I wouldn't be surprised if the version with sudo was something that might still get copy/pasted in. I don't feel too strongly about this, though, just a thought.

Separately, I do agree that @ncoghlan's rephrasing of the regex is an improvement.

@ncoghlan
Copy link
Contributor

For the sudo question, I'd like to wait and see if we can get a sense of how this initial custom error plays out.

The sudo case is a much harder situation to provide a good error message for, as typing the sudo version into the REPL instead of the terminal can actually save people from making a system killing mistake, so we don't want to encourage them to try that specific command in the terminal.

@ncoghlan ncoghlan enabled auto-merge (squash) July 15, 2025 13:59
@ncoghlan ncoghlan merged commit be02e68 into python:main Jul 15, 2025
49 checks passed
@ichard26 ichard26 deleted the pip-repl-error branch July 15, 2025 14:27
@ichard26
Copy link
Contributor Author

Thanks for the review @ncoghlan!

@ncoghlan
Copy link
Contributor

Thanks for updating the PR to the new REPL! The previous PR stalled, I think mostly because the potential consequence of changing the site.enablerlcompleter API weren't clear, so being able to avoid that concern this time around made a big difference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy