Added setting to control when interpreter information is displayed in the status bar

package.json

@@ -587,6 +587,22 @@
                     "scope": "resource",
                     "type": "string"
                 },
+                "python.interpreter.infoVisibility": {
+                    "default": "onPythonRelated",
+                    "description": "%python.interpreter.infoVisibility.description%",
+                    "enum": [
+                        "never",
+                        "onPythonRelated",
+                        "always"
+                    ],
+                    "enumDescriptions": [
+                        "%python.interpreter.infoVisibility.never.description%",
+                        "%python.interpreter.infoVisibility.onPythonRelated.description%",
+                        "%python.interpreter.infoVisibility.always.description%"
+                    ],
+                    "scope": "machine",
+                    "type": "string"
+                },
                 "python.linting.flake8CategorySeverity.W": {
                     "default": "Warning",
                     "description": "%python.linting.flake8CategorySeverity.W.description%",

package.nls.json

@@ -57,6 +57,10 @@
     "python.linting.flake8Enabled.description": "Whether to lint Python files using flake8.",
     "python.linting.flake8Path.description": "Path to flake8, you can use a custom version of flake8 by modifying this setting to include the full path.",
     "python.linting.ignorePatterns.description": "Patterns used to exclude files or folders from being linted.",
+    "python.interpreter.infoVisibility.description": "Controls when to display information of selected interpreter in the status bar.",
+    "python.interpreter.infoVisibility.never.description": "Never display information of selected interpreter in the status bar.",
+    "python.interpreter.infoVisibility.onPythonRelated.description": "Only display information of selected interpreter in the status bar if Python related files are opened.",
+    "python.interpreter.infoVisibility.always.description": "Always display information of selected interpreter in the status bar.",
     "python.linting.lintOnSave.description": "Whether to lint Python files when saved.",
     "python.linting.maxNumberOfProblems.description": "Controls the maximum number of problems produced by the server.",
     "python.linting.mypyArgs.description": "Arguments passed in. Each argument is a separate item in the array.",

src/client/common/configSettings.ts

@@ -30,6 +30,7 @@ import {
     IExperiments,
     IFormattingSettings,
     IInterpreterPathService,
+    IInterpreterSettings,
     ILintingSettings,
     IPythonSettings,
     ISortImportSettings,
@@ -44,10 +45,15 @@ import { getOSType, OSType } from './utils/platform';
 const untildify = require('untildify');
 
 export class PythonSettings implements IPythonSettings {
-    public get onDidChange(): Event<void> {
+    private get onDidChange(): Event<ConfigurationChangeEvent | undefined> {
         return this.changed.event;
     }
 
+    // eslint-disable-next-line class-methods-use-this
+    public static onConfigChange(): Event<ConfigurationChangeEvent | undefined> {
+        return PythonSettings.configChanged.event;
+    }
+
     public get pythonPath(): string {
         return this._pythonPath;
     }
@@ -88,6 +94,8 @@ export class PythonSettings implements IPythonSettings {
 
     public venvPath = '';
 
+    public interpreter!: IInterpreterSettings;
+
     public venvFolders: string[] = [];
 
     public condaPath = '';
@@ -122,7 +130,9 @@ export class PythonSettings implements IPythonSettings {
 
     public languageServerIsDefault = true;
 
-    protected readonly changed = new EventEmitter<void>();
+    protected readonly changed = new EventEmitter<ConfigurationChangeEvent | undefined>();
+
+    private static readonly configChanged = new EventEmitter<ConfigurationChangeEvent | undefined>();
 
     private workspaceRoot: Resource;
 
@@ -166,6 +176,7 @@ export class PythonSettings implements IPythonSettings {
                 defaultLS,
             );
             PythonSettings.pythonSettings.set(workspaceFolderKey, settings);
+            settings.onDidChange((event) => PythonSettings.debounceConfigChangeNotification(event));
             // Pass null to avoid VSC from complaining about not passing in a value.
 
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -177,6 +188,12 @@ export class PythonSettings implements IPythonSettings {
         return PythonSettings.pythonSettings.get(workspaceFolderKey)!;
     }
 
+    @debounceSync(1)
+    // eslint-disable-next-line class-methods-use-this
+    protected static debounceConfigChangeNotification(event?: ConfigurationChangeEvent): void {
+        PythonSettings.configChanged.fire(event);
+    }
+
     public static getSettingsUriAndTarget(
         resource: Uri | undefined,
         workspace?: IWorkspaceService,
@@ -246,6 +263,9 @@ export class PythonSettings implements IPythonSettings {
         const poetryPath = systemVariables.resolveAny(pythonSettings.get<string>('poetryPath'))!;
         this.poetryPath = poetryPath && poetryPath.length > 0 ? getAbsolutePath(poetryPath, workspaceRoot) : poetryPath;
 
+        this.interpreter = pythonSettings.get<IInterpreterSettings>('interpreter') ?? {
+            infoVisibility: 'onPythonRelated',
+        };
         // Get as a string and verify; don't just accept.
         let userLS = pythonSettings.get<string>('languageServer');
         userLS = systemVariables.resolveAny(userLS);
@@ -512,28 +532,35 @@ export class PythonSettings implements IPythonSettings {
         this.initialize();
     }
 
-    public initialize(): void {
-        const onDidChange = () => {
-            const currentConfig = this.workspace.getConfiguration('python', this.workspaceRoot);
-            this.update(currentConfig);
+    private onDidChanged(event?: ConfigurationChangeEvent) {
+        const currentConfig = this.workspace.getConfiguration('python', this.workspaceRoot);
+        this.update(currentConfig);
 
-            // If workspace config changes, then we could have a cascading effect of on change events.
-            // Let's defer the change notification.
-            this.debounceChangeNotification();
-        };
+        // If workspace config changes, then we could have a cascading effect of on change events.
+        // Let's defer the change notification.
+        this.debounceChangeNotification(event);
+    }
+
+    public initialize(): void {
         this.disposables.push(this.workspace.onDidChangeWorkspaceFolders(this.onWorkspaceFoldersChanged, this));
         this.disposables.push(
-            this.interpreterAutoSelectionService.onDidChangeAutoSelectedInterpreter(onDidChange.bind(this)),
+            this.interpreterAutoSelectionService.onDidChangeAutoSelectedInterpreter(() => {
+                this.onDidChanged();
+            }),
         );
         this.disposables.push(
             this.workspace.onDidChangeConfiguration((event: ConfigurationChangeEvent) => {
                 if (event.affectsConfiguration('python')) {
-                    onDidChange();
+                    this.onDidChanged(event);
                 }
             }),
         );
         if (this.interpreterPathService) {
-            this.disposables.push(this.interpreterPathService.onDidChange(onDidChange.bind(this)));
+            this.disposables.push(
+                this.interpreterPathService.onDidChange(() => {
+                    this.onDidChanged();
+                }),
+            );
         }
 
         const initialConfig = this.workspace.getConfiguration('python', this.workspaceRoot);
@@ -543,8 +570,8 @@ export class PythonSettings implements IPythonSettings {
     }
 
     @debounceSync(1)
-    protected debounceChangeNotification(): void {
-        this.changed.fire();
+    protected debounceChangeNotification(event?: ConfigurationChangeEvent): void {
+        this.changed.fire(event);
     }
 
     private getPythonPath(systemVariables: SystemVariables, workspaceRoot: string | undefined) {

src/client/common/configuration/service.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { inject, injectable } from 'inversify';
-import { ConfigurationTarget, Uri, WorkspaceConfiguration } from 'vscode';
+import { ConfigurationTarget, Event, Uri, WorkspaceConfiguration, ConfigurationChangeEvent } from 'vscode';
 import { IInterpreterAutoSelectionService } from '../../interpreter/autoSelection/types';
 import { IServiceContainer } from '../../ioc/types';
 import { IWorkspaceService } from '../application/types';
@@ -18,6 +18,11 @@ export class ConfigurationService implements IConfigurationService {
         this.workspaceService = this.serviceContainer.get<IWorkspaceService>(IWorkspaceService);
     }
 
+    // eslint-disable-next-line class-methods-use-this
+    public get onDidChange(): Event<ConfigurationChangeEvent | undefined> {
+        return PythonSettings.onConfigChange();
+    }
+
     public getSettings(resource?: Uri): IPythonSettings {
         const InterpreterAutoSelectionService = this.serviceContainer.get<IInterpreterAutoSelectionService>(
             IInterpreterAutoSelectionService,

src/client/common/types.ts

@@ -7,6 +7,7 @@ import { Socket } from 'net';
 import { Request as RequestResult } from 'request';
 import {
     CancellationToken,
+    ConfigurationChangeEvent,
     ConfigurationTarget,
     DiagnosticSeverity,
     Disposable,
@@ -179,6 +180,7 @@ export interface ICurrentProcess {
 }
 
 export interface IPythonSettings {
+    readonly interpreter: IInterpreterSettings;
     readonly pythonPath: string;
     readonly venvPath: string;
     readonly venvFolders: string[];
@@ -195,7 +197,6 @@ export interface IPythonSettings {
     readonly envFile: string;
     readonly globalModuleInstallation: boolean;
     readonly pylanceLspNotebooksEnabled: boolean;
-    readonly onDidChange: Event<void>;
     readonly experiments: IExperiments;
     readonly languageServer: LanguageServerType;
     readonly languageServerIsDefault: boolean;
@@ -233,6 +234,9 @@ export interface IMypyCategorySeverity {
     readonly error: DiagnosticSeverity;
     readonly note: DiagnosticSeverity;
 }
+export interface IInterpreterSettings {
+    infoVisibility: 'never' | 'onPythonRelated' | 'always';
+}
 
 export interface ILintingSettings {
     readonly enabled: boolean;
@@ -308,6 +312,7 @@ export interface IAutoCompleteSettings {
 
 export const IConfigurationService = Symbol('IConfigurationService');
 export interface IConfigurationService {
+    readonly onDidChange: Event<ConfigurationChangeEvent | undefined>;
     getSettings(resource?: Uri): IPythonSettings;
     isTestExecution(): boolean;
     updateSetting(setting: string, value?: unknown, resource?: Uri, configTarget?: ConfigurationTarget): Promise<void>;

src/client/interpreter/interpreterService.ts

@@ -1,7 +1,15 @@
 // eslint-disable-next-line max-classes-per-file
 import { inject, injectable } from 'inversify';
 import * as pathUtils from 'path';
-import { Disposable, Event, EventEmitter, ProgressLocation, ProgressOptions, Uri } from 'vscode';
+import {
+    ConfigurationChangeEvent,
+    Disposable,
+    Event,
+    EventEmitter,
+    ProgressLocation,
+    ProgressOptions,
+    Uri,
+} from 'vscode';
 import '../common/extensions';
 import { IApplicationShell, IDocumentManager } from '../common/application/types';
 import {
@@ -95,20 +103,39 @@ export class InterpreterService implements Disposable, IInterpreterService {
         const documentManager = this.serviceContainer.get<IDocumentManager>(IDocumentManager);
         const interpreterDisplay = this.serviceContainer.get<IInterpreterDisplay>(IInterpreterDisplay);
         const filter = new (class implements IInterpreterStatusbarVisibilityFilter {
-            constructor(private readonly docManager: IDocumentManager) {}
+            constructor(
+                private readonly docManager: IDocumentManager,
+                private readonly configService: IConfigurationService,
+                private readonly disposablesReg: IDisposableRegistry,
+            ) {
+                this.disposablesReg.push(
+                    this.configService.onDidChange(async (event: ConfigurationChangeEvent | undefined) => {
+                        if (event?.affectsConfiguration('python.interpreter.infoVisibility')) {
+                            this.interpreterVisibilityEmitter.fire();
+                        }
+                    }),
+                );
+            }
 
             public readonly interpreterVisibilityEmitter = new EventEmitter<void>();
 
             public readonly changed = this.interpreterVisibilityEmitter.event;
 
             get hidden() {
+                const visibility = this.configService.getSettings().interpreter.infoVisibility;
+                if (visibility === 'never') {
+                    return true;
+                }
+                if (visibility === 'always') {
+                    return false;
+                }
                 const document = this.docManager.activeTextEditor?.document;
                 if (document?.fileName.endsWith('settings.json')) {
                     return false;
                 }
                 return document?.languageId !== PYTHON_LANGUAGE;
             }
-        })(documentManager);
+        })(documentManager, this.configService, disposables);
         interpreterDisplay.registerVisibilityFilter(filter);
         disposables.push(
             this.onDidChangeInterpreters((e): void => {

src/test/common/configSettings/configSettings.unit.test.ts

@@ -19,6 +19,7 @@ import {
     IAutoCompleteSettings,
     IExperiments,
     IFormattingSettings,
+    IInterpreterSettings,
     ILintingSettings,
     ISortImportSettings,
     ITerminalSettings,
@@ -109,6 +110,7 @@ suite('Python Settings', async () => {
         config.setup((c) => c.get<any[]>('devOptions')).returns(() => sourceSettings.devOptions);
 
         // complex settings
+        config.setup((c) => c.get<IInterpreterSettings>('interpreter')).returns(() => sourceSettings.interpreter);
         config.setup((c) => c.get<ILintingSettings>('linting')).returns(() => sourceSettings.linting);
         config.setup((c) => c.get<ISortImportSettings>('sortImports')).returns(() => sourceSettings.sortImports);
         config.setup((c) => c.get<IFormattingSettings>('formatting')).returns(() => sourceSettings.formatting);
@@ -145,6 +147,21 @@ suite('Python Settings', async () => {
         });
     });
 
+    test('Interpreter settings object', () => {
+        initializeConfig(expected);
+        config
+            .setup((c) => c.get<string>('condaPath'))
+            .returns(() => expected.condaPath)
+            .verifiable(TypeMoq.Times.once());
+
+        settings.update(config.object);
+
+        expect(settings.interpreter).to.deep.equal({
+            infoVisibility: 'onPythonRelated',
+        });
+        config.verifyAll();
+    });
+
     test('condaPath updated', () => {
         expected.pythonPath = 'python3';
         expected.condaPath = 'spam';