bug: reduce noise in the environments view (#183)

Fixes #182

Author: karthiknadig

src/features/views/treeViewItems.ts

@@ -31,9 +31,7 @@ export class EnvManagerTreeItem implements EnvTreeItem {
     constructor(public readonly manager: InternalEnvironmentManager) {
         const item = new TreeItem(manager.displayName, TreeItemCollapsibleState.Collapsed);
         item.contextValue = this.getContextValue();
-        // Descriptions were a bit too visually noisy
-        // https://github.com/microsoft/vscode-python-environments/issues/167
-        item.description = undefined;
+        item.description = manager.description;
         item.tooltip = manager.tooltip ?? manager.description;
         item.iconPath = manager.iconPath;
         this.treeItem = item;
@@ -72,12 +70,11 @@ export class PythonEnvTreeItem implements EnvTreeItem {
         public readonly selected?: string,
     ) {
         let name = environment.displayName ?? environment.name;
-        let tooltip = environment.tooltip;
+        let tooltip = environment.tooltip ?? environment.description;
         if (selected) {
-            const tooltipEnd = environment.tooltip ?? environment.description;
-            tooltip =
+            const selectedTooltip =
                 selected === 'global' ? EnvViewStrings.selectedGlobalTooltip : EnvViewStrings.selectedWorkspaceTooltip;
-            tooltip = tooltipEnd ? `${tooltip} ● ${tooltipEnd}` : tooltip;
+            tooltip = tooltip ? `${selectedTooltip} ● ${tooltip}` : tooltip;
         }
 
         const item = new TreeItem(name, TreeItemCollapsibleState.Collapsed);

src/managers/builtin/sysPythonManager.ts

@@ -43,7 +43,7 @@ export class SysPythonManager implements EnvironmentManager {
     public readonly name: string;
     public readonly displayName: string;
     public readonly preferredPackageManagerId: string;
-    public readonly description: string;
+    public readonly description: string | undefined;
     public readonly tooltip: string | MarkdownString;
     public readonly iconPath: IconPath;
 
@@ -55,7 +55,7 @@ export class SysPythonManager implements EnvironmentManager {
         this.name = 'system';
         this.displayName = 'Global';
         this.preferredPackageManagerId = 'ms-python.python:pip';
-        this.description = SysManagerStrings.sysManagerDescription;
+        this.description = undefined;
         this.tooltip = new MarkdownString(SysManagerStrings.sysManagerDescription, true);
         this.iconPath = new ThemeIcon('globe');
     }

src/managers/builtin/utils.ts

@@ -81,7 +81,8 @@ function getPythonInfo(env: NativeEnvInfo): PythonEnvironmentInfo {
             shortDisplayName: shortDisplayName,
             displayPath: env.executable,
             version: env.version,
-            description: env.executable,
+            description: undefined,
+            tooltip: env.executable,
             environmentPath: Uri.file(env.executable),
             iconPath: new ThemeIcon('globe'),
             sysPrefix: env.prefix,

src/managers/builtin/venvManager.ts

@@ -62,7 +62,9 @@ export class VenvManager implements EnvironmentManager {
     ) {
         this.name = 'venv';
         this.displayName = 'venv';
-        this.description = VenvManagerStrings.venvManagerDescription;
+        // Descriptions were a bit too visually noisy
+        // https://github.com/microsoft/vscode-python-environments/issues/167
+        this.description = undefined;
         this.tooltip = new MarkdownString(VenvManagerStrings.venvManagerDescription, true);
         this.preferredPackageManagerId = 'ms-python.python:pip';
         this.iconPath = new ThemeIcon('python');

src/managers/builtin/venvUtils.ts

@@ -236,7 +236,8 @@ async function getPythonInfo(env: NativeEnvInfo): Promise<PythonEnvironmentInfo>
             shortDisplayName: `${sv} (${venvName})`,
             displayPath: env.executable,
             version: env.version,
-            description: env.executable,
+            description: undefined,
+            tooltip: env.executable,
             environmentPath: Uri.file(env.executable),
             iconPath: new ThemeIcon('python'),
             sysPrefix: env.prefix,

src/managers/conda/condaEnvManager.ts

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

src/managers/conda/condaUtils.ts

@@ -270,7 +270,8 @@ function nativeToPythonEnv(
                 displayName: `base (${sv})`,
                 shortDisplayName: `base:${sv}`,
                 displayPath: e.name,
-                description: e.prefix,
+                description: undefined,
+                tooltip: e.prefix,
                 version: e.version,
                 sysPrefix: e.prefix,
                 execInfo: {
@@ -302,7 +303,8 @@ function nativeToPythonEnv(
                 displayName: `${basename} (${sv})`,
                 shortDisplayName: `${basename}:${sv}`,
                 displayPath: e.prefix,
-                description: e.prefix,
+                description: undefined,
+                tooltip: e.prefix,
                 version: e.version,
                 sysPrefix: e.prefix,
                 execInfo: {
@@ -340,7 +342,8 @@ function nativeToPythonEnv(
                 displayName: `${name} (${sv})`,
                 shortDisplayName: `${name}:${sv}`,
                 displayPath: e.prefix,
-                description: e.prefix,
+                description: undefined,
+                tooltip: e.prefix,
                 version: e.version,
                 sysPrefix: e.prefix,
                 execInfo: {