Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revert combination mode to before import_region call #3255

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Revert combination mode to before import_region call #3255

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e30ab18
Revert combination mode to before import_region call
javerbukh Oct 24, 2024
84b7bbd
Add unit test for reverting to previous edit mode
javerbukh Oct 25, 2024
4d67ced
Remove whitespace
javerbukh Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,9 +860,11 @@ def _load_regions(self, regions, combination_mode=None, max_num_regions=None,
if combo_mode_is_list and len(combination_mode) != (len(regions)):
raise ValueError("list of mode must be size of regions")
elif combo_mode_is_list:
for mode in combination_mode:
if mode not in COMBO_OPTIONS:
raise ValueError(f"{mode} not one of {COMBO_OPTIONS}")
unknown_options = list(set(combination_mode) - set(COMBO_OPTIONS))
if len(unknown_options) > 0:
raise ValueError(f"{unknown_options} not one of {COMBO_OPTIONS}")

previous_mode = self.app.session.edit_subset_mode.mode

for index, region in enumerate(regions):
# Set combination mode for how region will be applied to current subset
Expand All @@ -876,6 +878,7 @@ def _load_regions(self, regions, combination_mode=None, max_num_regions=None,
# Remove selection of subset so that new one will be created
self.app.session.edit_subset_mode.edit_subset = None # No overwrite next iteration
self.app.session.edit_subset_mode.mode = SUBSET_MODES_PRETTY['new']

elif combo_mode:
self.combination_mode.selected = combo_mode

Expand Down Expand Up @@ -967,6 +970,8 @@ def _load_regions(self, regions, combination_mode=None, max_num_regions=None,
n_loaded += 1
if max_num_regions is not None and n_loaded >= max_num_regions:
break
# Revert edit mode to before the import_region call
self.app.session.edit_subset_mode.mode = previous_mode
Comment on lines +973 to +974
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there anything above that could actually raise an error (not caught by bad_regions) where the revert should still happen?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not that I could see, does anything stick out to you?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we don't need to catch bugs in the code itself, so bad_regions should be sufficient to make sure the revert happens here. Thanks!


n_reg_in = len(regions)
n_reg_bad = len(bad_regions)
Expand Down
8 changes: 8 additions & 0 deletions jdaviz/configs/default/plugins/subset_plugin/tests/test_subset_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import astropy.units as u
from specutils import SpectralRegion
from glue.core.roi import EllipticalROI, CircularROI, CircularAnnulusROI, RectangularROI
from glue.core.edit_subset_mode import ReplaceMode, OrMode
from numpy.testing import assert_allclose

from jdaviz.configs.default.plugins.subset_plugin import utils
Expand Down Expand Up @@ -198,6 +199,7 @@ def test_import_spectral_region(cubeviz_helper, spectrum1d_cube, spec_regions, m
subsets = cubeviz_helper.app.get_subsets()
assert len(subsets) == len_subsets
assert len(subsets['Subset 1']) == len_subregions
assert cubeviz_helper.app.session.edit_subset_mode.mode == ReplaceMode
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pllim I added this and the lines below, let me know if that is sufficient coverage.



def test_import_spectral_regions_file(cubeviz_helper, spectrum1d_cube, tmp_path):
Expand All @@ -216,5 +218,11 @@ def test_import_spectral_regions_file(cubeviz_helper, spectrum1d_cube, tmp_path)
subsets = cubeviz_helper.app.get_subsets()
assert len(subsets['Subset 1']) == 2

subset2 = (SpectralRegion(5.772486091213352 * u.um, 6.052963676101135 * u.um) +
SpectralRegion(5.8 * u.um, 5.9 * u.um))
plg.import_region(subset2, combination_mode=['new', 'andnot'])

assert cubeviz_helper.app.session.edit_subset_mode.mode == OrMode

with pytest.raises(ValueError, match='test not one of'):
plg.combination_mode.selected = 'test'
Loading