PR: Use JupyterLab to render notebooks #264

jitseniesen · 2020-03-27T16:11:38Z

~~This is far from ready; I just want to show my progress.~~

This PR updates the plugin to use the JupyterLab framework instead of the classic notebook interface, because JupyterLab is the future.

To do list:

Allow for different notebook names instead of assuming it's called test.ipynb
Add the buttons for Save, Insert Cell, Cut, Copy, etc.
Fix saving of notebook when user closes it
Don't ask user to select kernel when opening a new notebook
~~Remove sidebar? Add menubar?~~ deferred to issue Replace sidebar by menubar in new notebook server #270
Make sure unit tests pass
Update CI script
Write contribution info

Fixes #261

pep8speaks · 2020-03-27T16:11:42Z

Hello @jitseniesen! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-04-29 10:04:13 UTC

jitseniesen · 2020-03-27T16:13:43Z

This is just a proof of concept to show off a screen shot:

This makes me more confident that I can make it work!

goanpeca · 2020-03-27T16:17:04Z

Amazing work @jitseniesen !!! Keep it up :-)

ccordoba12 · 2020-03-27T16:23:27Z

Pretty nice!! I just have one question: is this going to create one server instance per notebook?

jitseniesen · 2020-03-27T16:34:19Z

Pretty nice!! I just have one question: is this going to create one server instance per notebook?

I am planning to use the same approach as currently at the start, which is one server instance per directory. However, I want to look at whether it is possible to have only one server instance which can render all notebooks regardless of where they are stored. Unless you think it's preferable to have one server instance per notebook.

ccordoba12 · 2020-03-27T16:55:15Z

I am planning to use the same approach as currently at the start, which is one server instance per directory

The current approach is really one server per user home directory. So if you want to open a notebook in /tmp, you need a new server. I decided to do that to not expose the entire filesystem to the server.

However, I want to look at whether it is possible to have only one server instance which can render all notebooks regardless of where they are stored

That probably won't work on Windows, in case users want to load notebooks from C:\, D:\, etc.

jitseniesen · 2020-03-27T20:37:45Z

Ok, I won't change that in this PR, let's try to stick to one server per home dir.

jitseniesen · 2020-03-31T13:18:23Z

Most things seem to work:

ccordoba12 · 2020-03-31T17:46:39Z

Most things seem to work:

That looks pretty neat!! Thanks @jitseniesen for working on this!

But what about the connection with the IPython console? Is that working?

jitseniesen · 2020-04-02T08:55:53Z

But what about the connection with the IPython console? Is that working?

I tried it out and the old code still seems to work, which is a big relief. You can open a console, access the variables from the notebook in the console and in the variable explorer, and changes made in the console are reflected in the notebook. Let me know if I need to test anything else.

codecov-io · 2020-04-02T15:42:44Z

Codecov Report

Merging #264 into master will decrease coverage by 0.05%.
The diff coverage is 100.00%.

Impacted Files	Coverage Δ
spyder_notebook/notebookplugin.py	`72.38% <100.00%> (+0.17%)`	⬆️
spyder_notebook/utils/nbopen.py	`80.70% <100.00%> (+0.34%)`	⬆️
spyder_notebook/widgets/client.py	`72.84% <100.00%> (-0.41%)`	⬇️
spyder_notebook/widgets/dom.py	`73.68% <100.00%> (-2.51%)`	⬇️

ccordoba12 · 2020-04-02T19:13:20Z

@jitseniesen, you can remove support for Python 2 in version 0.3, if you want.

ccordoba12 · 2020-04-03T18:12:41Z

spyder_notebook/widgets/client.py

+        NB: I am not sure whether the save is performed before the function
+        returns.


This is probably not true because almost all JS operations are asynchronous.

jitseniesen · 2020-04-07T16:35:30Z

I want to get rid of the side bar on the left with the commands and replace it with a menu bar, accessing the same commands (and more). However, I am thinking to leave that to another PR.

Apart from that, I need to write some documentation while things are still fairly fresh in my mind, and then I think this is ready.

ccordoba12 · 2020-04-07T16:51:23Z

I want to get rid of the side bar on the left with the commands and replace it with a menu bar, accessing the same commands (and more). However, I am thinking to leave that to another PR.

I'm fine with that.

For a future PR you should also consider to add some extra JupyterLab extensions. For instance, the ones necessary to display Bokeh or Plotly plots.

At the moment, there is no way to specify the file name of the notebook, it is assumed to be "test.ipynb"

Fix taken from jupyterlab/jupyerlab#218397d1

Update the CSS selector for the save button. Moreover, the save is now done on mousedown, not on click.

Specify kernelspec, so that user is not asked for it.

The new notebook server under JupyterLab does not include a header anymore which needs to be hidden, so this function is no longer needed.

MathJax is not used and the URL is no longer active, generating a warning.

The prompt has a slightly different format in JupyterLab.

Otherwise tests can (and do) influence each other

Support for Python 2 will be dropped in next release.

The instructions are more complicated now that the plugin includes a notebook server written in TypeScript.

jitseniesen added the v0.3 label Mar 27, 2020

jitseniesen self-assigned this Mar 27, 2020

