Refactor overlays to be classes instead of dicts #1141
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
psavery
force-pushed
the
overlay-refactor
branch
2 times, most recently
from
bf9fe9d to
9602782
Compare
|
I've tested several different workflows with this PR, and so far, things seem to be working fine. I think it will be ready for merging after our next release (don't want to merge it before the next release in case it introduces new bugs). |
The overlay dicts have become more and more complicated as time has gone on, and new synchronizations between their values and other parts of the program (such as the image series) have made them even more complicated to maintain. As such, it has become a good time to convert them to be classes instead of dicts, where the classes can internally keep up with any synchronizations that are needed. This will also hopefully fix a bug we were encountering where an overlay was being modified to have a refinements list from another overlay. This shouldn't be possible with objects. There is a new format for serializing the overlays, but backward compatible readers are also now used so that the transition is seamless. Since the overlays are used in many, many parts of the code, we really need to do some thorough testing to find and fix any bugs this refactoring may cause. Signed-off-by: Patrick Avery <[email protected]>
psavery
force-pushed
the
overlay-refactor
branch
from
9602782 to
f26cf87
Compare
|
This is ready as long as the last hexrdgui release is in good shape. |
joelvbernier
approved these changes
Feb 4, 2022
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.
The overlay dicts have become more and more complicated as time has
gone on, and new synchronizations between their values and other
parts of the program (such as the image series) have made them even
more complicated to maintain.
As such, it has become a good time to convert them to be classes
instead of dicts, where the classes can internally keep up with any
synchronizations that are needed.
This will also hopefully fix a bug we were encountering where an
overlay was being modified to have a refinements list from another
overlay. This shouldn't be possible with objects.
There is a new format for serializing the overlays, but backward
compatible readers are also now used so that the transition is
seamless.
Since the overlays are used in many, many parts of the code, we
really need to do some thorough testing to find and fix any bugs
this refactoring may cause.