fix: narrow bare except Exception in VS Code settings merge - #3844
Merged
Conversation
Replace overly broad except Exception with (OSError, ValueError, KeyError) to let programming errors like TypeError or AttributeError propagate while still handling expected I/O and parse errors gracefully.
Contributor
There was a problem hiding this comment.
Pull request overview
Narrows VS Code settings merge error handling so unexpected failures propagate.
Changes:
- Replaces broad exception handling with selected exception types.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/_utils.py |
Narrows settings merge exception handling. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
src/specify_cli/_utils.py:216
KeyErroris still a programming-error class, and no operation on this path uses an unchecked dictionary lookup: JSON5 parse failures areValueError, filesystem operations raiseOSError, andmerge_json_filesguards membership before indexing. CatchingKeyErrortherefore still suppresses the kind of unexpected defect the PR says should propagate; limit this handler to the expected I/O and parse failures.
except (OSError, ValueError, KeyError) as e:
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Medium
The narrow exception change from 'except Exception' to 'except (OSError, ValueError, KeyError)' was not covered by a regression test. Add a test that monkeypatches merge_json_files to raise TypeError and verifies it propagates rather than being swallowed.
Contributor
There was a problem hiding this comment.
Review details
Suppressed comments (1)
src/specify_cli/_utils.py:216
- This does not fully provide the promised programming-error propagation.
KeyErroris still swallowed here even though none of the expected file/JSON failure paths raises it, andmerge_json_files()still catches everyExceptionwhile loading the existing settings (line 252), so aTypeErrorfrom that part of the merge is still converted toNone. RemoveKeyErrorfrom this handler and narrow the inner handler to the expected I/O/parse exceptions as well; the new test should exercise that real inner path rather than replacing the whole helper.
except (OSError, ValueError, KeyError) as e:
- Files reviewed: 2/2 changed files
- Comments generated: 0 new
- Review effort level: Balanced
Collaborator
|
Thank you! |
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
Narrow bare
except Exceptionto specific exception types to let programming errors propagate.Changes
_utils.py: Replaceexcept Exceptionwith(OSError, ValueError, KeyError)