install python modules in Terminal when python.installModulesInTerminal enabled

extensions/positron-python/package.json

@@ -837,6 +837,12 @@
                     "description": "%python.venvPath.description%",
                     "scope": "machine",
                     "type": "string"
+                },
+                "python.installModulesInTerminal": {
+                    "default": false,
+                    "description": "%python.installModulesInTerminal.description%",
+                    "scope": "resource",
+                    "type": "boolean"
                 }
             },
             "title": "Python",

extensions/positron-python/package.nls.json

@@ -104,6 +104,7 @@
     "python.testing.unittestEnabled.description": "Enable testing using unittest.",
     "python.venvFolders.description": "Folders in your home directory to look into for virtual environments (supports pyenv, direnv and virtualenvwrapper by default).",
     "python.venvPath.description": "Path to folder with a list of Virtual Environments (e.g. ~/.pyenv, ~/Envs, ~/.virtualenvs).",
+    "python.installModulesInTerminal.description": "Whether to install Python modules (such as `ipykernel`) in the Terminal, instead of in a background process. Installing modules in the Terminal allows you to see the output of the installation command.",
     "walkthrough.pythonWelcome.title": "Get Started with Python Development",
     "walkthrough.pythonWelcome.description": "Your first steps to set up a Python project with all the powerful tools and features that the Python extension has to offer!",
      "walkthrough.step.python.createPythonFile.title": "Create a Python file",

extensions/positron-python/src/client/common/configSettings.ts

@@ -133,6 +133,8 @@ export class PythonSettings implements IPythonSettings {
     public languageServerLogLevel = 'error';
 
     public quietMode = false;
+
+    public installModulesInTerminal = false;
     // --- End Positron ---
 
     protected readonly changed = new EventEmitter<ConfigurationChangeEvent | undefined>();

extensions/positron-python/src/client/common/installer/moduleInstaller.ts

@@ -1,6 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+// --- Start Positron ---
+/* eslint-disable max-classes-per-file, import/no-duplicates */
+import { CancellationTokenSource } from 'vscode';
+// --- End Positron ---
+
 import { injectable } from 'inversify';
 import * as path from 'path';
 import { CancellationToken, l10n, ProgressLocation, ProgressOptions } from 'vscode';
@@ -22,6 +27,8 @@ import { ProductNames } from './productNames';
 import { IModuleInstaller, InstallOptions, InterpreterUri, ModuleInstallFlags } from './types';
 
 // --- Start Positron ---
+// eslint-disable-next-line import/newline-after-import
+import { IWorkspaceService } from '../application/types';
 class ExternallyManagedEnvironmentError extends Error {}
 // --- End Positron ---
 
@@ -44,7 +51,16 @@ export abstract class ModuleInstaller implements IModuleInstaller {
         flags?: ModuleInstallFlags,
         options?: InstallOptions,
     ): Promise<void> {
-        const shouldExecuteInTerminal = !options?.installAsProcess;
+        // --- Start Positron ---
+        // python.installModulesInTerminal is a setting that allows the user to force modules to be
+        // installed in the Terminal. Usually, such installations occur in the background. However,
+        // for debugging, it can be helpful to see the Terminal output of the installation process.
+        const workspaceService = this.serviceContainer.get<IWorkspaceService>(IWorkspaceService);
+        const installModulesInTerminal = workspaceService
+            .getConfiguration('python')
+            .get<boolean>('installModulesInTerminal');
+        const shouldExecuteInTerminal = installModulesInTerminal || !options?.installAsProcess;
+        // --- End Positron ---
         const name =
             typeof productOrModuleName === 'string'
                 ? productOrModuleName
@@ -248,8 +264,12 @@ export abstract class ModuleInstaller implements IModuleInstaller {
             const terminalService = this.serviceContainer
                 .get<ITerminalServiceFactory>(ITerminalServiceFactory)
                 .getTerminalService(options);
-
-            terminalService.sendCommand(command, args, token);
+            // --- Start Positron ---
+            // Ensure we pass a cancellation token so that we await the full terminal command
+            // execution before returning.
+            const cancelToken = token ?? new CancellationTokenSource().token;
+            await terminalService.sendCommand(command, args, token ?? cancelToken);
+            // --- End Positron ---
         } else {
             const processServiceFactory = this.serviceContainer.get<IProcessServiceFactory>(IProcessServiceFactory);
             const processService = await processServiceFactory.create(options.resource);

extensions/positron-python/src/client/common/types.ts

@@ -190,6 +190,7 @@ export interface IPythonSettings {
     readonly languageServerDebug: boolean;
     readonly languageServerLogLevel: string;
     readonly quietMode: boolean;
+    readonly installModulesInTerminal: boolean;
     // --- End Positron ---
     readonly defaultInterpreterPath: string;
     readonly tensorBoard: ITensorBoardSettings | undefined;