feat(ux): add error better ux for hash not found #10065
Open
+92
−7
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
This changes introduces the use of `PoetryRuntimeError` that allows better error information propagation to facilitate improved ux for users encountering errors. Resolves: python-poetry#10057
abn
added
area/error-handling
|
@sourcery-ai review |
1 similar comment
|
@sourcery-ai review |
Reviewer's Guide by SourceryThis PR introduces the Sequence diagram for hash mismatch error handlingsequenceDiagram
participant Chooser as Package Chooser
participant Error as PoetryRuntimeError
participant Executor as Executor
participant IO as IO Interface
Chooser->>Error: create(reason, messages)
Note over Chooser,Error: Hash mismatch detected
Error->>Error: format messages
Executor->>Error: get_text(verbose, indent)
Error->>IO: write error message
Note over IO: Display formatted error<br/>with optional debug info
Class diagram for new error handling classesclassDiagram
class CleoError {
}
class PoetryConsoleError {
}
class GroupNotFoundError {
}
class ConsoleMessage {
+str text
+bool debug
+str stripped()
}
class PoetryRuntimeError {
-list[ConsoleMessage] _messages
-int exit_code
+__init__(reason: str, messages: list[ConsoleMessage], exit_code: int)
+write(io: IO)
+get_text(debug: bool, indent: str, strip: bool) str
+__str__() str
}
CleoError <|-- PoetryConsoleError
PoetryConsoleError <|-- GroupNotFoundError
PoetryConsoleError <|-- PoetryRuntimeError
PoetryRuntimeError o-- ConsoleMessage
note for PoetryRuntimeError "New class for improved error handling"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @abn - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟡 Testing: 2 issues found
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+373
to
+378
| reason = f"Downloaded distributions for {package.name} ({package.version}) did not match any known checksums in your lock file." | ||
| assert str(e.value) == reason | ||
|
|
||
| text = e.value.get_text(debug=True, strip=True) | ||
| assert reason in text | ||
| assert files[0]["hash"] in text |
There was a problem hiding this comment.
suggestion (testing): Test both debug and non-debug text.
It would be beneficial to also test the non-debug version of the error message to ensure that the correct information is displayed to users in both verbose and non-verbose modes.
Suggested change
| reason = f"Downloaded distributions for {package.name} ({package.version}) did not match any known checksums in your lock file." | |
| assert str(e.value) == reason | |
| text = e.value.get_text(debug=True, strip=True) | |
| assert reason in text | |
| assert files[0]["hash"] in text | |
| reason = f"Downloaded distributions for {package.name} ({package.version}) did not match any known checksums in your lock file." | |
| assert str(e.value) == reason | |
| # Test non-debug error message | |
| text = e.value.get_text(debug=False, strip=True) | |
| assert reason in text | |
| assert files[0]["hash"] not in text # Hash should not be included in non-debug output | |
| # Test debug error message | |
| debug_text = e.value.get_text(debug=True, strip=True) | |
| assert reason in debug_text | |
| assert files[0]["hash"] in debug_text # Hash should be included in debug output |
Comment on lines
+376
to
380
| text = e.value.get_text(debug=True, strip=True) | ||
| assert reason in text | ||
| assert files[0]["hash"] in text | ||
|
|
||
|
|
There was a problem hiding this comment.
suggestion (testing): Add tests for multiple mismatched hashes.
Consider adding a test case where multiple files have mismatched hashes to ensure the error message handles this scenario correctly. The current tests only cover a single mismatch.
Suggested change
| text = e.value.get_text(debug=True, strip=True) | |
| assert reason in text | |
| assert files[0]["hash"] in text | |
| text = e.value.get_text(debug=True, strip=True) | |
| assert reason in text | |
| assert files[0]["hash"] in text | |
| def test_chooser_with_multiple_mismatched_hashes(package, chooser): | |
| files = [ | |
| { | |
| "name": "demo-0.1.0.tar.gz", | |
| "hash": "incorrect_hash_1", | |
| "url": "https://files.pythonhosted.org/demo-0.1.0.tar.gz", | |
| }, | |
| { | |
| "name": "demo-0.1.0-py2.py3-none-any.whl", | |
| "hash": "incorrect_hash_2", | |
| "url": "https://files.pythonhosted.org/demo-0.1.0-py2.py3-none-any.whl", | |
| } | |
| ] | |
| package.files = files | |
| with pytest.raises(PoetryRuntimeError) as e: | |
| chooser.choose_for(package) | |
| reason = f"Downloaded distributions for {package.name} ({package.version}) did not match any known checksums in your lock file." | |
| assert str(e.value) == reason | |
| text = e.value.get_text(debug=True, strip=True) | |
| assert reason in text | |
| # Verify both mismatched hashes are mentioned in the error | |
| assert files[0]["hash"] in text | |
| assert files[1]["hash"] in text | |
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 changes introduces the use of
PoetryRuntimeErrorthat allows better error information propagation to facilitate improved ux for users encountering errors.Resolves: #10057
Before
After
After (verbose)
After (Multiple)
Summary by Sourcery
Improve the user experience when a package hash is not found during installation by providing more informative error messages.
Bug Fixes:
Enhancements: