feat: improve package management

Author: karthiknadig

package-lock.json

@@ -6,13 +6,12 @@
     "publisher": "ms-python",
     "preview": true,
     "engines": {
-        "vscode": "^1.99.0-20250317"
+        "vscode": "^1.100.0-20250407"
     },
     "categories": [
         "Other"
     ],
     "enabledApiProposals": [
-        "terminalShellType",
         "terminalShellEnv"
     ],
     "capabilities": {
@@ -142,7 +141,6 @@
             {
                 "command": "python-envs.reset",
                 "title": "%python-envs.reset.title%",
-                "shortTitle": "Reset Environment",
                 "category": "Python",
                 "icon": "$(sync)"
             },
@@ -174,7 +172,6 @@
             {
                 "command": "python-envs.packages",
                 "title": "%python-envs.packages.title%",
-                "shortTitle": "Modify Packages",
                 "category": "Python",
                 "icon": "$(package)"
             },
@@ -534,7 +531,7 @@
         "@types/node": "20.2.5",
         "@types/sinon": "^17.0.3",
         "@types/stack-trace": "0.0.29",
-        "@types/vscode": "^1.97.0",
+        "@types/vscode": "^1.99.0",
         "@types/which": "^3.0.4",
         "@typescript-eslint/eslint-plugin": "^8.16.0",
         "@typescript-eslint/parser": "^8.16.0",

package.json

@@ -16,12 +16,12 @@
     "python-envs.createAny.title": "Create Environment",
     "python-envs.set.title": "Set Workspace Environment",
     "python-envs.setEnv.title": "Set As Workspace Environment",
-    "python-envs.reset.title": "Reset Environment Selection to Default",
+    "python-envs.reset.title": "Reset to Default",
     "python-envs.remove.title": "Delete Environment",
     "python-envs.refreshAllManagers.title": "Refresh All Environment Managers",
     "python-envs.refreshManager.title": "Refresh Environments List",
     "python-envs.refreshPackages.title": "Refresh Packages List",
-    "python-envs.packages.title": "Install or Remove Packages",
+    "python-envs.packages.title": "Manage Packages",
     "python-envs.clearCache.title": "Clear Cache",
     "python-envs.runInTerminal.title": "Run in Terminal",
     "python-envs.createTerminal.title": "Create Python Terminal",

package.nls.json

@@ -575,20 +575,12 @@ export interface PackageManager {
     log?: LogOutputChannel;
 
     /**
-     * Installs packages in the specified Python environment.
+     * Installs/Uninstall packages in the specified Python environment.
      * @param environment - The Python environment in which to install packages.
      * @param packages - The packages to install.
      * @returns A promise that resolves when the installation is complete.
      */
-    install(environment: PythonEnvironment, packages?: string[], options?: PackageInstallOptions): Promise<void>;
-
-    /**
-     * Uninstalls packages from the specified Python environment.
-     * @param environment - The Python environment from which to uninstall packages.
-     * @param packages - The packages to uninstall, which can be an array of packages or strings.
-     * @returns A promise that resolves when the uninstall is complete.
-     */
-    uninstall(environment: PythonEnvironment, packages?: Package[] | string[]): Promise<void>;
+    manage(environment: PythonEnvironment, options: PackageManagementOptions): Promise<void>;
 
     /**
      * Refreshes the package list for the specified Python environment.
@@ -713,20 +705,47 @@ export interface DidChangePythonProjectsEventArgs {
     removed: PythonProject[];
 }
 
-/**
- * Options for package installation.
- */
-export interface PackageInstallOptions {
-    /**
-     * Upgrade the packages if it is already installed.
-     */
-    upgrade?: boolean;
+export type PackageManagementOptions =
+    | {
+          /**
+           * Upgrade the packages if it is already installed.
+           */
+          upgrade?: boolean;
 
-    /**
-     * Show option to skip package installation
-     */
-    showSkipOption?: boolean;
-}
+          /**
+           * Show option to skip package installation
+           */
+          showSkipOption?: boolean;
+          /**
+           * The list of packages to install.
+           */
+          install: string[];
+
+          /**
+           * The list of packages to uninstall.
+           */
+          uninstall?: string[];
+      }
+    | {
+          /**
+           * Upgrade the packages if it is already installed.
+           */
+          upgrade?: boolean;
+
+          /**
+           * Show option to skip package installation
+           */
+          showSkipOption?: boolean;
+          /**
+           * The list of packages to install.
+           */
+          install?: string[];
+
+          /**
+           * The list of packages to uninstall.
+           */
+          uninstall: string[];
+      };
 
 export interface PythonProcess {
     /**
@@ -909,21 +928,13 @@ export interface PythonPackageItemApi {
 
 export interface PythonPackageManagementApi {
     /**
-     * Install packages into a Python Environment.
+     * Install/Uninstall packages into a Python Environment.
      *
      * @param environment The Python Environment into which packages are to be installed.
      * @param packages The packages to install.
      * @param options Options for installing packages.
      */
-    installPackages(environment: PythonEnvironment, packages: string[], options?: PackageInstallOptions): Promise<void>;
-
-    /**
-     * Uninstall packages from a Python Environment.
-     *
-     * @param environment The Python Environment from which packages are to be uninstalled.
-     * @param packages The packages to uninstall.
-     */
-    uninstallPackages(environment: PythonEnvironment, packages: PackageInfo[] | string[]): Promise<void>;
+    managePackages(environment: PythonEnvironment, options: PackageManagementOptions): Promise<void>;
 }
 
 export interface PythonPackageManagerApi

src/api.ts

@@ -20,10 +20,14 @@ export namespace Interpreter {
 }
 
 export namespace PackageManagement {
+    export const install = l10n.t('Install');
+    export const uninstall = l10n.t('Uninstall');
+    export const installed = l10n.t('Installed');
+    export const commonPackages = l10n.t('Common Packages');
     export const selectPackagesToInstall = l10n.t('Select packages to install');
     export const enterPackageNames = l10n.t('Enter package names');
-    export const commonPackages = l10n.t('Search common `PyPI` packages');
-    export const commonPackagesDescription = l10n.t('Search and Install common `PyPI` packages');
+    export const searchCommonPackages = l10n.t('Search common `PyPI` packages');
+    export const searchCommonPackagesDescription = l10n.t('Search and Install common `PyPI` packages');
     export const workspaceDependencies = l10n.t('Install workspace dependencies');
     export const workspaceDependenciesDescription = l10n.t('Install dependencies found in the current workspace.');
     export const selectPackagesToUninstall = l10n.t('Select packages to uninstall');
@@ -40,8 +44,6 @@ export namespace Pickers {
 
     export namespace Packages {
         export const selectOption = l10n.t('Select an option');
-        export const installPackages = l10n.t('Install packages');
-        export const uninstallPackages = l10n.t('Uninstall packages');
     }
 
     export namespace Managers {

src/common/localize.ts

@@ -8,7 +8,6 @@ import {
     createEnvironmentCommand,
     createTerminalCommand,
     getPackageCommandOptions,
-    handlePackagesCommand,
     refreshManagerCommand,
     removeEnvironmentCommand,
     removePythonProject,
@@ -138,7 +137,7 @@ export async function activate(context: ExtensionContext): Promise<PythonEnviron
                 envManagers,
                 projectManager,
             );
-            await handlePackagesCommand(packageManager, environment);
+            packageManager.manage(environment, { install: [] });
         }),
         commands.registerCommand('python-envs.uninstallPackage', async (context: unknown) => {
             await handlePackageUninstall(context, envManagers);

src/common/pickers/packages.ts

@@ -33,10 +33,8 @@ import {
     PackageTreeItem,
     ProjectPackage,
 } from './views/treeViewItems';
-import { Common } from '../common/localize';
 import { pickEnvironment } from '../common/pickers/environments';
 import { pickEnvironmentManager, pickPackageManager, pickCreator } from '../common/pickers/managers';
-import { pickPackageOptions } from '../common/pickers/packages';
 import { pickProject, pickProjectMany } from '../common/pickers/projects';
 import { TerminalManager } from './terminal/terminalManager';
 import { runInTerminal } from './terminal/runInTerminal';
@@ -180,32 +178,12 @@ export async function removeEnvironmentCommand(context: unknown, managers: Envir
     }
 }
 
-export async function handlePackagesCommand(
-    packageManager: InternalPackageManager,
-    environment: PythonEnvironment,
-): Promise<void> {
-    const action = await pickPackageOptions();
-
-    try {
-        if (action === Common.install) {
-            await packageManager.install(environment, undefined, { showSkipOption: false });
-        } else if (action === Common.uninstall) {
-            await packageManager.uninstall(environment);
-        }
-    } catch (ex) {
-        if (ex === QuickInputButtons.Back) {
-            return handlePackagesCommand(packageManager, environment);
-        }
-        throw ex;
-    }
-}
-
 export async function handlePackageUninstall(context: unknown, em: EnvironmentManagers) {
     if (context instanceof PackageTreeItem || context instanceof ProjectPackage) {
         const moduleName = context.pkg.name;
         const environment = context.parent.environment;
         const packageManager = em.getPackageManager(environment);
-        await packageManager?.uninstall(environment, [moduleName]);
+        await packageManager?.manage(environment, { uninstall: [moduleName], install: [] });
         return;
     }
     traceError(`Invalid context for uninstall command: ${typeof context}`);

src/extension.ts

@@ -21,7 +21,7 @@ import {
     PackageId,
     PythonProjectCreator,
     ResolveEnvironmentContext,
-    PackageInstallOptions,
+    PackageManagementOptions,
     PythonProcess,
     PythonTaskExecutionOptions,
     PythonTerminalExecutionOptions,
@@ -216,19 +216,12 @@ class PythonEnvironmentApiImpl implements PythonEnvironmentApi {
         }
         return new Disposable(() => disposables.forEach((d) => d.dispose()));
     }
-    installPackages(context: PythonEnvironment, packages: string[], options: PackageInstallOptions): Promise<void> {
+    managePackages(context: PythonEnvironment, options: PackageManagementOptions): Promise<void> {
         const manager = this.envManagers.getPackageManager(context);
         if (!manager) {
             return Promise.reject(new Error('No package manager found'));
         }
-        return manager.install(context, packages, options);
-    }
-    uninstallPackages(context: PythonEnvironment, packages: Package[] | string[]): Promise<void> {
-        const manager = this.envManagers.getPackageManager(context);
-        if (!manager) {
-            return Promise.reject(new Error('No package manager found'));
-        }
-        return manager.uninstall(context, packages);
+        return manager.manage(context, options);
     }
     refreshPackages(context: PythonEnvironment): Promise<void> {
         const manager = this.envManagers.getPackageManager(context);

src/features/envCommands.ts

@@ -22,7 +22,7 @@ import {
     PackageInfo,
     PythonProjectCreator,
     ResolveEnvironmentContext,
-    PackageInstallOptions,
+    PackageManagementOptions,
     EnvironmentGroupInfo,
 } from './api';
 import { CreateEnvironmentNotSupported, RemoveEnvironmentNotSupported } from './common/errors/NotSupportedError';
@@ -225,22 +225,22 @@ export class InternalPackageManager implements PackageManager {
         return this.manager.log;
     }
 
-    install(environment: PythonEnvironment, packages?: string[], options?: PackageInstallOptions): Promise<void> {
-        return this.manager.install(environment, packages, options);
-    }
-    uninstall(environment: PythonEnvironment, packages?: Package[] | string[]): Promise<void> {
-        return this.manager.uninstall(environment, packages);
+    manage(environment: PythonEnvironment, options: PackageManagementOptions): Promise<void> {
+        return this.manager.manage(environment, options);
     }
+
     refresh(environment: PythonEnvironment): Promise<void> {
         return this.manager.refresh(environment);
     }
+
     getPackages(environment: PythonEnvironment): Promise<Package[] | undefined> {
         return this.manager.getPackages(environment);
     }
 
     onDidChangePackages(handler: (e: DidChangePackagesEventArgs) => void): Disposable {
         return this.manager.onDidChangePackages ? this.manager.onDidChangePackages(handler) : new Disposable(() => {});
     }
+
     equals(other: PackageManager): boolean {
         return this.manager === other;
     }