FEAT: Catalog Search plugin to support import catalog from Table/QTable object

[pllim]

Description

This pull request is to add support for Catalog Search plugin to import table directly from existing Table/QTable object. To do this, we expose a new public API called import_catalog.

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. Bugfix milestone also needs an accompanying backport label.
• After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 🐱

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.53%. Comparing base (aedb793) to head (ace010e).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3425   +/-   ##
=======================================
  Coverage   87.53%   87.53%           
=======================================
  Files         128      128           
  Lines       19957    19962    +5     
=======================================
+ Hits        17469    17474    +5     
  Misses       2488     2488           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[camipacifici]

Would it be in scope to add the API equivalent to clicking "search"?

[pllim]

API equivalent to clicking "search"

Well, the method is there, just not exposed... Gotta ask @kecnry or @javerbukh why not though.

jdaviz/jdaviz/configs/imviz/plugins/catalogs/catalogs.py

Line 107 in 27c6852

def search(self, error_on_fail=False):

[kecnry]

I suspect just because catalogs was/is still a work in progress and the API methods have not yet been exposed (except for recent work for zoom_to_selected it seems). That said, search probably is pretty safe to expose if we want.

[pllim]

Perhaps exposing search should be a separate ticket and it seems pretty unrelated to loading from table object. This is because we should double check if the existing signature and return value are satisfactory. Once exposed, those are hard to change without issuing notice or deprecation.

[camipacifici]

Gotcha, thanks

[camipacifici]

In any case, this worked with the example I had in hand. 👍

[gibsongreen]

Test clean up looks great and the table code looks is clean, love the simplicity. Works as expected when testing, great job!

[cshanahan1]

why the ._obj added here (and below)?

[pllim]

Because I changed catalogs_plugin = imviz_helper.plugins['Catalog Search']._obj to catalogs_plugin = imviz_helper.plugins['Catalog Search'] (old: L223, new: L221) so I can accessed the public API publicly, which means I need to throw in a ._obj for all others. Hope this clarifies the matter.

[cshanahan1]

oh i missed that, sorry! thanks for clarifying

[cshanahan1]

looks good, just left one comment for clarification on something

[pllim]

Thanks for the reviews!