forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sort available environments by assumed usefulness (#16559)
* New comparison logic * Add experiment group * Register and call it * Add service registry tests * Add interpreter selector unit tests * Add comparison unit tests * Add intepreter selector test * News file * Adjust comments * Reuse getSortName * Add experiment to package.json * Check if environment is local before anything else * Update comment on comparison guidelines * Remove 'unknown' exception
- Loading branch information
1 parent
c60d03b
commit a0f0337
Showing
11 changed files
with
626 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Sort environments in the selection quickpick by assumed usefulness. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
src/client/interpreter/configuration/environmentTypeComparer.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import { injectable, inject } from 'inversify'; | ||
| import { getArchitectureDisplayName } from '../../common/platform/registry'; | ||
| import { isParentPath } from '../../pythonEnvironments/common/externalDependencies'; | ||
| import { EnvironmentType, PythonEnvironment } from '../../pythonEnvironments/info'; | ||
| import { PythonVersion } from '../../pythonEnvironments/info/pythonVersion'; | ||
| import { IInterpreterHelper } from '../contracts'; | ||
| import { IInterpreterComparer } from './types'; | ||
|
|
||
| /* | ||
| * Enum description: | ||
| * - Local environments (.venv); | ||
| * - Global environments (pipenv, conda); | ||
| * - Globally-installed interpreters (/usr/bin/python3, Windows Store). | ||
| */ | ||
| enum EnvTypeHeuristic { | ||
| Local = 1, | ||
| Global = 2, | ||
| GlobalInterpreters = 3, | ||
| } | ||
|
|
||
| @injectable() | ||
| export class EnvironmentTypeComparer implements IInterpreterComparer { | ||
| private workspaceFolderPath: string; | ||
|
|
||
| constructor(@inject(IInterpreterHelper) private readonly interpreterHelper: IInterpreterHelper) { | ||
| this.workspaceFolderPath = this.interpreterHelper.getActiveWorkspaceUri(undefined)?.folderUri.fsPath ?? ''; | ||
| } | ||
|
|
||
| /** | ||
| * Compare 2 Python environments, sorting them by assumed usefulness. | ||
| * Return 0 if both environments are equal, -1 if a should be closer to the beginning of the list, or 1 if a comes after b. | ||
| * | ||
| * The comparison guidelines are: | ||
| * 1. Local environments first (same path as the workspace root); | ||
| * 2. Global environments next (anything not local), with conda environments at a lower priority, and "base" being last; | ||
| * 3. Globally-installed interpreters (/usr/bin/python3, Windows Store). | ||
| * | ||
| * Always sort with newest version of Python first within each subgroup. | ||
| */ | ||
| public compare(a: PythonEnvironment, b: PythonEnvironment): number { | ||
| // Check environment type. | ||
| const envTypeComparison = compareEnvironmentType(a, b, this.workspaceFolderPath); | ||
| if (envTypeComparison !== 0) { | ||
| return envTypeComparison; | ||
| } | ||
|
|
||
| // Check Python version. | ||
| const versionComparison = comparePythonVersionDescending(a.version, b.version); | ||
| if (versionComparison !== 0) { | ||
| return versionComparison; | ||
| } | ||
|
|
||
| // Prioritize non-Conda environments. | ||
| if (isCondaEnvironment(a) && !isCondaEnvironment(b)) { | ||
| return 1; | ||
| } | ||
|
|
||
| if (!isCondaEnvironment(a) && isCondaEnvironment(b)) { | ||
| return -1; | ||
| } | ||
|
|
||
| // If we have the "base" Conda env, put it last in its Python version subgroup. | ||
| if (isBaseCondaEnvironment(a)) { | ||
| return 1; | ||
| } | ||
|
|
||
| // Check alphabetical order (same way as the InterpreterComparer class). | ||
| const nameA = getSortName(a, this.interpreterHelper); | ||
| const nameB = getSortName(b, this.interpreterHelper); | ||
| if (nameA === nameB) { | ||
| return 0; | ||
| } | ||
|
|
||
| return nameA > nameB ? 1 : -1; | ||
| } | ||
| } | ||
|
|
||
| // This function is exported because the InterpreterComparer class uses the same logic. | ||
| // Once it gets removed as we ramp up #16520, we can restrict this function to this file. | ||
| export function getSortName(info: PythonEnvironment, interpreterHelper: IInterpreterHelper): string { | ||
| const sortNameParts: string[] = []; | ||
| const envSuffixParts: string[] = []; | ||
|
|
||
| // Sort order for interpreters is: | ||
| // * Version | ||
| // * Architecture | ||
| // * Interpreter Type | ||
| // * Environment name | ||
| if (info.version) { | ||
| sortNameParts.push(info.version.raw); | ||
| } | ||
| if (info.architecture) { | ||
| sortNameParts.push(getArchitectureDisplayName(info.architecture)); | ||
| } | ||
| if (info.companyDisplayName && info.companyDisplayName.length > 0) { | ||
| sortNameParts.push(info.companyDisplayName.trim()); | ||
| } else { | ||
| sortNameParts.push('Python'); | ||
| } | ||
|
|
||
| if (info.envType) { | ||
| const name = interpreterHelper.getInterpreterTypeDisplayName(info.envType); | ||
| if (name) { | ||
| envSuffixParts.push(name); | ||
| } | ||
| } | ||
| if (info.envName && info.envName.length > 0) { | ||
| envSuffixParts.push(info.envName); | ||
| } | ||
|
|
||
| const envSuffix = envSuffixParts.length === 0 ? '' : `(${envSuffixParts.join(': ')})`; | ||
| return `${sortNameParts.join(' ')} ${envSuffix}`.trim(); | ||
| } | ||
|
|
||
| function isCondaEnvironment(environment: PythonEnvironment): boolean { | ||
| return environment.envType === EnvironmentType.Conda; | ||
| } | ||
|
|
||
| function isBaseCondaEnvironment(environment: PythonEnvironment): boolean { | ||
| return isCondaEnvironment(environment) && (environment.envName === 'base' || environment.envName === 'miniconda'); | ||
| } | ||
|
|
||
| /** | ||
| * Compare 2 Python versions in decending order, most recent one comes first. | ||
| */ | ||
| function comparePythonVersionDescending(a: PythonVersion | undefined, b: PythonVersion | undefined): number { | ||
| if (!a) { | ||
| return 1; | ||
| } | ||
|
|
||
| if (!b) { | ||
| return -1; | ||
| } | ||
|
|
||
| if (a.raw === b.raw) { | ||
| return 0; | ||
| } | ||
|
|
||
| if (a.major === b.major) { | ||
| if (a.minor === b.minor) { | ||
| if (a.patch === b.patch) { | ||
| return a.build.join(' ') > b.build.join(' ') ? -1 : 1; | ||
| } | ||
| return a.patch > b.patch ? -1 : 1; | ||
| } | ||
| return a.minor > b.minor ? -1 : 1; | ||
| } | ||
|
|
||
| return a.major > b.major ? -1 : 1; | ||
| } | ||
|
|
||
| /** | ||
| * Compare 2 environment types: return 0 if they are the same, -1 if a comes before b, 1 otherwise. | ||
| */ | ||
| function compareEnvironmentType(a: PythonEnvironment, b: PythonEnvironment, workspacePath: string): number { | ||
| const aHeuristic = getEnvTypeHeuristic(a, workspacePath); | ||
| const bHeuristic = getEnvTypeHeuristic(b, workspacePath); | ||
|
|
||
| return Math.sign(aHeuristic - bHeuristic); | ||
| } | ||
|
|
||
| /** | ||
| * Return a heuristic value depending on the environment type. | ||
| */ | ||
| function getEnvTypeHeuristic(environment: PythonEnvironment, workspacePath: string): EnvTypeHeuristic { | ||
| const { envType } = environment; | ||
|
|
||
| if (workspacePath.length > 0 && environment.envPath && isParentPath(environment.envPath, workspacePath)) { | ||
| return EnvTypeHeuristic.Local; | ||
| } | ||
|
|
||
| switch (envType) { | ||
| case EnvironmentType.Venv: | ||
| case EnvironmentType.Conda: | ||
| case EnvironmentType.VirtualEnv: | ||
| case EnvironmentType.VirtualEnvWrapper: | ||
| case EnvironmentType.Pipenv: | ||
| case EnvironmentType.Poetry: | ||
| return EnvTypeHeuristic.Global; | ||
| // The default case covers global environments. | ||
| // For now this includes: pyenv, Windows Store, Global, System and Unknown environment types. | ||
| default: | ||
| return EnvTypeHeuristic.GlobalInterpreters; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.