@jupyterlab/notebook 4.0.0-alpha.21 → 4.0.0-alpha.22

package/lib/actions.d.ts

@@ -1,4 +1,4 @@
-import { ISessionContext } from '@jupyterlab/apputils';
+import { ISessionContext, ISessionContextDialogs } from '@jupyterlab/apputils';
 import { Cell } from '@jupyterlab/cells';
 import * as nbformat from '@jupyterlab/nbformat';
 import { KernelMessage } from '@jupyterlab/services';
@@ -173,8 +173,9 @@ export declare namespace NotebookActions {
      * Run the selected cell(s).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The last selected cell will be activated, but not scrolled into view.
@@ -182,13 +183,14 @@ export declare namespace NotebookActions {
      * An execution error will prevent the remaining code cells from executing.
      * All markdown cells will be rendered.
      */
-    function run(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function run(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run the selected cell(s) and advance to the next cell.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -198,13 +200,14 @@ export declare namespace NotebookActions {
      * If the last selected cell is the last cell, a new code cell
      * will be created in `'edit'` mode.  The new cell creation can be undone.
      */
-    function runAndAdvance(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAndAdvance(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run the selected cell(s) and insert a new code cell.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * An execution error will prevent the remaining code cells from executing.
@@ -214,13 +217,14 @@ export declare namespace NotebookActions {
      * The cell insert can be undone.
      * The new cell will be scrolled into view.
      */
-    function runAndInsert(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAndInsert(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run all of the cells in the notebook.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -228,14 +232,15 @@ export declare namespace NotebookActions {
      * All markdown cells will be rendered.
      * The last cell in the notebook will be activated and scrolled into view.
      */
-    function runAll(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
-    function renderAllMarkdown(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAll(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
+    function renderAllMarkdown(notebook: Notebook): Promise<boolean>;
     /**
      * Run all of the cells before the currently active cell (exclusive).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -243,13 +248,14 @@ export declare namespace NotebookActions {
      * All markdown cells will be rendered.
      * The currently active cell will remain selected.
      */
-    function runAllAbove(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAllAbove(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run all of the cells after the currently active cell (inclusive).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -257,7 +263,7 @@ export declare namespace NotebookActions {
      * All markdown cells will be rendered.
      * The last cell in the notebook will be activated and scrolled into view.
      */
-    function runAllBelow(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAllBelow(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Replaces the selection in the active cell of the notebook.
      *

package/lib/actions.js

@@ -1,6 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { Clipboard, Dialog, sessionContextDialogs, showDialog } from '@jupyterlab/apputils';
+import { Clipboard, Dialog, showDialog } from '@jupyterlab/apputils';
 import { CodeCell, isMarkdownCellModel, isRawCellModel, MarkdownCell } from '@jupyterlab/cells';
 import { signalToPromise } from '@jupyterlab/coreutils';
 import { nullTranslator } from '@jupyterlab/translation';
@@ -396,8 +396,9 @@ export class NotebookActions {
      * Run the selected cell(s).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The last selected cell will be activated, but not scrolled into view.
@@ -405,12 +406,12 @@ export class NotebookActions {
      * An execution error will prevent the remaining code cells from executing.
      * All markdown cells will be rendered.
      */
-    function run(notebook, sessionContext) {
+    function run(notebook, sessionContext, sessionDialogs, translator) {
         if (!notebook.model || !notebook.activeCell) {
             return Promise.resolve(false);
         }
         const state = Private.getState(notebook);
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook, sessionContext, sessionDialogs, translator);
         Private.handleRunState(notebook, state, false);
         return promise;
     }
@@ -419,8 +420,9 @@ export class NotebookActions {
      * Run the selected cell(s) and advance to the next cell.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -430,13 +432,13 @@ export class NotebookActions {
      * If the last selected cell is the last cell, a new code cell
      * will be created in `'edit'` mode.  The new cell creation can be undone.
      */
-    async function runAndAdvance(notebook, sessionContext) {
+    async function runAndAdvance(notebook, sessionContext, sessionDialogs, translator) {
         var _a;
         if (!notebook.model || !notebook.activeCell) {
             return Promise.resolve(false);
         }
         const state = Private.getState(notebook);
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook, sessionContext, sessionDialogs, translator);
         const model = notebook.model;
         if (notebook.activeCellIndex === notebook.widgets.length - 1) {
             // Do not use push here, as we want an widget insertion
@@ -463,8 +465,9 @@ export class NotebookActions {
      * Run the selected cell(s) and insert a new code cell.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * An execution error will prevent the remaining code cells from executing.
@@ -474,13 +477,13 @@ export class NotebookActions {
      * The cell insert can be undone.
      * The new cell will be scrolled into view.
      */
-    async function runAndInsert(notebook, sessionContext) {
+    async function runAndInsert(notebook, sessionContext, sessionDialogs, translator) {
         var _a;
         if (!notebook.model || !notebook.activeCell) {
             return Promise.resolve(false);
         }
         const state = Private.getState(notebook);
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook, sessionContext, sessionDialogs, translator);
         const model = notebook.model;
         model.sharedModel.insertCell(notebook.activeCellIndex + 1, {
             cell_type: notebook.notebookConfig.defaultCell
@@ -500,8 +503,9 @@ export class NotebookActions {
      * Run all of the cells in the notebook.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -509,7 +513,7 @@ export class NotebookActions {
      * All markdown cells will be rendered.
      * The last cell in the notebook will be activated and scrolled into view.
      */
-    function runAll(notebook, sessionContext) {
+    function runAll(notebook, sessionContext, sessionDialogs, translator) {
         if (!notebook.model || !notebook.activeCell) {
             return Promise.resolve(false);
         }
@@ -517,12 +521,12 @@ export class NotebookActions {
         notebook.widgets.forEach(child => {
             notebook.select(child);
         });
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook, sessionContext, sessionDialogs, translator);
         Private.handleRunState(notebook, state, true);
         return promise;
     }
     NotebookActions.runAll = runAll;
-    function renderAllMarkdown(notebook, sessionContext) {
+    function renderAllMarkdown(notebook) {
         if (!notebook.model || !notebook.activeCell) {
             return Promise.resolve(false);
         }
@@ -539,7 +543,7 @@ export class NotebookActions {
         if (notebook.activeCell.model.type !== 'markdown') {
             return Promise.resolve(true);
         }
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook);
         notebook.activeCellIndex = previousIndex;
         Private.handleRunState(notebook, state, true);
         return promise;
@@ -549,8 +553,9 @@ export class NotebookActions {
      * Run all of the cells before the currently active cell (exclusive).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -558,7 +563,7 @@ export class NotebookActions {
      * All markdown cells will be rendered.
      * The currently active cell will remain selected.
      */
-    function runAllAbove(notebook, sessionContext) {
+    function runAllAbove(notebook, sessionContext, sessionDialogs, translator) {
         const { activeCell, activeCellIndex, model } = notebook;
         if (!model || !activeCell || activeCellIndex < 1) {
             return Promise.resolve(false);
@@ -569,7 +574,7 @@ export class NotebookActions {
         for (let i = 0; i < notebook.activeCellIndex; ++i) {
             notebook.select(notebook.widgets[i]);
         }
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook, sessionContext, sessionDialogs, translator);
         notebook.activeCellIndex++;
         Private.handleRunState(notebook, state, true);
         return promise;
@@ -579,8 +584,9 @@ export class NotebookActions {
      * Run all of the cells after the currently active cell (inclusive).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -588,7 +594,7 @@ export class NotebookActions {
      * All markdown cells will be rendered.
      * The last cell in the notebook will be activated and scrolled into view.
      */
-    function runAllBelow(notebook, sessionContext) {
+    function runAllBelow(notebook, sessionContext, sessionDialogs, translator) {
         if (!notebook.model || !notebook.activeCell) {
             return Promise.resolve(false);
         }
@@ -597,7 +603,7 @@ export class NotebookActions {
         for (let i = notebook.activeCellIndex; i < notebook.widgets.length; ++i) {
             notebook.select(notebook.widgets[i]);
         }
-        const promise = Private.runSelected(notebook, sessionContext);
+        const promise = Private.runSelected(notebook, sessionContext, sessionDialogs, translator);
         Private.handleRunState(notebook, state, true);
         return promise;
     }
@@ -1742,8 +1748,13 @@ var Private;
     Private.handleRunState = handleRunState;
     /**
      * Run the selected cells.
+     *
+     * @param notebook Notebook
+     * @param sessionContext Notebook session context
+     * @param sessionDialogs Session dialogs
+     * @param translator Application translator
      */
-    function runSelected(notebook, sessionContext) {
+    function runSelected(notebook, sessionContext, sessionDialogs, translator) {
         notebook.mode = 'command';
         let lastIndex = notebook.activeCellIndex;
         const selected = notebook.widgets.filter((child, index) => {
@@ -1755,7 +1766,7 @@ var Private;
         });
         notebook.activeCellIndex = lastIndex;
         notebook.deselectAll();
-        return Promise.all(selected.map(child => runCell(notebook, child, sessionContext)))
+        return Promise.all(selected.map(child => runCell(notebook, child, sessionContext, sessionDialogs, translator)))
             .then(results => {
             if (notebook.isDisposed) {
                 return false;
@@ -1793,7 +1804,7 @@ var Private;
     /**
      * Run a cell.
      */
-    function runCell(notebook, cell, sessionContext, translator) {
+    async function runCell(notebook, cell, sessionContext, sessionDialogs, translator) {
         var _a, _b, _c;
         translator = translator || nullTranslator;
         const trans = translator.load('jupyterlab');
@@ -1806,7 +1817,7 @@ var Private;
             case 'code':
                 if (sessionContext) {
                     if (sessionContext.isTerminating) {
-                        void showDialog({
+                        await showDialog({
                             title: trans.__('Kernel Terminating'),
                             body: trans.__('The kernel for %1 appears to be terminating. You can not run any cell for now.', (_a = sessionContext.session) === null || _a === void 0 ? void 0 : _a.path),
                             buttons: [Dialog.okButton()]
@@ -1814,55 +1825,71 @@ var Private;
                         break;
                     }
                     if (sessionContext.pendingInput) {
-                        void showDialog({
+                        await showDialog({
                             title: trans.__('Cell not executed due to pending input'),
                             body: trans.__('The cell has not been executed to avoid kernel deadlock as there is another pending input! Submit your pending input and try again.'),
                             buttons: [Dialog.okButton()]
                         });
-                        return Promise.resolve(false);
+                        return false;
                     }
                     if (sessionContext.hasNoKernel) {
-                        void sessionContextDialogs.selectKernel(sessionContext);
-                        return Promise.resolve(false);
+                        const shouldSelect = await sessionContext.startKernel();
+                        if (shouldSelect && sessionDialogs) {
+                            await sessionDialogs.selectKernel(sessionContext);
+                        }
+                    }
+                    if (sessionContext.hasNoKernel) {
+                        cell.model.sharedModel.transact(() => {
+                            cell.model.clearExecution();
+                        });
+                        return true;
                     }
                     const deletedCells = (_c = (_b = notebook.model) === null || _b === void 0 ? void 0 : _b.deletedCells) !== null && _c !== void 0 ? _c : [];
                     Private.executionScheduled.emit({ notebook, cell });
-                    return CodeCell.execute(cell, sessionContext, {
-                        deletedCells,
-                        recordTiming: notebook.notebookConfig.recordTiming
-                    })
-                        .then(reply => {
+                    let ran = false;
+                    try {
+                        const reply = await CodeCell.execute(cell, sessionContext, {
+                            deletedCells,
+                            recordTiming: notebook.notebookConfig.recordTiming
+                        });
                         deletedCells.splice(0, deletedCells.length);
-                        if (cell.isDisposed) {
-                            return false;
-                        }
-                        if (!reply) {
-                            return true;
-                        }
-                        if (reply.content.status === 'ok') {
-                            const content = reply.content;
-                            if (content.payload && content.payload.length) {
-                                handlePayload(content, notebook, cell);
+                        ran = (() => {
+                            if (cell.isDisposed) {
+                                return false;
                             }
-                            return true;
-                        }
-                        else {
-                            throw new KernelError(reply.content);
-                        }
-                    })
-                        .catch(reason => {
+                            if (!reply) {
+                                return true;
+                            }
+                            if (reply.content.status === 'ok') {
+                                const content = reply.content;
+                                if (content.payload && content.payload.length) {
+                                    handlePayload(content, notebook, cell);
+                                }
+                                return true;
+                            }
+                            else {
+                                throw new KernelError(reply.content);
+                            }
+                        })();
+                    }
+                    catch (reason) {
                         if (cell.isDisposed || reason.message.startsWith('Canceled')) {
-                            return false;
+                            ran = false;
                         }
-                        Private.executed.emit({ notebook, cell, success: false, error: reason });
-                        throw reason;
-                    })
-                        .then(ran => {
-                        if (ran) {
-                            Private.executed.emit({ notebook, cell, success: true });
+                        else {
+                            Private.executed.emit({
+                                notebook,
+                                cell,
+                                success: false,
+                                error: reason
+                            });
+                            throw reason;
                         }
-                        return ran;
-                    });
+                    }
+                    if (ran) {
+                        Private.executed.emit({ notebook, cell, success: true });
+                    }
+                    return ran;
                 }
                 cell.model.sharedModel.transact(() => {
                     cell.model.clearExecution();