DM-38602: Include failing VisitInfo serialization version in error message #684
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
parejkoj
changed the title
parejkoj
force-pushed
the
tickets/DM-38602
branch
from
724a668
to
40862de
Compare
arunkannawadi
approved these changes
May 3, 2023
src/image/VisitInfo.cc
Outdated
| std::to_string(SERIALIZATION_VERSION)); | ||
| std::to_string(SERIALIZATION_VERSION) + | ||
| ", found version " + | ||
| std::to_string(version) + " in file."); |
There was a problem hiding this comment.
Ending the log message in "in file. " is unnecessary and potentially confusing. This could lead a user to expect a path to appear after that, or think that the path did not appear for whatever reason.
tests/test_visitInfo.py
Outdated
| @@ -360,6 +360,11 @@ def testPersistenceVersions(self): | |||
| self._testFitsRead(self.data1, os.path.join(dataDir, "visitInfo-version-3.fits"), 3) | |||
| self._testFitsRead(self.data1, os.path.join(dataDir, "visitInfo-version-4.fits"), 4) | |||
|
|
|||
| # Check that reading a newer file raises a useful exception. | |||
| with self.assertRaisesRegex(TypeError, | |||
| r"Cannot read VisitInfo FITS version .* found version 999999"): | |||
There was a problem hiding this comment.
Suggested change
| r"Cannot read VisitInfo FITS version .* found version 999999"): | |
| r"Cannot read VisitInfo FITS version > .* found version 999999"): |
There was a problem hiding this comment.
It'd be good to include all parts of the string that don't vary in here, and leave only the variable version number for regex. I am not sure where the comma should go before the "found version", but I'll leave it to you whether to include it or not.
rearmstr
approved these changes
May 3, 2023
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.
No description provided.