Improve settings string parse error message#2532
Merged
fenhl merged 2 commits intoMar 7, 2026
Merged
Conversation
IndexError raised when a settings string index exceeds the available choices and gives no context on which setting failed. Added bounds checks in the list/str type branches of the update_with_settings_string() function to raise a descriptive ValueError instead.
fenhl
added
Type: Bug
fenhl
requested changes
Mar 7, 2026
fenhl
left a comment
fenhl
left a comment
Collaborator
There was a problem hiding this comment.
Welcome and thank you for the PR! Just one minor suggestion.
Author
|
Updated! |
fenhl
approved these changes
Mar 7, 2026
fenhl
removed
Status: Waiting for Author
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
2 participants
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.
IndexErrorraised when a settings string index exceeds the available choices gives no context on which setting failed or why. Added bounds checks in the list and str type branches ofupdate_with_settings_string()function to raise a descriptiveValueErrorinstead.Fixes #2380
Testing
Tested with both strings from the issue. Both now raise
ValueErrorwith the setting name and index.Tested with a valid settings string generated from defaults and parses successfully with no error.