Having a JuptyerLab Extension force a notebook to save

mcrutch · October 16, 2020, 3:50pm

I am develoing a JupyterLab extension that modifies notebook metadata and I want to force a save immediately after the metadata has been modified. In Jupyter classic this was Jupyter.notebook.save_notebook(); but in JupyterLab I have not been able to find an equivalent function call. I am doing this in the context of a button on the notebook panel, so generically the button is defined as such.

class ButtonExtension implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel> {

I have the buttons appearing and firing actions, modifying the metadata, but I can’t force the save. Any thoughts would be appreciated.

Remborg · October 22, 2020, 11:34am

It looks like there is a save() method in the context object, maybe you can use this?

github.com

jupyterlab/jupyterlab/blob/4e7c446dccae5e82b1eba9af3eb1705917bc91a5/packages/docmanager/src/savehandler.ts#L119


}

// Bail if the model is not dirty or the file is not writable, or the dialog
// is already showing.
const writable = context.contentsModel && context.contentsModel.writable;
if (!writable || !context.model.dirty || this._inDialog) {
  return;
}

const start = new Date().getTime();
context
  .save()
  .then(() => {
    if (this.isDisposed) {
      return;
    }
    const duration = new Date().getTime() - start;
    // New save interval: higher of 10x save duration or min interval.
    this._interval = Math.max(
      this._multiplier * duration,
      this._minInterval

mcrutch · November 3, 2020, 10:51am

Thanks! I completely overlooked that but that was the answer.

Topic		Replies	Views
Jupyterlab extension to add a button to save the notebook and launch a command extensions jupyterlab	2	1547	July 15, 2022
Extension that is notified while current notebook is saved JupyterLab jupyterlab , how-to , help-wanted	1	611	September 30, 2021
Subscribing to the Notebook "save" event on the JupyterLab server extension extensions jupyterlab , help-wanted	2	339	October 24, 2023
Calling JavaScript commands that depend on the context JupyterLab how-to	2	826	March 11, 2022
How to save Jupyter notebook via API? Notebook	3	1631	December 3, 2019

Having a JuptyerLab Extension force a notebook to save

Related topics