DM-41724: make dimension record construction more strict #907
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #907 +/- ##
==========================================
- Coverage 87.72% 87.72% -0.01%
==========================================
Files 285 285
Lines 36743 36760 +17
Branches 7690 7698 +8
==========================================
+ Hits 32232 32246 +14
- Misses 3340 3341 +1
- Partials 1171 1173 +2 ☔ View full report in Codecov by Sentry. |
Timespan.__repr__ has complete information, so we can make __str__ a bit more concise while still including the information we tend to care about.
Timespan was messy and quite long, and is now concise. Regions were really long and not very useful on the CLI, and are now elided entirely. This drops a test workaround for older astropys and bumps the version in requirements.txt, which is already required in rubin-env.
datetimeBegin and datetimeEnd have never been recognized as timespan bounds, but DimensionRecord ignores kwargs it doesn't recognize.
These had gone unnoticed because DimensionRecord silently ignores kwargs it does not recognize.
This field is no longer part of the default DimensionUniverse but it's present in some old YAML exports we want to continue to support. Right now it's being dropped by virtue of DimensionRecord.__init__ silently ignoring any kwargs it does not recognize, which is not ideal.
a9970df to
c8766bb
Compare
dhirving
approved these changes
Nov 17, 2023
Comment on lines
+299
to
+309
| if self.definition.temporal is not None and self.timespan is None and "datetime_begin" in kwargs: | ||
| object.__setattr__( | ||
| self, | ||
| "timespan", | ||
| Timespan( | ||
| kwargs.pop("datetime_begin"), | ||
| kwargs.pop("datetime_end"), | ||
| ), | ||
| ) |
There was a problem hiding this comment.
There's a small change in behavior here, not sure if it is intended to enforce that any Timespan here will always be bounded or not.
Previously if only datetime_begin was passed without also including datetime_end, it would create a Timespan without an upper bound. Now it throws KeyError in this case instead.
There was a problem hiding this comment.
It was intentional, but the reader shouldn't have to wonder about that; I'll add a code comment saying that if you pass one you're required to pass both.
bd79a50 to
32800dc
Compare
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.
Checklist
doc/changes