Merge pull request #22 from mwakaba2/notify-only-last-cell

mwakaba2 · web-flow · commit 7452d1450b96 · 2021-07-31T10:46:31.000-06:00
Option to only get notified for the last selected cell execution
diff --git a/README.md b/README.md
@@ -49,25 +49,31 @@ Use the following settings to update cell execution time for a notification and
     // Settings for the Notifications extension
     // ****************************************
 
+    // Cell Number Type
+    // Type of cell number to display when the report_cell_number is true. Select from 'cell_index' or ‘cell_execution_count'.
+    "cell_number_type": "cell_index",
+
     // Enabled Status
     // Enable the extension or not.
     "enabled": true,
 
+    // Trigger only for the last selected notebook cell execution.
+    // Trigger a notification only for the last selected executed notebook cell.
+    // NOTE: Only Available in version >= v0.3.0
+    "last_cell_only": false,
+
     // Minimum Notebook Cell Execution Time
     // The minimum execution time to send out notification for a particular notebook cell (in seconds).
     "minimum_cell_execution_time": 60,
 
     // Report Notebook Cell Execution Time
-    // Display notebook cell execution time in the notification.
+    // Display notebook cell execution time in the notification. 
+    // If last_cell_only is set to true, the total duration of the selected cells will be displayed.
     "report_cell_execution_time": true,
 
     // Report Notebook Cell Number
     // Display notebook cell number in the notification.
