refactor: use jupyter_server ExtensionApp #492

maartenbreddels · 2019-12-04T10:55:22Z

A 'reboot' of #270 with a single clean commit to avoid merge conflicts with other PR's.

@Zsailer I took out many code reformatting changes, since they confused the diff-er, and me, and with large outstanding PR's it will lead to many more merge conflicts and a polluted history. I hope you don't hold it against me :)

Replaces #270

Zsailer · 2019-12-04T15:40:03Z

This is great! Thank you, @maartenbreddels.

Zsailer · 2019-12-04T15:42:29Z

We're rolling back jupyter_server to support Python 3.5 for a new release (0.2) with the ExtensionApp. This should be done by Friday.

Then, we'll likely drop Python 3.5 in a jupyter_server 0.3 release. The new Kernel Provider work from @kevin-bates that we're hoping to land in master this next month requires Python 3.6 and above.

kevin-bates · 2019-12-04T16:56:52Z

Just to be clear, we can easily fix the 3.5 support issue in kernel provider stuff. There was a recent change that unexpectedly introduced a syntax error only on 3.5 - and we had cut the 0.5.0 release just prior to that discovery (thus the hesitancy to fix it for something that we thought was more near to its EOL). Of course, by the time jupyter-server 0.3.0 is developed, 3.5 may be deprecated, but we shouldn't let this hold up use of JKM. It's relatively easy to produce a patch release (0.5.1) that restores 3.5 support in JKM if necessary.

SylvainCorlay · 2019-12-04T17:01:05Z

Note: we have a constraint to support Python 3.5 for a little bit more in Voilà. Having jupyter_server be compatible with python 3.5 would be great!

Zsailer · 2019-12-04T19:28:16Z

Ok, we've reverted jupyter_server to support 3.5 in jupyter-server/jupyter_server#150.

maartenbreddels · 2019-12-06T09:08:18Z

Thanks @kevin-bates , @Zsailer and @echarles for correcting this before I even had time to reply 👏

Related:
jupyter-server/jupyter_server#150
jupyter-server/jupyter_server#142

Zsailer · 2019-12-19T19:51:29Z

Just release Jupyter Server 0.2.0.

Still supports Python 3.5 and includes all the ExtensionApp work (with tests, finally). Let us know if you run into any issues. I'm happy to help with this PR too, if you'd like.

setup.py

Zsailer · 2020-01-10T20:16:23Z

tests/app/conftest.py

-    voila_app.initialize(voila_args + ['--no-browser'])
-    voila_config(voila_app)
-    voila_app.start()
+def voila_app(server_config, voila_config, voila_args):


I released jupyter_server 0.2.1 (see changelog) today, which includes a pytest-plugin for jupyter_server.

Inside this plugin, we've added a serverapp fixture and a configurable_serverapp fixture that handle the creation + teardown of a jupyter server instance between each test so you don't have to.

You can see an example using this plugin here in nbclassic.

Zsailer · 2020-01-10T20:21:18Z

tests/app/execute_test.py

@@ -14,8 +14,8 @@


 @pytest.mark.gen_test
-def test_hello_world(http_client, base_url):
-    response = yield http_client.fetch(base_url)
+def test_hello_world(http_client, default_url):


The jupyter server pytest-plugin we added in jupyter_server 0.2.1 drastically improves this syntax.

You can now use async/await syntax.

we over a fetch fixture—a function for making requests to the jupyter server API and extension handlers.

To see an example, check out this simple unit test in Jupyter Server.

Zsailer · 2020-01-10T20:29:50Z

I mentioned in my comments, I released Jupyter Server 0.2.1 today. This includes a pytest-plugin for jupyter server extensions (like future Voila).

This significantly improves the syntax when writing extension tests:

Can now use async/await syntax when writing tests (see example here).
serverapp fixture that handles setup/teardown.
fetch fixture for asynchronous/awaitable requests to the serverapp+extension APIs.
other helpful fixtures, see summary list here.
Extend the serverapp fixture with a voila_app fixture easily. See example from nbclassic.

To start using today, pip install jupyter_server>=0.2.1 and add pytest_jupyter_server to your top-level conftest.py.

jtpio · 2020-01-27T14:19:11Z

This looks great!

Just tried locally with jupyter_server 0.2.1. It looks like some minor adjustments are required to take into account the latest changes (getting a KeyError: 'extension_name' at the moment).

.github/workflows/main.yml

jtpio · 2020-01-28T11:17:34Z

Opened jupyter-server/jupyter_server#175 for the extension_name default value and validation.

jtpio · 2020-01-28T13:00:06Z

I think we also need this change: jupyter-server/jupyter_server#172

jtpio · 2020-01-28T14:09:25Z

Also, this issue seems to prevent using Voila as a server extension at the moment: jupyter-server/jupyter_server#74.

jtpio · 2020-01-28T15:04:03Z

voila/app.py

+        self.serverapp.log.debug("using template: %s", self.template)
+        self.serverapp.log.debug("nbconvert template paths:\n\t%s", "\n\t".join(self.nbconvert_template_paths))
+        self.serverapp.log.debug("template paths:\n\t%s", "\n\t".join(self.template_paths))
+        self.serverapp.log.debug("static paths:\n\t%s", "\n\t".join(self.static_paths))

        jenv_opt = {"autoescape": True}  # we might want extra options via cmd line like notebook server
        env = jinja2.Environment(loader=jinja2.FileSystemLoader(self.template_paths), extensions=['jinja2.ext.i18n'], **jenv_opt)


