Generate more informative error message if a src_indices containing slicing operators was incorrectly set #1988
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
Kenneth-T-Moore
approved these changes
Mar 31, 2021
swryan
reviewed
Mar 31, 2021
openmdao/core/component.py
Outdated
| src_inds = _slice_indices(src_inds, np.prod(parent_src_shape), | ||
| parent_src_shape) | ||
| except IndexError as err: | ||
| raise IndexError(f"In component {self.msginfo}: \nError '{err}'\n in " |
There was a problem hiding this comment.
No need for the "In component" part of this message. All of our other error messages just start with {self.msg_info}:, which gives the class and name of the system/component.. This message would be inconsistent with that common format.
openmdao/core/tests/test_group.py
Outdated
| p.setup() | ||
|
|
||
| self.assertTrue(str(e.exception).startswith("In component 'row4_comp'")) | ||
| self.assertTrue(str(e.exception).endswith("with src_indices='(4, Ellipsis)'")) |
There was a problem hiding this comment.
seems like you should just check the entire message, which would also test the value of {oldprom}...
swryan
approved these changes
Apr 5, 2021
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
If the src_indices uses a slicing operator like a colon or ellipsis, and the user makes an error with the src_indices such that an exception occurs, the user only gets a very unhelpful error message like this:
IndexError: index 4 is out of bounds for axis 0 with size 4
A better error message needs to be generated so the user has some hint as to where the problem is.
This PR does that and also includes a test for it.
Related Issues
Backwards incompatibilities
None
New Dependencies
None