-    "report_cell_number": true,
-
-    // Cell Number Type
-    // Type of cell number to display when the report_cell_number is true. Select from 'cell_index' or ‘cell_execution_count'.
-    "cell_number_type": "cell_index"
+    "report_cell_number": true
 }
 ```
 
diff --git a/binder/environment.yml b/binder/environment.yml
@@ -4,4 +4,4 @@ channels:
 dependencies:
 - jupyterlab=3
 - pip:
-  - jupyterlab-notifications==0.2.2
+  - jupyterlab-notifications==0.3.0
diff --git a/schema/plugin.json b/schema/plugin.json
@@ -18,7 +18,7 @@
     "report_cell_execution_time": {
       "type": "boolean",
       "title": "Report Notebook Cell Execution Time",
-      "description": "Display notebook cell execution time in the notification.",
+      "description": "Display notebook cell execution time in the notification. If last_cell_only is set to true, the total duration of the selected cells will be displayed.",
       "default": true
     },
     "report_cell_number": {
@@ -28,11 +28,17 @@
       "default": true
     },
     "cell_number_type": {
-        "type": "string",
-        "title": "Cell Number Type",
-        "description": "Type of cell number to display when the report_cell_number is true. Select from 'cell_index' or ‘cell_execution_count'.",
-        "enum": ["cell_index", "cell_execution_count"],
-        "default": "cell_index"
-      }
+      "type": "string",
+      "title": "Cell Number Type",
+      "description": "Type of cell number to display when the report_cell_number is true. Select from 'cell_index' or ‘cell_execution_count'.",
+      "enum": ["cell_index", "cell_execution_count"],
+      "default": "cell_index"
+    },
+    "last_cell_only": {
+      "type": "boolean",
+      "title": "Trigger only for the last selected notebook cell execution.",
+      "description": "Trigger a notification only for the last selected executed notebook cell.",
+      "default": false
+    }
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -13,8 +13,6 @@ import { checkBrowserNotificationSettings } from './settings';
 interface ICellExecutionMetadata {
   index: number;
   scheduledTime: Date;
-  endTime?: Date;
-  startTime?: Date;
 }
 
 /**
@@ -27,7 +25,8 @@ function displayNotification(
   reportCellNumber: boolean,
   reportCellExecutionTime: boolean,
   failedExecution: boolean,
-  error: KernelError | null
+  error: KernelError | null,
+  lastCellOnly: boolean
 ): void {
   const notificationPayload = {
     icon: '/static/favicon.ico',
@@ -40,6 +39,8 @@ function displayNotification(
 
   if (failedExecution) {
     message = error ? `${error.errorName} ${error.errorValue}` : '';
+  } else if (lastCellOnly) {
+    message = `Total Duration: ${cellDuration}`;
   } else if (reportCellNumber && reportCellExecutionTime) {
     message = `Cell[${cellNumber}] Duration: ${cellDuration}`;
   } else if (reportCellNumber) {
@@ -58,36 +59,58 @@ function displayNotification(
 function triggerNotification(
   cell: Cell,
   notebook: Notebook,
-  executionMetadata: ICellExecutionMetadata,
+  cellExecutionMetadataTable: LRU<string, ICellExecutionMetadata>,
+  recentNotebookExecutionTimes: LRU<string, Date>,
   minimumCellExecutionTime: number,
   reportCellNumber: boolean,
   reportCellExecutionTime: boolean,
   cellNumberType: string,
   failedExecution: boolean,
-  error: KernelError | null
+  error: KernelError | null,
+  lastCellOnly: boolean
 ) {
-  const { startTime, endTime, index: cellIndex } = executionMetadata;
+  const cellEndTime = new Date();
   const codeCellModel = cell.model as ICodeCellModel;
-  const cellDuration = moment
-    .utc(moment(endTime).diff(startTime))
-    .format('HH:mm:ss');
-  const diffSeconds = moment.duration(cellDuration).asSeconds();
-  console.log(cellDuration, diffSeconds);
-  if (diffSeconds >= minimumCellExecutionTime) {
-    const cellNumber =
-      cellNumberType === 'cell_index'
-        ? cellIndex
-        : codeCellModel.executionCount;
-    const notebookName = notebook.title.label.replace(/\.[^/.]+$/, '');
-    displayNotification(
-      cellDuration,
-      cellNumber,
-      notebookName,
-      reportCellNumber,
-      reportCellExecutionTime,
-      failedExecution,
-      error
-    );
+  const codeCell = codeCellModel.type === 'code';
+  const nonEmptyCell = codeCellModel.value.text.length > 0;
+  if (codeCell && nonEmptyCell) {
+    const cellId = codeCellModel.id;
+    const notebookId = notebook.id;
+    const cellExecutionMetadata = cellExecutionMetadataTable.get(cellId);
+    const scheduledTime = cellExecutionMetadata.scheduledTime;
+    // Get the cell's execution scheduled time if the recent notebook execution state doesn't exist.
+    // This happens commonly for first time notebook executions or notebooks that haven't been executed for a while.
+    const recentExecutedCellTime =
+      recentNotebookExecutionTimes.get(notebookId) || scheduledTime;
+
+    // Multiple cells can be scheduled at the same time, and the schedule time doesn't necessarily equate to the actual start time.
+    // If another cell has been executed more recently than the current cell's scheduled time, treat the recent execution as the cell's start time.
+    const cellStartTime =
+      scheduledTime >= recentExecutedCellTime
+        ? scheduledTime
+        : recentExecutedCellTime;
+    recentNotebookExecutionTimes.set(notebookId, cellEndTime);
+    const cellDuration = moment
+      .utc(moment(cellEndTime).diff(cellStartTime))
+      .format('HH:mm:ss');
+    const diffSeconds = moment.duration(cellDuration).asSeconds();
+    if (diffSeconds >= minimumCellExecutionTime) {
+      const cellNumber =
+        cellNumberType === 'cell_index'
+          ? cellExecutionMetadata.index
+          : codeCellModel.executionCount;
+      const notebookName = notebook.title.label.replace(/\.[^/.]+$/, '');
+      displayNotification(
+        cellDuration,
+        cellNumber,
+        notebookName,
+        reportCellNumber,
+        reportCellExecutionTime,
+        failedExecution,
+        error,
+        lastCellOnly
+      );
+    }
   }
 }
 
@@ -102,6 +125,7 @@ const extension: JupyterFrontEndPlugin<void> = {
     let reportCellExecutionTime = true;
     let reportCellNumber = true;
     let cellNumberType = 'cell_index';
+    let lastCellOnly = false;
     const cellExecutionMetadataTable: LRU<
       string,
       ICellExecutionMetadata
@@ -123,6 +147,7 @@ const extension: JupyterFrontEndPlugin<void> = {
         reportCellNumber = setting.get('report_cell_number')
           .composite as boolean;
         cellNumberType = setting.get('cell_number_type').composite as string;
+        lastCellOnly = setting.get('last_cell_only').composite as boolean;
       };
       updateSettings();
       setting.changed.connect(updateSettings);
@@ -139,42 +164,41 @@ const extension: JupyterFrontEndPlugin<void> = {
     });
 
     NotebookActions.executed.connect((_, args) => {
-      if (enabled) {
-        const cellEndTime = new Date();
+      if (enabled && !lastCellOnly) {
         const { cell, notebook, success, error } = args;
-        const codeCell = cell.model.type === 'code';
-        const nonEmptyCell = cell.model.value.text.length > 0;
-        if (codeCell && nonEmptyCell) {
-          const cellId = cell.model.id;
-          const notebookId = notebook.id;
-          const cellExecutionMetadata = cellExecutionMetadataTable.get(cellId);
-          const scheduledTime = cellExecutionMetadata.scheduledTime;
-          // Get the cell's execution scheduled time if the recent notebook execution state doesn't exist.
-          // This happens commonly for first time notebook executions or notebooks that haven't been executed for a while.
-          const recentExecutedCellTime =
-            recentNotebookExecutionTimes.get(notebookId) || scheduledTime;
-
-          // Multiple cells can be scheduled at the same time, and the schedule time doesn't necessarily equate to the actual start time.
-          // If another cell has been executed more recently than the current cell's scheduled time, treat the recent execution as the cell's start time.
-          cellExecutionMetadata.startTime =
-            scheduledTime >= recentExecutedCellTime
-              ? scheduledTime
-              : recentExecutedCellTime;
-          cellExecutionMetadata.endTime = cellEndTime;
-          recentNotebookExecutionTimes.set(notebookId, cellEndTime);
+        triggerNotification(
+          cell,
+          notebook,
+          cellExecutionMetadataTable,
+          recentNotebookExecutionTimes,
+          minimumCellExecutionTime,
+          reportCellNumber,
+          reportCellExecutionTime,
+          cellNumberType,
+          !success,
+          error,
+          lastCellOnly
+        );
+      }
+    });
 
-          triggerNotification(
-            cell,
-            notebook,
-            cellExecutionMetadata,
-            minimumCellExecutionTime,
-            reportCellNumber,
-            reportCellExecutionTime,
-            cellNumberType,
-            !success,
-            error
-          );
-        }
+    NotebookActions.selectionExecuted.connect((_, args) => {
+      if (enabled && lastCellOnly) {
+        const { lastCell, notebook } = args;
+        const failedExecution = false;
+        triggerNotification(
+          lastCell,
+          notebook,
+          cellExecutionMetadataTable,
+          recentNotebookExecutionTimes,
+          minimumCellExecutionTime,
+          reportCellNumber,
+          reportCellExecutionTime,
+          cellNumberType,
+          failedExecution,
+          null,
+          lastCellOnly
+        );
       }
     });
   }
diff --git a/tutorial/py3_demo.ipynb b/tutorial/py3_demo.ipynb
@@ -52,20 +52,74 @@
     }
    ],
    "source": [
-    "!sleep 66\n",
+    "!sleep 1\n",
     "print(\"hello world!\")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 99,
+   "execution_count": 62,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2021-07-25T19:55:35.654800Z",
-     "iopub.status.busy": "2021-07-25T19:55:35.654567Z",
-     "iopub.status.idle": "2021-07-25T19:55:38.881008Z",
-     "shell.execute_reply": "2021-07-25T19:55:38.879628Z",
-     "shell.execute_reply.started": "2021-07-25T19:55:35.654769Z"
+     "iopub.execute_input": "2021-07-18T19:49:34.088207Z",
+     "iopub.status.busy": "2021-07-18T19:49:34.087802Z",
+     "iopub.status.idle": "2021-07-18T19:49:36.219369Z",
+     "shell.execute_reply": "2021-07-18T19:49:36.218766Z",
+     "shell.execute_reply.started": "2021-07-18T19:49:34.088134Z"
+    },
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "hello world again!\n"
+     ]
+    }
+   ],
+   "source": [
+    "!sleep 2\n",
+    "print(\"hello world again!\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 63,
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2021-07-18T19:49:36.221581Z",
+     "iopub.status.busy": "2021-07-18T19:49:36.221322Z",
+     "iopub.status.idle": "2021-07-18T19:49:41.353081Z",
+     "shell.execute_reply": "2021-07-18T19:49:41.352358Z",
+     "shell.execute_reply.started": "2021-07-18T19:49:36.221557Z"
+    },
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "bye world!\n"
+     ]
+    }
+   ],
+   "source": [
+    "!sleep 5\n",
+    "print(\"bye world!\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 40,
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2021-07-18T19:41:58.007998Z",
+     "iopub.status.busy": "2021-07-18T19:41:58.007728Z",
+     "iopub.status.idle": "2021-07-18T19:42:01.145486Z",
+     "shell.execute_reply": "2021-07-18T19:42:01.144436Z",
+     "shell.execute_reply.started": "2021-07-18T19:41:58.007971Z"
     },
     "tags": []
    },
@@ -77,7 +131,7 @@
      "traceback": [
       "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
       "\u001b[0;31mException\u001b[0m                                 Traceback (most recent call last)",
-      "\u001b[0;32m<ipython-input-99-d820d165a50b>\u001b[0m in \u001b[0;36m<module>\u001b[0;34m\u001b[0m\n\u001b[1;32m      1\u001b[0m \u001b[0mget_ipython\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0msystem\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m'sleep 3'\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0;32m----> 2\u001b[0;31m \u001b[0;32mraise\u001b[0m \u001b[0mException\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m'hello world!'\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m",
+      "\u001b[0;32m<ipython-input-40-d820d165a50b>\u001b[0m in \u001b[0;36m<module>\u001b[0;34m\u001b[0m\n\u001b[1;32m      1\u001b[0m \u001b[0mget_ipython\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m.\u001b[0m\u001b[0msystem\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m'sleep 3'\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0;32m----> 2\u001b[0;31m \u001b[0;32mraise\u001b[0m \u001b[0mException\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0;34m'hello world!'\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n\u001b[0m",
       "\u001b[0;31mException\u001b[0m: hello world!"
      ]
     }
