feat: use embedded qt browser for jdaviz standalone #3188

maartenbreddels · 2024-09-10T14:13:13Z

Description

This allows running jdaviz in its own browser (using qt) for the command line and the standalone version

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)?

pllim · 2024-09-10T14:30:26Z

Nope... Error: Error: Timed out waiting for: tcp:8765 for Ubuntu

jdaviz/cli.py

camipacifici · 2024-09-10T14:41:43Z

Starting server on http://localhost:60717
INFO: Started server process [19275]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://localhost:60717 (Press CTRL+C to quit)
Traceback (most recent call last):
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/bin/jdaviz", line 8, in
sys.exit(_main())
^^^^^^^
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/jdaviz/cli.py", line 149, in _main
main(filepaths=args.filepaths, layout=layout, instrument=args.instrument, browser=args.browser,
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/jdaviz/cli.py", line 78, in main
run_solara(host=host, port=port, theme=theme, browser=browser)
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/jdaviz/cli.py", line 93, in run_solara
from qtpy.QtWidgets import QApplication
File "/Users/cpacifici/opt/miniconda3/envs/pr3188/lib/python3.11/site-packages/qtpy/init.py", line 287, in
raise QtBindingsNotFoundError from None
qtpy.QtBindingsNotFoundError: No Qt bindings could be found

:(

This also restore the --browser feature that was previously broken.

maartenbreddels · 2024-09-10T15:54:26Z

jdaviz/cli.py

+
+        app = QApplication([""])
+        web = QWebEngineView()
+        web.resize(1000, 1000)


Not sure what we should do here.

maartenbreddels · 2024-09-10T15:58:00Z

I included optional dependencies now @camipacifici , so running

$ pip install -e ".[qt]"

Should get you the correct dependencies.

jdaviz/cli.py

camipacifici · 2024-09-10T16:28:31Z

Thank you! I had to install also PyQtWebEngine. After that, it launched!

codecov · 2024-09-10T16:43:43Z

Codecov Report

Attention: Patch coverage is 3.84615% with 25 lines in your changes missing coverage. Please review.

Project coverage is 88.36%. Comparing base (88ff8da) to head (9bf74d6).

Files with missing lines	Patch %	Lines
jdaviz/cli.py	3.84%	25 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3188      +/-   ##
==========================================
- Coverage   88.45%   88.36%   -0.10%     
==========================================
  Files         124      124              
  Lines       18389    18409      +20     
==========================================
+ Hits        16266    16267       +1     
- Misses       2123     2142      +19

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

maartenbreddels · 2024-09-10T17:04:37Z

ValueError: Key backend: 'module://matplotlib_inline.backend_inline' is not a valid value for backend; supported values are ['gtk3agg', 'gtk3cairo', 'gtk4agg', 'gtk4cairo', 'macosx', 'nbagg', 'notebook', 'qtagg', 'qtcairo', 'qt5agg', 'qt5cairo', 'tkagg', 'tkcairo', 'webagg', 'wx', 'wxagg', 'wxcairo', 'agg', 'cairo', 'pdf', 'pgf', 'ps', 'svg', 'template']
[PYI-12940:ERROR] Failed to execute script 'jdaviz-cli-entrypoint' due to unhandled exception!

Strange to see this error come back from #2944

pllim · 2024-09-12T13:35:34Z

jdaviz/cli.py

@@ -100,7 +121,7 @@ def _main(config=None):
    parser.add_argument('--instrument', type=str, default='nirspec',
                        help='Manually specifies which instrument parser to use, for Mosviz')
    parser.add_argument('--browser', type=str, default='default',
-                        help='Browser to use for application.')
+                        help='Browser to use for application (use qt for embedded qt browser).')


What is an "embedded qt browser"? If you require it for standalone to work, then is Jdaviz turning into Qt app (again)?

Also I think "Qt" has a capital "q".

With embedded I try to communicate that it will not use the system browser, suggestions are welcome.

Not sure I understand what you mean by the second sentence exactly, but it's not a Qt app.

But we're installing Qt stack...

Yes, it's using the Qt browser (chromiums based I think), but that could be any embeddable browser. We are not using any of the Qt widgets for the UI.

kecnry · 2024-09-16T14:50:05Z

standalone/jdaviz-cli-entrypoint.py

+    if "--browser" not in args:
+        args.append("--browser")
+        args.append("qt")


since qt is an optional dependency (and we want to keep it that way), can this default to qt only if it is installed and otherwise use the system browser?

This is only for the standalone, which is built in CI with qt installed. Or do you mean if people build in locally?

if anyone installs jdaviz (from pip for example) but not using the standalone installer, they still have access to the CLI, but may not have the qt optional dependencies.

kecnry · 2024-09-16T14:51:08Z

jdaviz/cli.py

+        from qtpy.QtWidgets import QApplication
+        from qtpy.QtWebEngineWidgets import QWebEngineView
+        from qtpy import QtCore


if these fail to import, should we throw an error with instructions to install the optional dependencies?

Indeed, good idea.

maartenbreddels requested review from rosteen, javerbukh, pllim, kecnry, bmorris3, haticekaratay, cshanahan1 and gibsongreen as code owners September 10, 2024 14:13

maartenbreddels changed the title ~~Feat solara standalone~~ feat: use embedded qt browser for jdaviz standalone Sep 10, 2024

kecnry added this to the 4.0 milestone Sep 10, 2024

kecnry added UI/UX😍 Build standalone Additional pylons labels Sep 10, 2024

pllim added the no-changelog-entry-needed changelog bot directive label Sep 10, 2024

pllim reviewed Sep 10, 2024

View reviewed changes

jdaviz/cli.py Show resolved Hide resolved

kecnry removed the Build standalone Additional pylons label Sep 10, 2024

feat: add --browser=qt to use an embedded browser instead of system one

19548bb

This also restore the --browser feature that was previously broken.

maartenbreddels force-pushed the feat_solara_standalone branch from b3f6983 to 565107e Compare September 10, 2024 15:51

maartenbreddels commented Sep 10, 2024

View reviewed changes

kecnry added the Build standalone Additional pylons label Sep 10, 2024

kecnry reviewed Sep 10, 2024

View reviewed changes

jdaviz/cli.py Outdated Show resolved Hide resolved

maartenbreddels force-pushed the feat_solara_standalone branch 2 times, most recently from 9bf74d6 to 901b68c Compare September 12, 2024 13:33

pllim reviewed Sep 12, 2024

View reviewed changes

maartenbreddels force-pushed the feat_solara_standalone branch from 901b68c to ee19839 Compare September 12, 2024 13:38

feat: use embedded qt browser for jdaviz standalone

7e48dfe

maartenbreddels force-pushed the feat_solara_standalone branch from ee19839 to 7e48dfe Compare September 12, 2024 13:54

kecnry reviewed Sep 16, 2024

View reviewed changes

rosteen modified the milestones: 4.0, 4.1 Oct 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: use embedded qt browser for jdaviz standalone #3188

feat: use embedded qt browser for jdaviz standalone #3188

maartenbreddels commented Sep 10, 2024

pllim commented Sep 10, 2024

camipacifici commented Sep 10, 2024

maartenbreddels Sep 10, 2024

maartenbreddels commented Sep 10, 2024 •

edited

Loading

camipacifici commented Sep 10, 2024 •

edited

Loading

codecov bot commented Sep 10, 2024 •

edited

Loading

maartenbreddels commented Sep 10, 2024

pllim Sep 12, 2024

pllim Sep 12, 2024

maartenbreddels Sep 12, 2024

pllim Sep 12, 2024

maartenbreddels Sep 12, 2024

kecnry Sep 16, 2024

maartenbreddels Sep 17, 2024

kecnry Sep 17, 2024

kecnry Sep 16, 2024

maartenbreddels Sep 17, 2024

feat: use embedded qt browser for jdaviz standalone #3188

Are you sure you want to change the base?

feat: use embedded qt browser for jdaviz standalone #3188

Conversation

maartenbreddels commented Sep 10, 2024

Description

Change log entry

Checklist for package maintainer(s)

pllim commented Sep 10, 2024

camipacifici commented Sep 10, 2024

Choose a reason for hiding this comment

maartenbreddels commented Sep 10, 2024 • edited Loading

camipacifici commented Sep 10, 2024 • edited Loading

codecov bot commented Sep 10, 2024 • edited Loading

Codecov Report

maartenbreddels commented Sep 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maartenbreddels commented Sep 10, 2024 •

edited

Loading

camipacifici commented Sep 10, 2024 •

edited

Loading

codecov bot commented Sep 10, 2024 •

edited

Loading