Enhancements to running code in a terminal (#1432)

Fixes #1207
Fixes #1316
Fixes #1349
Fixes #259

Author: DonJayamanne

news/1 Enhancements/1207.md

@@ -0,0 +1 @@
+Remove empty spaces from the selected text of the active editor when executing in a terminal.

news/1 Enhancements/1316.md

@@ -0,0 +1 @@
+Save the python file before running it in the terminal using the command/menu `Run Python File in Terminal`.

news/1 Enhancements/1349.md

@@ -0,0 +1 @@
+Add `Ctrl+Enter` keyboard shortcut for `Run Selection/Line in Python Terminal`.

news/2 Fixes/259.md

@@ -0,0 +1 @@
+Add blank lines to seprate blocks of indented code (function defs, classes, and the like) to ensure the code can be run within a Python interactive prompt.

package.json

@@ -94,6 +94,12 @@
                 "path": "./snippets/python.json"
             }
         ],
+        "keybindings":[
+            {
+                "command": "python.execSelectionInTerminal",
+                "key": "ctrl+enter"
+            }
+        ],
         "commands": [
             {
                 "command": "python.sortImports",

src/client/common/configSettings.ts

@@ -37,7 +37,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
     public formatting?: IFormattingSettings;
     public autoComplete?: IAutoCompleteSettings;
     public unitTest?: IUnitTestSettings;
-    public terminal?: ITerminalSettings;
+    public terminal!: ITerminalSettings;
     public sortImports?: ISortImportSettings;
     public workspaceSymbols?: IWorkspaceSymbolSettings;
     public disableInstallationChecks = false;

src/client/common/types.ts

@@ -106,7 +106,7 @@ export interface IPythonSettings {
     readonly formatting?: IFormattingSettings;
     readonly unitTest?: IUnitTestSettings;
     readonly autoComplete?: IAutoCompleteSettings;
-    readonly terminal?: ITerminalSettings;
+    readonly terminal: ITerminalSettings;
     readonly sortImports?: ISortImportSettings;
     readonly workspaceSymbols?: IWorkspaceSymbolSettings;
     readonly envFile: string;

src/client/terminals/codeExecution/codeExecutionManager.ts

@@ -35,6 +35,7 @@ export class CodeExecutionManager implements ICodeExecutionManager {
         if (!fileToExecute) {
             return;
         }
+        await codeExecutionHelper.saveFileIfDirty(fileToExecute);
         const executionService = this.serviceContainer.get<ICodeExecutionService>(ICodeExecutionService, 'standard');
         await executionService.executeFile(fileToExecute);
     }
@@ -59,11 +60,11 @@ export class CodeExecutionManager implements ICodeExecutionManager {
         }
         const codeExecutionHelper = this.serviceContainer.get<ICodeExecutionHelper>(ICodeExecutionHelper);
         const codeToExecute = await codeExecutionHelper.getSelectedTextToExecute(activeEditor!);
-        const normalizedCode = codeExecutionHelper.normalizeLines(codeToExecute!);
+        const normalizedCode = await codeExecutionHelper.normalizeLines(codeToExecute!);
         if (!normalizedCode || normalizedCode.trim().length === 0) {
             return;
         }
 
-        await executionService.execute(codeToExecute!, activeEditor!.document.uri);
+        await executionService.execute(normalizedCode, activeEditor!.document.uri);
     }
 }

src/client/terminals/codeExecution/djangoShellCodeExecution.ts

@@ -32,7 +32,7 @@ export class DjangoShellCodeExecutionProvider extends TerminalCodeExecutionProvi
     public getReplCommandArgs(resource?: Uri): { command: string; args: string[] } {
         const pythonSettings = this.configurationService.getSettings(resource);
         const command = this.platformService.isWindows ? pythonSettings.pythonPath.replace(/\\/g, '/') : pythonSettings.pythonPath;
-        const args = pythonSettings.terminal!.launchArgs.slice();
+        const args = pythonSettings.terminal.launchArgs.slice();
 
         const workspaceUri = resource ? this.workspace.getWorkspaceFolder(resource) : undefined;
         const defaultWorkspace = Array.isArray(this.workspace.workspaceFolders) && this.workspace.workspaceFolders.length > 0 ? this.workspace.workspaceFolders[0].uri.fsPath : '';

src/client/terminals/codeExecution/helper.ts

@@ -2,23 +2,34 @@
 // Licensed under the MIT License.
 
 import { inject, injectable } from 'inversify';
-import { EOL } from 'os';
 import { Range, TextEditor, Uri } from 'vscode';
 import { IApplicationShell, IDocumentManager } from '../../common/application/types';
 import { PythonLanguage } from '../../common/constants';
 import '../../common/extensions';
+import { IServiceContainer } from '../../ioc/types';
 import { ICodeExecutionHelper } from '../types';
 
 @injectable()
 export class CodeExecutionHelper implements ICodeExecutionHelper {
-    constructor( @inject(IDocumentManager) private documentManager: IDocumentManager,
-        @inject(IApplicationShell) private applicationShell: IApplicationShell) {
-
+    private readonly documentManager: IDocumentManager;
+    private readonly applicationShell: IApplicationShell;
+    constructor(@inject(IServiceContainer) serviceContainer: IServiceContainer) {
+        this.documentManager = serviceContainer.get<IDocumentManager>(IDocumentManager);
+        this.applicationShell = serviceContainer.get<IApplicationShell>(IApplicationShell);
     }
-    public normalizeLines(code: string): string {
-        const codeLines = code.splitLines({ trim: false, removeEmptyEntries: false });
-        const codeLinesWithoutEmptyLines = codeLines.filter(line => line.trim().length > 0);
-        return codeLinesWithoutEmptyLines.join(EOL);
+    public async normalizeLines(code: string, resource?: Uri): Promise<string> {
+        try {
+            if (code.trim().length === 0) {
+                return '';
+            }
+            const regex = /(\n)([ \t]*\r?\n)([ \t]+\S+)/gm;
+            return code.replace(regex, (_, a, b, c) => {
+                return `${a}${c}`;
+            });
+        } catch (ex) {
+            console.error(ex, 'Python: Failed to normalize code for execution in terminal');
+            return code;
+        }
     }
 
     public async getFileToExecute(): Promise<Uri | undefined> {
@@ -35,6 +46,9 @@ export class CodeExecutionHelper implements ICodeExecutionHelper {
             this.applicationShell.showErrorMessage('The active file is not a Python source file');
             return;
         }
+        if (activeEditor.document.isDirty) {
+            await activeEditor.document.save();
+        }
         return activeEditor.document.uri;
     }
 
@@ -53,4 +67,10 @@ export class CodeExecutionHelper implements ICodeExecutionHelper {
         }
         return code;
     }
+    public async saveFileIfDirty(file: Uri): Promise<void> {
+        const docs = this.documentManager.textDocuments.filter(d => d.uri.path === file.path);
+        if (docs.length === 1 && docs[0].isDirty) {
+            await docs[0].save();
+        }
+    }
 }