[ExecuteTime] optionally clear timing data on clearing cell outputs

Author: jcb91

src/jupyter_contrib_nbextensions/nbextensions/execute_time/ExecuteTime.js

@@ -33,6 +33,7 @@ define([
 
     // defaults, overridden by server's config
     var options = {
+        clear_timings_on_clear_output: false,
         clear_timings_on_kernel_restart: false,
         default_kernel_to_utc: true,
         display_absolute_format: 'HH:mm:ss YYYY-MM-DD',
@@ -80,6 +81,16 @@ define([
         };
     }
 
+    function patch_CodeCell_clear_output () {
+        console.log(log_prefix, 'Patching CodeCell.prototype.clear_output to clear timings also.');
+        var orig_clear_output = CodeCell.prototype.clear_output;
+        CodeCell.prototype.clear_output = function () {
+            var ret = orig_clear_output.apply(this, arguments);
+            clear_timing_data([this]);
+            return ret;
+        };
+    }
+
     function toggle_timing_display (cells, vis) {
         for (var i = 0; i < cells.length; i++) {
             var cell = cells[i];
@@ -315,6 +326,9 @@ define([
             }
 
             // setup optional clear-data calls
+            if (options.clear_timings_on_clear_output) {
+                patch_CodeCell_clear_output();
+            }
             if (options.clear_timings_on_kernel_restart) {
                 console.log(log_prefix, 'Binding kernel_restarting.Kernel event to clear timings.');
                 events.on('kernel_restarting.Kernel', clear_timing_data_all);

src/jupyter_contrib_nbextensions/nbextensions/execute_time/ExecuteTime.yaml

@@ -7,6 +7,13 @@ Main: ExecuteTime.js
 Compatibility: 4.x, 5.x
 Parameters:
 
+- name: ExecuteTime.clear_timings_on_clear_output
+  description: |
+    When cells' outputs are cleared, also clear their timing data, e.g. when
+    using the "Kernel > Restart & Clear Output" menu item
+  input_type: checkbox
+  default: false
+
 - name: ExecuteTime.clear_timings_on_kernel_restart
   description: |
     Clear all cells' execution timing data on any kernel restart event

src/jupyter_contrib_nbextensions/nbextensions/execute_time/readme.md

@@ -60,6 +60,10 @@ ConfigManager().update('notebook', {'ExecuteTime': {
 
 The available options are:
 
+* `ExecuteTime.clear_timings_on_clear_output`: When cells' outputs are cleared,
+  also clear their timing data, e.g. when using the
+  `Kernel > Restart & Clear Output` menu item
+
 * `ExecuteTime.clear_timings_on_kernel_restart`: Clear all cells' execution
   timing data on any kernel restart event