Spectrum refactoring, Spectrum2DCollection #305
Merged
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
ajjackson
changed the title
ajjackson
force-pushed
the
spectrum-2d-collection
branch
2 times, most recently
from
53d8b77
to
92b3af4
Compare
|
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #305 +/- ##
==========================================
- Coverage 95.85% 95.47% -0.39%
==========================================
Files 28 28
Lines 3982 4021 +39
Branches 803 816 +13
==========================================
+ Hits 3817 3839 +22
- Misses 97 109 +12
- Partials 68 73 +5 ☔ View full report in Codecov by Sentry. |
ajjackson
force-pushed
the
spectrum-2d-collection
branch
2 times, most recently
from
8a5a1d0
to
58306c3
Compare
- This version of select() should be more robust in dealing with parameters that exist in "top level" of metadata dict - I hope it is also easier to understand
Some of this was done in another branch, and this one rebased
This adds toolz as a dependency to the main package. We don't anticipate that causing a lot of problems; it is a small, stable, pure-python library also available on conda-forge.
Linters hate the named lambdas. I think they are quite nice because they are compact and immediately draw attention to the "one-liner" they attach a name to... but maybe the more explicit form with type hints will make it easier for someone to understand in future.
This structure seems a bit more legible and should reduce redundancy in Spectrum2DCollection
Collect the axis-twiddling code in one place to improve readability.
- Refactor re-used data import to use pytest fixture - Remove initial from_spectra test; new one covers it all - Test from_spectra with inconsistent input - Test mixin-supplied methods
ajjackson
force-pushed
the
spectrum-2d-collection
branch
from
58306c3
to
56dfcb9
Compare
oerc0122
reviewed
Sep 18, 2024
Make things a little cleaner and more idiomatic Co-authored-by: Jacob Wilkins <[email protected]>
oerc0122
reviewed
Sep 19, 2024
euphonic/spectra.py
Outdated
Comment on lines
925
to
928
| select_key_values = dict( | ||
| (key, (value,)) if isinstance(value, (int, str)) else (key, value) | ||
| for key, value in select_key_values.items() | ||
| ) |
There was a problem hiding this comment.
Actually, you've got toolz does this mean we could do this with a mapvalues?
- This avoids some of the repetition in dict comprehensions to remove an element - Here we also slightly rework _combine_metadata so it is clearer what each variable represents.
list comprehension is little clunky but avoids the 1-length special case: cleaner overall
Via discussion / pair-programming with @oerc0122 - Use native dict comprehension over keyfilter in iter_metadata: it's a bit ugly but no more complicated, and should be easier to read "casually" - Clearer comment re: value-pair combination - Replace a lambda with named partial function and toolz complement
oerc0122
approved these changes
Sep 26, 2024
Co-authored-by: Jacob Wilkins <[email protected]>
oerc0122
approved these changes
Sep 26, 2024
Merged
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.
As part of a major refactor of Abins, we would like to use a Spectrum2DCollection object which behaves similarly to Spectrum1DCollection. This allows the code to largely treat 1D and 2D data interchangably, simplifying the logic and providing access to select/groupby "table-like" operations on the data.
This is implemented by factoring out the "collection"-specific methods to a "mixin" class. This gives a reasonable class heirarchy in which Spectrum1D, Spectrum2D, Spectrum1DCollection and Spectrum2DCollection are all children of Spectrum but not of each other.
In the process, we also found some limitations and inefficiencies in the existing Spectrum objects:
iter_metadatamethod that iterates over metadata lines, merging the top-level and "line-data" parts on the fly. This is also a good building block to simplify some of the other metadata-handling methods.