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.

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

fix footprint defaults when changing traitlets before plugin active #2413

Merged
merged 5 commits into from
Sep 6, 2023

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Aug 31, 2023

Description

This pull request fixes respecting user-changed traitlets (specifically color, but also applies to the preset selection) when those traitlets were set in the API before the overlay objects are fully initialized when the plugin is first opened.

See the included regression test or the following example:

fp = imviz.plugins['Footprints']
fp._obj.vue_link_by_wcs()
fp.color = '#ff33ff'
fp.open_in_tray()

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

kecnry added 3 commits August 31, 2023 12:23
* for the FIRST overlay, the user could have set the color traitlet before the internal overlay object is created (which occurs as soon as the plugin is first shown).  In that case, we want to respect the user choice of color.
@kecnry kecnry added the imviz label Aug 31, 2023
@kecnry kecnry added this to the 3.7 milestone Aug 31, 2023
@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Patch coverage is 66.66% of modified lines.

Files Changed Coverage
...nfigs/default/plugins/plot_options/plot_options.py 39.13%
...viz/configs/imviz/plugins/footprints/footprints.py 90.90%
jdaviz/configs/imviz/tests/test_footprints.py 100.00%

📢 Thoughts on this report? Let us know!.

@kecnry kecnry marked this pull request as ready for review August 31, 2023 17:21
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Thanks!

@camipacifici
Copy link
Contributor

Fixes the problem, thank you!

@kecnry
Copy link
Member Author

kecnry commented Sep 5, 2023

Setting back to draft while I look into the issue of overwriting an existing regions object (that used to work - there is a chance this broke that, so I want to make sure it didn't and make sure we have test coverage for that case).

@kecnry kecnry marked this pull request as draft September 5, 2023 19:32
Copy link
Contributor

@javerbukh javerbukh left a comment

Choose a reason for hiding this comment

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

Fixes the bug as described, thanks!

@kecnry kecnry marked this pull request as ready for review September 6, 2023 17:07
@kecnry kecnry merged commit fefee34 into spacetelescope:main Sep 6, 2023
16 of 21 checks passed
@kecnry kecnry deleted the fix-footprint-default-color branch September 6, 2023 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants