Improve error message for invalid sdist archives #1389
Merged
Conversation
This file contains 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
Previously, the uv_extract::Error was used as the source and in the
message for the uv_distribution::Error::Extract variant. This led to
duplicated error messages like:
Caused by: Failed to extract source distribution: The top level of the archive must only contain a list directory, but it contains: [DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/__main__.py") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/hexdump.py") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/data") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/PKG-INFO") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/setup.py") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/README.txt") }]
Caused by: The top level of the archive must only contain a list directory, but it contains: [DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/__main__.py") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/hexdump.py") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/data") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/PKG-INFO") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/setup.py") }, DirEntry { inner: DirEntry("/home/user/.cache/uv/.tmphnfEex/README.txt") }]
This patch removes the source error from the error message so the inner
error is only displayed once:
Caused by: Failed to extract source distribution
Caused by: The top level of the archive must only contain a list directory, but it contains: [DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/__main__.py") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/hexdump.py") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/data") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/PKG-INFO") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/setup.py") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/README.txt") }
Previously, the InvalidArchive error variant included the DirEntry
instances for all files in the unzipped directory. This leads to a very
verbose error message even if the only relevant information is the name
of the files in the directory:
Caused by: The top level of the archive must only contain a list directory, but it contains: [DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/__main__.py") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/hexdump.py") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/data") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/PKG-INFO") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/setup.py") }, DirEntry { inner: DirEntry("/home/robin/.cache/uv/.tmpPLyqMo/README.txt") }]
This patch replaces the DirEntry with the file name so that the error
message is much more concise with the same information:
Caused by: The top level of the archive must only contain a list directory, but it contains: ["__main__.py", "hexdump.py", "data", "PKG-INFO", "setup.py", "README.txt"]
|
Thanks so much for contributing! |
zanieb
approved these changes
Feb 16, 2024
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.
This PR improves the error message for the problem described in #1376. The original output duplicates the actual error message and includes lots of noise (
DirEntry { inner: DirEntry(...) }).This PR removes the duplication and
DirEntryinternals so that the error message is easier to grasp: