Improve error messages for build wheel failures#6492
Merged
Conversation
When pip fails with 'Getting requirements to build wheel exited with 1', the error message is confusing because it appears to be a dependency resolution issue. This is often caused by: - Invalid pyproject.toml syntax or configuration - Encoding issues in files referenced by pyproject.toml (e.g., README.md with special characters like em-dashes or ellipses) - Missing or incompatible build dependencies This change adds helpful hints when this specific error is detected, guiding users to check their pyproject.toml and related files, and suggesting they run 'pip install . -v' for more detailed error output. The hints are added in two places: 1. ResolutionFailure exception (pipenv/exceptions.py) 2. Resolver error output (pipenv/utils/resolver.py) Fixes #6058
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
When pip fails with "Getting requirements to build wheel exited with 1", the error message is confusing because it appears to be a dependency resolution issue. This change adds helpful hints to guide users toward the actual cause.
Problem
When running
pipenv install .with a local package that has issues in itspyproject.tomlor referenced files (like README.md with encoding problems), users see:This error appears to be about dependency resolution, but the actual problem is often:
—or ellipses…)Solution
Add helpful hints when the "Getting requirements to build wheel" error is detected:
Changes
ResolutionFailureexception to detect the error pattern and add hintsFixes #6058
Pull Request opened by Augment Code with guidance from the PR author