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

Hint at next step, during install, when wheel building fails #6584

Open
pradyunsg opened this issue Jun 8, 2019 · 6 comments
Open

Hint at next step, during install, when wheel building fails #6584

pradyunsg opened this issue Jun 8, 2019 · 6 comments
Labels
C: error messages Improving error messages C: wheel The wheel format and 'pip wheel' command type: enhancement Improvements to functionality UX User experience related

Comments

@pradyunsg
Copy link
Member

pradyunsg commented Jun 8, 2019

ref: https://stackoverflow.com/questions/53204916/what-is-the-meaning-of-failed-building-wheel-for-x-in-pip-install

When pip fails to build a wheel, the message is a little mysterious for the users. It might be a good idea to see how we can enhance that to be "better".

Note that pip wheel uses the same code, so we should consider that here as well.

@triage-new-issues triage-new-issues bot added the S: needs triage Issues/PRs that need to be triaged label Jun 8, 2019
@pradyunsg pradyunsg added type: enhancement Improvements to functionality and removed S: needs triage Issues/PRs that need to be triaged labels Jun 8, 2019
@cjerdonek
Copy link
Member

Good call. At the least, maybe a less-ominous sounding beginning than “Failed” could be used so people don’t get the feeling something went horribly wrong (e.g. “Building a wheel didn’t work so ...” maybe also with a “because ....”).

@cjerdonek
Copy link
Member

See also the similar (or same?) #6256.

@pradyunsg pradyunsg added this to the Print Better Error Messages milestone Jun 12, 2019
@pradyunsg
Copy link
Member Author

It's similar -- in general I think we can improve our error messaging here.

@cjerdonek cjerdonek added the C: wheel The wheel format and 'pip wheel' command label Jun 21, 2019
@ei8fdb
Copy link
Contributor

ei8fdb commented Feb 6, 2020

@pradyunsg Is this still an issue? I tried to replicate it just now and got:

Successfully built pycparser
Installing collected packages: pycparser
Successfully installed pycparser-2.19

Thanks!

@pradyunsg
Copy link
Member Author

pradyunsg commented Feb 7, 2020

@ei8fdb Yes; the issue is for when the "successfully built" stage fails in your output fails. That failure is fairly system-dependent (eg. missing compiler, missing OS libraries etc).

Currently, pip prints "Failed building wheel for <pkg>" and then proceeds to attempt an install via setup.py install as a fallback. This can result in a successful install (because the fallback worked) and the output containing a message starting with "Failed" -- which is confusing to users (as evidenced by fairly regular traffic on this specific question on StackOverflow).

We can discuss pip's build process in more detail over other media (like a voice/video call) if needed. :)

@nlhkabu nlhkabu added C: error messages Improving error messages UX User experience related labels Jul 28, 2020
@nlhkabu
Copy link
Member

nlhkabu commented Jul 28, 2020

Perhaps:

Failed building wheel for pycparser
Falling back to attempt install via setup.py.... done
Successfully installed pycparser-2.19

Error:

Failed building wheel for pycparser
Falling back to attempt install via setup.py.... failed
Failed installing pycparser-2.19

@pradyunsg is this accurate? Would something like this be possible?

@nlhkabu nlhkabu removed this from the Print Better Error Messages milestone Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: error messages Improving error messages C: wheel The wheel format and 'pip wheel' command type: enhancement Improvements to functionality UX User experience related
Projects
None yet
Development

No branches or pull requests

4 participants