jitseniesen force-pushed the jupyterlab branch 2 times, most recently from 96665d4 to cdcac3c Compare April 3, 2020 09:38

ccordoba12 reviewed Apr 3, 2020

View reviewed changes

jitseniesen added 11 commits April 29, 2020 09:20

Server: Add notebook example from Jupyterlab repo

618fd8f

Client: Use nodebook example server to render notebooks

07b2186

At the moment, there is no way to specify the file name of the notebook, it is assumed to be "test.ipynb"

Server: Fix SVG icons

338552f

Fix taken from jupyterlab/jupyerlab#218397d1

Server: Change URLs to allow opening of arbitrary notebook files

348bdaf

Client: Update notebook save for JupyterLab.

7590ae0

Update the CSS selector for the save button. Moreover, the save is now done on mousedown, not on click.

Plugin: Specify kernelspec when creating new notebook

2523e66

Specify kernelspec, so that user is not asked for it.

Server: Add command to run all cells

c9df259

Client: Remove hide_header()

41129df

The new notebook server under JupyterLab does not include a header anymore which needs to be hidden, so this function is no longer needed.

Templates: Remove MathJax from Welcome template

3a6ab97

MathJax is not used and the URL is no longer active, generating a warning.

Tests: Update prompt_present() for JupyterLab

79f8807

The prompt has a slightly different format in JupyterLab.

CI: Build and set up notebook server, add jupyterlab as dependency

9a9d52d

jitseniesen added 5 commits April 29, 2020 09:22

Tests: Use displayname from Spyder's kernelspec in test notebook

7cd7e4f

Tests: Increate NOTEBOOK_UP delay to 40 s

bb820f0

Tests: Remove module scope from tmpdir_under_home fixture

c73f69e

Otherwise tests can (and do) influence each other

CI: Remove automatic testing for Python 2

8a25923

Support for Python 2 will be dropped in next release.

Server: Clarify license situation

8fbba2b

jitseniesen force-pushed the jupyterlab branch from cdcac3c to 25a866d Compare April 29, 2020 09:19

Docs: Add a Contrbuting Guide with how to set up a dev environment

371a682

The instructions are more complicated now that the plugin includes a notebook server written in TypeScript.

jitseniesen force-pushed the jupyterlab branch from 25a866d to 371a682 Compare April 29, 2020 10:04

This was referenced Apr 29, 2020

Replace sidebar by menubar in new notebook server #270

Closed

Add JupyerLab extensions? #271

Open

jitseniesen marked this pull request as ready for review April 29, 2020 10:14

jitseniesen changed the title ~~[WIP] PR: Use JupyterLab to render notebooks~~ PR: Use JupyterLab to render notebooks Apr 29, 2020

jitseniesen merged commit 024de76 into spyder-ide:master May 13, 2020

jitseniesen deleted the jupyterlab branch May 13, 2020 20:14

jitseniesen mentioned this pull request May 13, 2020

PR: Hide the notebook's File menu #259

Closed

jitseniesen mentioned this pull request May 26, 2020

Using native menu actions of the notebook as 'Rename' its a point of failures #133

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Use JupyterLab to render notebooks #264

PR: Use JupyterLab to render notebooks #264

jitseniesen commented Mar 27, 2020 •

edited

Loading

pep8speaks commented Mar 27, 2020 •

edited

Loading

jitseniesen commented Mar 27, 2020

goanpeca commented Mar 27, 2020

ccordoba12 commented Mar 27, 2020

jitseniesen commented Mar 27, 2020

ccordoba12 commented Mar 27, 2020

jitseniesen commented Mar 27, 2020

jitseniesen commented Mar 31, 2020

ccordoba12 commented Mar 31, 2020

jitseniesen commented Apr 2, 2020

codecov-io commented Apr 2, 2020 •

edited

Loading

ccordoba12 commented Apr 2, 2020

ccordoba12 Apr 3, 2020

jitseniesen commented Apr 7, 2020

ccordoba12 commented Apr 7, 2020

		NB: I am not sure whether the save is performed before the function
		returns.

PR: Use JupyterLab to render notebooks #264

PR: Use JupyterLab to render notebooks #264

Conversation

jitseniesen commented Mar 27, 2020 • edited Loading

pep8speaks commented Mar 27, 2020 • edited Loading

Comment last updated at 2020-04-29 10:04:13 UTC

jitseniesen commented Mar 27, 2020

goanpeca commented Mar 27, 2020

ccordoba12 commented Mar 27, 2020

jitseniesen commented Mar 27, 2020

ccordoba12 commented Mar 27, 2020

jitseniesen commented Mar 27, 2020

jitseniesen commented Mar 31, 2020

ccordoba12 commented Mar 31, 2020

jitseniesen commented Apr 2, 2020

codecov-io commented Apr 2, 2020 • edited Loading

Codecov Report

ccordoba12 commented Apr 2, 2020

ccordoba12 Apr 3, 2020

Choose a reason for hiding this comment

jitseniesen commented Apr 7, 2020

ccordoba12 commented Apr 7, 2020

jitseniesen commented Mar 27, 2020 •

edited

Loading

pep8speaks commented Mar 27, 2020 •

edited

Loading

codecov-io commented Apr 2, 2020 •

edited

Loading