CODEWITHSUNDEEP
pythonjupyter-notebookjupyterjupyter-lab
charles strauss
charles strauss

Reputation: 315

How to cause Jupyter Lab to save notebook (programmatically)

I have a notebook that runs overnight, and prints out a bunch of stuff, including images and such. I want to cause this output to be saved programatically (perhaps at certain intervals). I also want to save the code that was run. In a Jupyter notebook, you could do:

from IPython.display import display, Javascript
display(Javascript('IPython.notebook.save_checkpoint();'))
# causes the current .ipynb file to save itself (same as hitting CTRL+s)

(from Save an IPython notebook programmatically from within itself?)

Although, I found that this javascript injection did not work in Jupyter lab(Jupyter not found). My question is how to do the equivalent of the above code in Jupyter lab. Upon inspecting the HTML of the jupyter lab, I could not find the Jupyter object.

Upvotes: 11

Views: 5593

Answers (3)

dnola
dnola

Reputation: 71

I just wanted to share a really small tweak of the other solution by krassowski that works for JupyterLab on MacOS:

from IPython.display import display, HTML

script = """
this.nextElementSibling.focus();
this.dispatchEvent(new KeyboardEvent('keydown', {key:'s', keyCode: 83, metaKey: true}));
"""
display(HTML((
    '<img src onerror="{}" style="display:none">'
    '<input style="width:0;height:0;border:0">'
).format(script)))

Upvotes: 2

krassowski
krassowski

Reputation: 15389

You can use ipylab to access JupyterLab API from Python. To save the notebook just invoke the docmanager:save command:

from ipylab import JupyterFrontEnd

app = JupyterFrontEnd()
app.commands.execute('docmanager:save')

You can get the full list of commands with app.commands.list_commands().

Upvotes: 11

krassowski
krassowski

Reputation: 15389

JupyterLab has a bulit-in auto-save function. You can configure the time interval using the Advanced Settings Editor, the Document Manager section (see screenshot below).

autosave config

However, if you really want a JavaScript solution you could just invoke the keyboard shortcut Ctrl + s with:

from IPython.display import display, Javascript

display(Javascript(
    "document.body.dispatchEvent("
    "new KeyboardEvent('keydown', {key:'s', keyCode: 83, ctrlKey: true}"
    "))"
))

this will only work as long as you do not change focus to a different notebook. However, you can always use an invisible HTML node such as input to reclaim the focus first:

from IPython.display import display, HTML

script = """
this.nextElementSibling.focus();
this.dispatchEvent(new KeyboardEvent('keydown', {key:'s', keyCode: 83, ctrlKey: true}));
"""
display(HTML((
    '<img src onerror="{}" style="display:none">'
    '<input style="width:0;height:0;border:0">'
).format(script)))

And you can always wrap the script in window.setTimout or window.setInterval - but it should not be needed thanks to the built in auto-save function of JupyterLab.

Upvotes: 2

Related Questions