cli: handle deserialization errors #72
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
added 2 commits
September 5, 2023 14:22
We have never handled the JSONDecodeError so consumers are assumed to be catching that exception on their end. This means we cannot wrap all the parser errors into a unified type (e.g. ValueError) without breaking the API. Keep API compatibility on the loader functions by introducing a Serializer class that the cli tool can utilize. This allows the cli to avoid knowing which specific serializer errors to handle. The library itself maintains its current API. Signed-off-by: Cory Todd <cory.todd@canonical.com>
Do not show a stacktrace on the cli tool when an invalid file is specified. Instead, use the new Serializer class to abstract the load process and handle the unified ValueError. Also handle FileNotFound because that's a fairly normal user input scenario as well. Set return code on sys.exit to indicate abnormal exit. Fixes xlwings#71 Signed-off-by: Cory Todd <cory.todd@canonical.com>
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.
For the CLI tool, typical user input should not produce stack traces. Show appropriate messages when one or both file
inputs are invalid or do not exist. This implementation respects the current API by not introducing a unified exception
type directly in the loader implementations. Current library consumers should not be broken by this change but cli users
should see a prettier output when things go wrong.
Fixes #71