Save python version info in metadata when running cells (#8225)

* Store python version

* News

* Remove blank lines

Author: DonJayamanne

news/2 Fixes/8064.md

@@ -0,0 +1 @@
+Store version of the `Python` interpreter (kernel) in the notebook metadata when running cells.

src/client/datascience/interactive-ipynb/nativeEditor.ts

@@ -8,7 +8,7 @@ import * as detectIndent from 'detect-indent';
 import { inject, injectable, multiInject, named } from 'inversify';
 import * as path from 'path';
 import * as uuid from 'uuid/v4';
-import { Event, EventEmitter, Memento, Uri, ViewColumn } from 'vscode';
+import { Event, EventEmitter, Memento, TextEditor, Uri, ViewColumn } from 'vscode';
 
 import {
     IApplicationShell,
@@ -310,6 +310,12 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
         }
     }
 
+    protected submitCode(code: string, file: string, line: number, id?: string, editor?: TextEditor, debug?: boolean): Promise<boolean> {
+        // When code is executed, update the version number in the metadata.
+        this.updateVersionInfoInNotebook().ignoreErrors();
+        return super.submitCode(code, file, line, id, editor, debug);
+    }
+
     @captureTelemetry(Telemetry.SubmitCellThroughInput, undefined, false)
     // tslint:disable-next-line:no-any
     protected submitNewCell(info: ISubmitNewCell) {
@@ -455,6 +461,20 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
         // Actually don't close, just let the error bubble out
     }
 
+    /**
+     * Update the Python Version number in the notebook data.
+     *
+     * @private
+     * @memberof NativeEditor
+     */
+    private async updateVersionInfoInNotebook(): Promise<void>{
+        // Use the active interpreter
+        const usableInterpreter = await this.jupyterExecution.getUsableJupyterPython();
+        if (usableInterpreter && usableInterpreter.version && this.notebookJson.metadata && this.notebookJson.metadata.language_info){
+            this.notebookJson.metadata.language_info.version = `${usableInterpreter.version.major}.${usableInterpreter.version.minor}.${usableInterpreter.version.patch}`;
+        }
+    }
+
     private async loadContents(contents: string | undefined, forceDirty: boolean): Promise<void> {
         // tslint:disable-next-line: no-any
         const json = contents ? JSON.parse(contents) as any : undefined;

src/test/datascience/interactive-ipynb/nativeEditor.unit.test.ts

@@ -2,9 +2,10 @@
 // Licensed under the MIT License.
 'use strict';
 import { expect } from 'chai';
-import { anything, instance, mock, when } from 'ts-mockito';
+import { anything, instance, mock, verify, when } from 'ts-mockito';
 import { ConfigurationChangeEvent, Disposable, EventEmitter, TextEditor, Uri } from 'vscode';
 
+import { nbformat } from '@jupyterlab/coreutils';
 import * as sinon from 'sinon';
 import { ApplicationShell } from '../../../client/common/application/applicationShell';
 import { CommandManager } from '../../../client/common/application/commandManager';
@@ -24,7 +25,7 @@ import { ConfigurationService } from '../../../client/common/configuration/servi
 import { LiveShareApi } from '../../../client/common/liveshare/liveshare';
 import { FileSystem } from '../../../client/common/platform/fileSystem';
 import { IFileSystem } from '../../../client/common/platform/types';
-import { IConfigurationService } from '../../../client/common/types';
+import { IConfigurationService, Version } from '../../../client/common/types';
 import { CodeCssGenerator } from '../../../client/datascience/codeCssGenerator';
 import { DataViewerProvider } from '../../../client/datascience/data-viewing/dataViewerProvider';
 import { DataScienceErrorHandler } from '../../../client/datascience/errorHandler/errorHandler';
@@ -55,6 +56,7 @@ import { IInterpreterService } from '../../../client/interpreter/contracts';
 import { InterpreterService } from '../../../client/interpreter/interpreterService';
 import { createEmptyCell } from '../../../datascience-ui/interactive-common/mainState';
 import { waitForCondition } from '../../common';
+import { noop } from '../../core';
 import { MockMemento } from '../../mocks/mementos';
 
 // tslint:disable: no-any chai-vague-errors no-unused-expression
@@ -324,7 +326,6 @@ suite('Data Science - Native Editor', () => {
 
         return editor;
     }
-
     test('Editing a notebook will save uncommitted changes into memento', async () => {
         const file = Uri.parse('file://foo.ipynb');
 
@@ -416,4 +417,40 @@ suite('Data Science - Native Editor', () => {
         expect(newEditor.contents).to.be.equal(baseFile);
         expect(newEditor.cells).to.be.lengthOf(3);
     });
+
+    test('Pyton version info will be updated in notebook when a cell has been executed', async () => {
+        const file = Uri.parse('file://foo.ipynb');
+
+        const editor = createEditor();
+        await editor.load(baseFile, file);
+        expect(editor.contents).to.be.equal(baseFile);
+        // At the begining version info is NOT in the file (at least not the same as what we are using to run cells).
+        let contents = JSON.parse(editor.contents) as nbformat.INotebookContent;
+        expect(contents.metadata!.language_info!.version).to.not.equal('10.11.12');
+
+        // When a cell is executed, then ensure we store the python version info in the notebook data.
+        const version: Version = {build: [], major: 10, minor: 11, patch: 12, prerelease: [], raw: '10.11.12'};
+        when(executionProvider.getUsableJupyterPython()).thenResolve(({version} as any));
+
+        try {
+            editor.onMessage(InteractiveWindowMessages.SubmitNewCell, {code: 'hello', id: '1'});
+        } catch {
+            // Ignore errors related to running cells, assume that works.
+            noop();
+        }
+
+        // Wait for the version info to be retrieved (done in the background).
+        await waitForCondition(async () => {
+            try {
+                verify(executionProvider.getUsableJupyterPython()).atLeast(1);
+                return true;
+            } catch {
+                return false;
+            }
+        }, 5_000, 'Timeout');
+
+        // Verify the version info is in the notbook.
+        contents = JSON.parse(editor.contents) as nbformat.INotebookContent;
+        expect(contents.metadata!.language_info!.version).to.equal('10.11.12');
+    });
 });