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.

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

pip should translate the most common error messages into plain english #3573

Closed
glyph opened this issue Mar 17, 2016 · 5 comments
Closed

pip should translate the most common error messages into plain english #3573

glyph opened this issue Mar 17, 2016 · 5 comments
Labels
auto-locked Outdated issues that have been locked by automation state: needs discussion This needs some more discussion type: enhancement Improvements to functionality

Comments

@glyph
Copy link

glyph commented Mar 17, 2016

As described in #942, the most common problem new users have with pip is that they don't have a C compiler installed. The messages telling them this are platform-specific and unhelpful.

I realize that there is no one-size-fits-all solution here, because setup.py can get up to arbitrary nastiness, but if pip could at least translate the most common errors I am confident that its hit rate would be more like 99%/1% than 80%/20%.

So, if you can't find vcvarsall.bat, or if you see the text from xcode indicating that the EULA hasn't been agreed to yet, or cc is not found, pip should detect the platform and print a helpful message like "please run xcode-select --install" or "download a free version of visual studio here" or "apt-get install build-essential python-dev".

@tiran
Copy link
Contributor

tiran commented Aug 24, 2016

Missing header files is also a common problem. The actual error message is usually hidden in the middle of a lot of text.

@pradyunsg pradyunsg added this to the Print Better Error Messages milestone Oct 2, 2017
@pradyunsg pradyunsg added the type: enhancement Improvements to functionality label Oct 2, 2017
@pradyunsg
Copy link
Member

As I understand, post PEP 517, printing nice error messages about built tools would be a responsibility of the backend?

I do think that this is something setuptools should print a nice message for as on today.

@chrahunt
Copy link
Member

chrahunt commented Dec 9, 2019

As a user, I sympathize with getting a wall of error text and having to understand it.

I also recognize that we have a hard enough time giving plain english messages for our own internally-originating errors. IMO this would be best put on setuptools/build backends, which will have much finer-grained context to translate errors into something meaningful, whereas pip would just have the plain text. Further, we're already going in the direction of giving build backends control of output as opposed to pip intercepting and interpreting it.

@chrahunt chrahunt added state: needs discussion This needs some more discussion S: awaiting response Waiting for a response/more information labels Dec 9, 2019
@chrahunt
Copy link
Member

chrahunt commented Dec 9, 2019

I'll mark this "awaiting response" (we should probably have a better label for this). If anyone has contention with this being closed based on the above points, please mention it!

@no-response
Copy link

no-response bot commented Dec 24, 2019

This issue has been automatically closed because there has been no response to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so that we can investigate further.

@no-response no-response bot closed this as completed Dec 24, 2019
@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Jan 24, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Jan 24, 2020
@pradyunsg pradyunsg removed the S: awaiting response Waiting for a response/more information label Mar 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation state: needs discussion This needs some more discussion type: enhancement Improvements to functionality
Projects
None yet
Development

No branches or pull requests

4 participants