I wonder if we could make use of ExtensionAppJinjaMixin here: https://github.com/jupyter/jupyter_server/blob/5f99e53f7206c1272494a977e3246aa870d74fdf/jupyter_server/extension/application.py#L89

davidbrochart · 2020-02-19T10:54:45Z

I'm trying to sync this PR with master, I opened a PR in @maartenbreddels's refactor_extension_app branch: maartenbreddels#1

stonebig · 2020-09-19T14:22:40Z

hello,

I'm experimenting Jupyter-server-1.0.1, and pip warns me voila is not compatible yet.

voila 0.2.2 requires jupyter-server<0.4.0,>=0.3.0, but you'll have jupyter-server 1.0.1 which is incompatible.

Is there an ongoing set of pull request that resolves this ?

trungleduc · 2023-08-01T09:31:52Z

Closing as the proposed changes are not applicable anymore to the next release of Voila

Zsailer mentioned this pull request Dec 4, 2019

[WIP] Voila as an ExtensionApp #270

Closed

maartenbreddels force-pushed the refactor_extension_app branch 4 times, most recently from 2d3cb87 to 4262d57 Compare December 6, 2019 11:01

Zsailer and others added 2 commits December 6, 2019 12:11

refactor: use jupyter_server ExtensionApp

28f2a81

chore(ci): install jupyter_server master

13b3818

maartenbreddels force-pushed the refactor_extension_app branch from 4262d57 to 13b3818 Compare December 6, 2019 11:11

jtpio mentioned this pull request Dec 27, 2019

voila is not compatible with jupyter_server upper than 0.2.0 #506

Open

jtpio reviewed Dec 27, 2019

View reviewed changes

setup.py Outdated Show resolved Hide resolved

jtpio mentioned this pull request Jan 10, 2020

How to log connection details when using voila stand alone? #512

Open

Zsailer reviewed Jan 10, 2020

View reviewed changes

jtpio mentioned this pull request Jan 14, 2020

Voila.ip option not in documentation and -h help string #447

Open

jtpio reviewed Jan 28, 2020

View reviewed changes

.github/workflows/main.yml Outdated Show resolved Hide resolved

jtpio mentioned this pull request Jan 28, 2020

Fix default extension_name and validation jupyter-server/jupyter_server#175

Merged

jtpio reviewed Jan 28, 2020

View reviewed changes

Use jupyter_server 0.2.1

262bad0

davidbrochart mentioned this pull request Mar 2, 2020

Refactor extension app #548

Closed

maartenbreddels mentioned this pull request May 4, 2020

Voila as an ExtensionApp (was #270) #563

Closed

jtpio mentioned this pull request Sep 9, 2021

Switch to voila as a Jupyter Server ExtensionApp #955

Open

trungleduc closed this Aug 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: use jupyter_server ExtensionApp #492

refactor: use jupyter_server ExtensionApp #492

maartenbreddels commented Dec 4, 2019

Zsailer commented Dec 4, 2019

Zsailer commented Dec 4, 2019 •

edited

Loading

kevin-bates commented Dec 4, 2019

SylvainCorlay commented Dec 4, 2019

Zsailer commented Dec 4, 2019

maartenbreddels commented Dec 6, 2019

Zsailer commented Dec 19, 2019

Zsailer Jan 10, 2020

Zsailer Jan 10, 2020

Zsailer commented Jan 10, 2020

jtpio commented Jan 27, 2020 •

edited

Loading

jtpio commented Jan 28, 2020 •

edited

Loading

jtpio commented Jan 28, 2020

jtpio commented Jan 28, 2020

jtpio Jan 28, 2020

davidbrochart commented Feb 19, 2020

stonebig commented Sep 19, 2020 •

edited

Loading

trungleduc commented Aug 1, 2023

refactor: use jupyter_server ExtensionApp #492

refactor: use jupyter_server ExtensionApp #492

Conversation

maartenbreddels commented Dec 4, 2019

Zsailer commented Dec 4, 2019

Zsailer commented Dec 4, 2019 • edited Loading

kevin-bates commented Dec 4, 2019

SylvainCorlay commented Dec 4, 2019

Zsailer commented Dec 4, 2019

maartenbreddels commented Dec 6, 2019

Zsailer commented Dec 19, 2019

Zsailer Jan 10, 2020

Choose a reason for hiding this comment

Zsailer Jan 10, 2020

Choose a reason for hiding this comment

Zsailer commented Jan 10, 2020

jtpio commented Jan 27, 2020 • edited Loading

jtpio commented Jan 28, 2020 • edited Loading

jtpio commented Jan 28, 2020

jtpio commented Jan 28, 2020

jtpio Jan 28, 2020

Choose a reason for hiding this comment

davidbrochart commented Feb 19, 2020

stonebig commented Sep 19, 2020 • edited Loading

trungleduc commented Aug 1, 2023

Zsailer commented Dec 4, 2019 •

edited

Loading

jtpio commented Jan 27, 2020 •

edited

Loading

jtpio commented Jan 28, 2020 •

edited

Loading

stonebig commented Sep 19, 2020 •

edited

Loading