Support local Python application development

.vscode-test.js

@@ -62,6 +62,11 @@ const extensions = [
 		workspaceFolder: path.join(os.tmpdir(), `positron-connections-${Math.floor(Math.random() * 100000)}`),
 		mocha: { timeout: 60_000 }
 	},
+	{
+		label: 'positron-run-app',
+		workspaceFolder: 'extensions/positron-run-app/test-workspace',
+		mocha: { timeout: 60_000 }
+	},
 	// --- End Positron ---
 	{
 		label: 'microsoft-authentication',

build/gulpfile.extensions.js

@@ -38,6 +38,7 @@ const compilations = [
 	'extensions/positron-notebooks/tsconfig.json',
 	'extensions/positron-r/tsconfig.json',
 	'extensions/positron-rstudio-keymap/tsconfig.json',
+	'extensions/positron-run-app/tsconfig.json',
 	'extensions/positron-python/tsconfig.json',
 	'extensions/positron-proxy/tsconfig.json',
 	'extensions/positron-viewer/tsconfig.json',

build/npm/dirs.js

@@ -20,6 +20,7 @@ const dirs = [
 	'extensions/positron-notebooks',
 	'extensions/positron-r',
 	'extensions/positron-rstudio-keymap',
+	'extensions/positron-run-app',
 	'extensions/positron-python',
 	'extensions/positron-proxy',
 	'extensions/positron-viewer',

extensions/positron-python/package.json

@@ -305,42 +305,35 @@
                 "command": "python.execDashInTerminal",
                 "icon": "$(play)",
                 "title": "%python.command.python.execDashInTerminal.title%",
-                "enablement": "pythonAppFramework == dash && config.python.enableWebAppSupport"
+                "enablement": "pythonAppFramework == dash"
             },
             {
                 "category": "Python",
                 "command": "python.execFastAPIInTerminal",
                 "icon": "$(play)",
                 "title": "%python.command.python.execFastAPIInTerminal.title%",
-                "enablement": "pythonAppFramework == fastapi && config.python.enableWebAppSupport"
+                "enablement": "pythonAppFramework == fastapi"
             },
             {
                 "category": "Python",
                 "command": "python.execFlaskInTerminal",
                 "icon": "$(play)",
                 "title": "%python.command.python.execFlaskInTerminal.title%",
-                "enablement": "pythonAppFramework == flask && config.python.enableWebAppSupport"
+                "enablement": "pythonAppFramework == flask"
             },
             {
                 "category": "Python",
                 "command": "python.execGradioInTerminal",
                 "icon": "$(play)",
                 "title": "%python.command.python.execGradioInTerminal.title%",
-                "enablement": "pythonAppFramework == gradio && config.python.enableWebAppSupport"
-            },
-            {
-                "category": "Python",
-                "command": "python.execShinyInTerminal",
-                "icon": "$(play)",
-                "title": "%python.command.python.execShinyInTerminal.title%",
-                "enablement": "pythonAppFramework == shiny && config.python.enableWebAppSupport"
+                "enablement": "pythonAppFramework == gradio"
             },
             {
                 "category": "Python",
                 "command": "python.execStreamlitInTerminal",
                 "icon": "$(play)",
                 "title": "%python.command.python.execStreamlitInTerminal.title%",
-                "enablement": "pythonAppFramework == streamlit && config.python.enableWebAppSupport"
+                "enablement": "pythonAppFramework == streamlit"
             },
             {
                 "category": "Python",
@@ -482,12 +475,6 @@
                     "scope": "application",
                     "type": "boolean"
                 },
-                "python.enableWebAppSupport": {
-                    "defaut": false,
-                    "description": "%python.enableWebAppSupport.description%",
-                    "scope": "application",
-                    "type": "boolean"
-                },
                 "python.envFile": {
                     "default": "${workspaceFolder}/.env",
                     "description": "%python.envFile.description%",
@@ -1224,7 +1211,7 @@
                 "command": "python.execInConsole",
                 "key": "ctrl+shift+enter",
                 "mac": "cmd+shift+enter",
-                "when": "editorTextFocus && editorLangId == python && !findInputFocussed && !replaceInputFocussed && !jupyter.ownsSelection && !notebookEditorFocused"
+                "when": "editorTextFocus && editorLangId == python && !findInputFocussed && !replaceInputFocussed && !jupyter.ownsSelection && !notebookEditorFocused && !pythonAppFramework"
             },
             {
                 "command": "python.execSelectionInConsole",
@@ -1364,7 +1351,7 @@
                     "category": "Python",
                     "command": "python.execInConsole",
                     "title": "%python.command.python.execInConsole.title%",
-                    "when": "!virtualWorkspace && shellExecutionSupported && editorLangId == python"
+                    "when": "!virtualWorkspace && shellExecutionSupported && editorLangId == python && !pythonAppFramework"
                 },
                 {
                     "category": "Python",
@@ -1490,7 +1477,32 @@
                 {
                     "command": "python.execInConsole",
                     "group": "Python",
-                    "when": "resourceLangId == python && !virtualWorkspace && shellExecutionSupported"
+                    "when": "resourceLangId == python && !virtualWorkspace && shellExecutionSupported && !pythonAppFramework"
+                },
+                {
+                    "command": "python.execDashInTerminal",
+                    "group": "Python",
+                    "when": "pythonAppFramework == dash"
+                },
+                {
+                    "command": "python.execGradioInTerminal",
+                    "group": "Python",
+                    "when": "pythonAppFramework == gradio"
+                },
+                {
+                    "command": "python.execFastAPIInTerminal",
+                    "group": "Python",
+                    "when": "pythonAppFramework == fastapi"
+                },
+                {
+                    "command": "python.execFlaskInTerminal",
+                    "group": "Python",
+                    "when": "pythonAppFramework == flask"
+                },
+                {
+                    "command": "python.execStreamlitInTerminal",
+                    "group": "Python",
+                    "when": "pythonAppFramework == streamlit"
                 },
                 {
                     "command": "python.execInTerminal",
@@ -1525,43 +1537,37 @@
                     "command": "python.execInConsole",
                     "group": "navigation@0",
                     "title": "%python.command.python.execInConsole.title%",
-                    "when": "resourceLangId == python && !isInDiffEditor && !virtualWorkspace && shellExecutionSupported"
+                    "when": "resourceLangId == python && !isInDiffEditor && !virtualWorkspace && shellExecutionSupported && !pythonAppFramework"
                 },
                 {
                     "command": "python.execDashInTerminal",
-                    "group": "navigation@1",
+                    "group": "navigation@0",
                     "title": "%python.command.python.execDashInTerminal.title%",
-                    "when": "pythonAppFramework == dash && config.python.enableWebAppSupport"
+                    "when": "pythonAppFramework == dash"
                 },
                 {
                     "command": "python.execGradioInTerminal",
-                    "group": "navigation@1",
+                    "group": "navigation@0",
                     "title": "%python.command.python.execGradioInTerminal.title%",
-                    "when": "pythonAppFramework == gradio && config.python.enableWebAppSupport"
+                    "when": "pythonAppFramework == gradio"
                 },
                 {
                     "command": "python.execFastAPIInTerminal",
-                    "group": "navigation@1",
+                    "group": "navigation@0",
                     "title": "%python.command.python.execFastAPIInTerminal.title%",
-                    "when": "pythonAppFramework == fastapi && config.python.enableWebAppSupport"
+                    "when": "pythonAppFramework == fastapi"
                 },
                 {
                     "command": "python.execFlaskInTerminal",
-                    "group": "navigation@1",
+                    "group": "navigation@0",
                     "title": "%python.command.python.execFlaskInTerminal.title%",
-                    "when": "pythonAppFramework == flask && config.python.enableWebAppSupport"
-                },
-                {
-                    "command": "python.execShinyInTerminal",
-                    "group": "navigation@1",
-                    "title": "%python.command.python.execShinyInTerminal.title%",
-                    "when": "pythonAppFramework == shiny && config.python.enableWebAppSupport"
+                    "when": "pythonAppFramework == flask"
                 },
                 {
                     "command": "python.execStreamlitInTerminal",
-                    "group": "navigation@1",
+                    "group": "navigation@0",
                     "title": "%python.command.python.execStreamlitInTerminal.title%",
-                    "when": "pythonAppFramework == streamlit && config.python.enableWebAppSupport"
+                    "when": "pythonAppFramework == streamlit"
                 },
                 {
                     "command": "python.execInTerminal-icon",

extensions/positron-python/package.nls.json

@@ -7,10 +7,9 @@
     "python.command.python.createTerminal.title": "Create Terminal",
     "python.command.python.execInTerminal.title": "Run Python File in Terminal",
     "python.command.python.execDashInTerminal.title": "Run Dash App in Terminal",
-    "python.command.python.execFastAPIInTerminal.title": "Run FastAPI in Terminal",
+    "python.command.python.execFastAPIInTerminal.title": "Run FastAPI App in Terminal",
     "python.command.python.execFlaskInTerminal.title": "Run Flask App in Terminal",
     "python.command.python.execGradioInTerminal.title": "Run Gradio App in Terminal",
-    "python.command.python.execShinyInTerminal.title": "Run Shiny App in Terminal",
     "python.command.python.execStreamlitInTerminal.title": "Run Streamlit App in Terminal",
     "python.command.python.execInConsole.title": "Run Python File in Console",
     "python.command.python.debugInTerminal.title": "Debug Python File in Terminal",
@@ -44,7 +43,6 @@
     "python.debugger.deprecatedMessage": "This configuration will be deprecated soon. Please replace `python` with `debugpy` to use the new Python Debugger extension.",
     "python.defaultInterpreterPath.description": "Path to default Python to use when extension loads up for the first time, no longer used once an interpreter is selected for the workspace. See [here](https://aka.ms/AAfekmf) to understand when this is used",
     "python.diagnostics.sourceMapsEnabled.description": "Enable source map support for meaningful stack traces in error logs.",
-    "python.enableWebAppSupport.description": "Enable experimental support for Python applications",
     "python.envFile.description": "Absolute path to a file containing environment variable definitions.",
     "python.experiments.enabled.description": "Enables A/B tests experiments in the Python extension. If enabled, you may get included in proposed enhancements and/or features.",
     "python.experiments.optInto.description": "List of experiment to opt into. If empty, user is assigned the default experiment groups. See [here](https://github.com/microsoft/vscode-python/wiki/AB-Experiments) for more details.",

extensions/positron-python/src/client/common/application/commands.ts

@@ -102,12 +102,11 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
     [Commands.Exec_In_Terminal_Icon]: [undefined, Uri];
     [Commands.Debug_In_Terminal]: [Uri];
     // --- Start Positron ---
-    [Commands.Exec_Dash_In_Terminal]: [undefined, Uri];
-    [Commands.Exec_FastAPI_In_Terminal]: [undefined, Uri];
-    [Commands.Exec_Flask_In_Terminal]: [undefined, Uri];
-    [Commands.Exec_Gradio_In_Terminal]: [undefined, Uri];
-    [Commands.Exec_Shiny_In_Terminal]: [undefined, Uri];
-    [Commands.Exec_Streamlit_In_Terminal]: [undefined, Uri];
+    [Commands.Exec_Dash_In_Terminal]: [];
+    [Commands.Exec_FastAPI_In_Terminal]: [];
+    [Commands.Exec_Flask_In_Terminal]: [];
+    [Commands.Exec_Gradio_In_Terminal]: [];
+    [Commands.Exec_Streamlit_In_Terminal]: [];
     [Commands.Exec_In_Console]: [];
     [Commands.Focus_Positron_Console]: [];
     // --- End Positron ---

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

@@ -56,7 +56,6 @@ export namespace Commands {
     export const Exec_FastAPI_In_Terminal = 'python.execFastAPIInTerminal';
     export const Exec_Flask_In_Terminal = 'python.execFlaskInTerminal';
     export const Exec_Gradio_In_Terminal = 'python.execGradioInTerminal';
-    export const Exec_Shiny_In_Terminal = 'python.execShinyInTerminal';
     export const Exec_Streamlit_In_Terminal = 'python.execStreamlitInTerminal';
     export const Exec_In_Console = 'python.execInConsole';
     export const Exec_Selection_In_Console = 'python.execSelectionInConsole';

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

@@ -300,6 +300,10 @@ export function translateProductToModule(product: Product): string {
             return 'ensurepip';
         case Product.python:
             return 'python';
+        // --- Start Positron ---
+        case Product.fastapiCli:
+            return 'fastapi_cli';
+        // --- End Positron ---
         default: {
             throw new Error(`Product ${product} cannot be installed as a Python Module.`);
         }

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

@@ -21,6 +21,9 @@ export class ProductService implements IProductService {
         this.ProductTypes.set(Product.pip, ProductType.DataScience);
         this.ProductTypes.set(Product.ensurepip, ProductType.DataScience);
         this.ProductTypes.set(Product.python, ProductType.Python);
+        // --- Start Positron ---
+        this.ProductTypes.set(Product.fastapiCli, ProductType.DataScience);
+        // --- End Positron ---
     }
     public getProductType(product: Product): ProductType {
         return this.ProductTypes.get(product)!;

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

@@ -99,6 +99,9 @@ export enum Product {
     pip = 27,
     ensurepip = 28,
     python = 29,
+    // --- Start Positron ---
+    fastapiCli = 101,
+    // --- End Positron ---
 }
 
 export const IInstaller = Symbol('IInstaller');

extensions/positron-python/src/client/extension.ts

@@ -91,7 +91,7 @@ export async function activate(context: IExtensionContext): Promise<PythonExtens
 
     // --- Start Positron ---
 
-    activatePositron(serviceContainer, context)
+    activatePositron(serviceContainer)
         // Run in the background.
         .ignoreErrors();
 

extensions/positron-python/src/client/positron-run-app.d.ts

@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (C) 2024 Posit Software, PBC. All rights reserved.
+ *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// eslint-disable-next-line import/no-unresolved
+import * as positron from 'positron';
+import * as vscode from 'vscode';
+
+/**
+ * Represents options returned from ${@link RunAppOptions.getTerminalOptions}.
+ */
+export interface RunAppTerminalOptions {
+    /**
+     * The command line to run in the terminal.
+     */
+    commandLine: string;
+
+    /**
+     * The optional environment variables to create the terminal with.
+     */
+    env?: { [key: string]: string | null | undefined };
+}
+
+/**
+ * Represents options for the ${@link PositronRunApp.runApplication} function.
+ */
+export interface RunAppOptions {
+    /**
+     * The human-readable label for the application e.g. `'Shiny'`, also used as the ${@link vscode.Terminal.name}.
+     */
+    name: string;
+
+    /**
+     * A function that will be called to get the terminal options for running the application.
+     *
+     * @param runtime The language runtime metadata for the document's language.
+     * @param document The document to run.
+     * @param port The port to run the application on, if known.
+     * @param urlPrefix The URL prefix to use, if known.
+     * @returns The terminal options for running the application. Return `undefined` to abort the run.
+     */
+    getTerminalOptions: (
+        runtime: positron.LanguageRuntimeMetadata,
+        document: vscode.TextDocument,
+        port?: string,
+        urlPrefix?: string,
+    ) => RunAppTerminalOptions | undefined | Promise<RunAppTerminalOptions | undefined>;
+
+    /**
+     * The optional URL path at which to preview the application.
+     */
+    urlPath?: string;
+}
+
+/**
+ * The public API of the Positron Run App extension.
+ */
+export interface PositronRunApp {
+    /**
+     * Run an application in the terminal.
+     *
+     * @param options Options for running the application.
+     * @returns If terminal shell integration is supported, resolves when the application server has
+     *  started, otherwise resolves when the command has been sent to the terminal.
+     */
+    runApplication(options: RunAppOptions): Promise<void>;
+}

extensions/positron-python/src/client/positron/extension.ts

@@ -16,12 +16,10 @@ import { EnvironmentType } from '../pythonEnvironments/info';
 import { isProblematicCondaEnvironment } from '../interpreter/configuration/environmentTypeComparer';
 import { Interpreters } from '../common/utils/localize';
 import { IApplicationShell } from '../common/application/types';
-import { activateAppDetection } from './webAppContexts';
+import { activateAppDetection as activateWebAppDetection } from './webAppContexts';
+import { activateWebAppCommands } from './webAppCommands';
 
-export async function activatePositron(
-    serviceContainer: IServiceContainer,
-    context: vscode.ExtensionContext,
-): Promise<void> {
+export async function activatePositron(serviceContainer: IServiceContainer): Promise<void> {
     try {
         const disposables = serviceContainer.get<IDisposableRegistry>(IDisposableRegistry);
         // Register a command to check if ipykernel is installed for a given interpreter.
@@ -77,7 +75,10 @@ export async function activatePositron(
         );
 
         // Activate detection for web applications
-        activateAppDetection(context.subscriptions);
+        activateWebAppDetection(disposables);
+
+        // Activate web application commands.
+        activateWebAppCommands(serviceContainer, disposables);
 
         traceInfo('activatePositron: done!');
     } catch (ex) {