feat: add pyenv support (#409)

Author: karthiknadig

src/common/localize.ts

@@ -152,6 +152,12 @@ export namespace CondaStrings {
     );
 }
 
+export namespace PyenvStrings {
+    export const pyenvManager = l10n.t('Manages Pyenv Python versions');
+    export const pyenvDiscovering = l10n.t('Discovering Pyenv Python versions');
+    export const pyenvRefreshing = l10n.t('Refreshing Pyenv Python versions');
+}
+
 export namespace ProjectCreatorString {
     export const addExistingProjects = l10n.t('Add Existing Projects');
     export const autoFindProjects = l10n.t('Auto Find Projects');

src/extension.ts

@@ -66,6 +66,7 @@ import { EnvironmentManagers, ProjectCreators, PythonProjectManager } from './in
 import { registerSystemPythonFeatures } from './managers/builtin/main';
 import { createNativePythonFinder, NativePythonFinder } from './managers/common/nativePythonFinder';
 import { registerCondaFeatures } from './managers/conda/main';
+import { registerPyenvFeatures } from './managers/pyenv/main';
 
 export async function activate(context: ExtensionContext): Promise<PythonEnvironmentApi> {
     const start = new StopWatch();
@@ -294,6 +295,7 @@ export async function activate(context: ExtensionContext): Promise<PythonEnviron
         await Promise.all([
             registerSystemPythonFeatures(nativeFinder, context.subscriptions, outputChannel),
             registerCondaFeatures(nativeFinder, context.subscriptions, outputChannel),
+            registerPyenvFeatures(nativeFinder, context.subscriptions),
             shellStartupVarsMgr.initialize(),
         ]);
 

src/managers/builtin/venvUtils.ts

@@ -32,7 +32,7 @@ import {
     NativePythonEnvironmentKind,
     NativePythonFinder,
 } from '../common/nativePythonFinder';
-import { shortVersion, sortEnvironments } from '../common/utils';
+import { pathForGitBash, shortVersion, sortEnvironments } from '../common/utils';
 import { isUvInstalled, runPython, runUV } from './helpers';
 import { getProjectInstallable, getWorkspacePackagesToInstall, PipPackages } from './pipUtils';
 import { resolveSystemPythonEnvironmentPath } from './utils';
@@ -113,10 +113,6 @@ function getName(binPath: string): string {
     return path.basename(dir1);
 }
 
-function pathForGitBash(binPath: string): string {
-    return isWindows() ? binPath.replace(/\\/g, '/').replace(/^([a-zA-Z]):/, '/$1') : binPath;
-}
-
 async function getPythonInfo(env: NativeEnvInfo): Promise<PythonEnvironmentInfo> {
     if (env.executable && env.version && env.prefix) {
         const venvName = env.name ?? getName(env.executable);

src/managers/common/utils.ts

@@ -1,4 +1,5 @@
 import { PythonEnvironment } from '../../api';
+import { isWindows } from '../../common/utils/platformUtils';
 import { Installable } from './types';
 
 export function noop() {
@@ -82,3 +83,7 @@ export function mergePackages(common: Installable[], installed: string[]): Insta
         .concat(notInCommon.map((pkg) => ({ name: pkg, displayName: pkg })))
         .sort((a, b) => a.name.localeCompare(b.name));
 }
+
+export function pathForGitBash(binPath: string): string {
+    return isWindows() ? binPath.replace(/\\/g, '/').replace(/^([a-zA-Z]):/, '/$1') : binPath;
+}

src/managers/conda/condaEnvManager.ts

@@ -58,14 +58,13 @@ export class CondaEnvManager implements EnvironmentManager, Disposable {
         this.name = 'conda';
         this.displayName = 'Conda';
         this.preferredPackageManagerId = 'ms-python.python:conda';
-        this.description = undefined;
         this.tooltip = new MarkdownString(CondaStrings.condaManager, true);
     }
 
     name: string;
     displayName: string;
-    preferredPackageManagerId: string = 'ms-python.python:conda';
-    description: string | undefined;
+    preferredPackageManagerId: string;
+    description?: string;
     tooltip: string | MarkdownString;
     iconPath?: IconPath;
 

src/managers/conda/condaUtils.ts

@@ -53,21 +53,22 @@ import {
 } from '../common/nativePythonFinder';
 import { selectFromCommonPackagesToInstall } from '../common/pickers';
 import { Installable } from '../common/types';
-import { shortVersion, sortEnvironments } from '../common/utils';
+import { pathForGitBash, shortVersion, sortEnvironments } from '../common/utils';
 
 export const CONDA_PATH_KEY = `${ENVS_EXTENSION_ID}:conda:CONDA_PATH`;
 export const CONDA_PREFIXES_KEY = `${ENVS_EXTENSION_ID}:conda:CONDA_PREFIXES`;
 export const CONDA_WORKSPACE_KEY = `${ENVS_EXTENSION_ID}:conda:WORKSPACE_SELECTED`;
 export const CONDA_GLOBAL_KEY = `${ENVS_EXTENSION_ID}:conda:GLOBAL_SELECTED`;
 
+let condaPath: string | undefined;
 export async function clearCondaCache(): Promise<void> {
     const state = await getWorkspacePersistentState();
     await state.clear([CONDA_PATH_KEY, CONDA_WORKSPACE_KEY, CONDA_GLOBAL_KEY]);
     const global = await getGlobalPersistentState();
     await global.clear([CONDA_PREFIXES_KEY]);
+    condaPath = undefined;
 }
 
-let condaPath: string | undefined;
 async function setConda(conda: string): Promise<void> {
     condaPath = conda;
     const state = await getWorkspacePersistentState();
@@ -283,10 +284,6 @@ function isPrefixOf(roots: string[], e: string): boolean {
     return false;
 }
 
-function pathForGitBash(binPath: string): string {
-    return isWindows() ? binPath.replace(/\\/g, '/').replace(/^([a-zA-Z]):/, '/$1') : binPath;
-}
-
 function getNamedCondaPythonInfo(
     name: string,
     prefix: string,

src/managers/pyenv/main.ts

@@ -0,0 +1,23 @@
+import { Disposable } from 'vscode';
+import { PythonEnvironmentApi } from '../../api';
+import { traceInfo } from '../../common/logging';
+import { getPythonApi } from '../../features/pythonApi';
+import { NativePythonFinder } from '../common/nativePythonFinder';
+import { PyEnvManager } from './pyenvManager';
+import { getPyenv } from './pyenvUtils';
+
+export async function registerPyenvFeatures(
+    nativeFinder: NativePythonFinder,
+    disposables: Disposable[],
+): Promise<void> {
+    const api: PythonEnvironmentApi = await getPythonApi();
+
+    try {
+        await getPyenv(nativeFinder);
+
+        const mgr = new PyEnvManager(nativeFinder, api);
+        disposables.push(mgr, api.registerEnvironmentManager(mgr));
+    } catch (ex) {
+        traceInfo('Pyenv not found, turning off pyenv features.', ex);
+    }
+}