Sort available environments by assumed usefulness

[kimadeline]

For #16520

[karthiknadig]

Other than the path comparison thing this looks good.

[karthiknadig]

Paths probably should be normalized before comparing.

[karrtikr]

This helper should be useful,

vscode-python/src/client/common/platform/fs-paths.ts

Lines 151 to 158 in 488aaa2

	/**
	* Returns true if given file path exists within the given parent directory, false otherwise.
	* @param filePath File path to check for
	* @param parentPath The potential parent path to check for
	*/
	export function isParentPath(filePath: string, parentPath: string): boolean {
	return normCasePath(filePath).startsWith(normCasePath(parentPath));
	}

[karrtikr]

EnvTypeHeuristic.Local can also be of other types, including Unknown. I think we should be doing the check of whether an env is local prior to checking env types.

[kimadeline]

EnvTypeHeuristic.Local can also be of other types, including Unknown. I think we should be doing the check of whether an env is local prior to checking env types.

So from what I understand you are suggesting that any environment path that has the workspace as the parent path should be considered local? How can an environment end up categorized as Unknown again?

I think that if we failed to identify an environment it shouldn't be prioritized it over others.

[karrtikr]

you are suggesting that any environment path that has the workspace as the parent path should be considered local?

Yes

How can an environment end up categorized as Unknown again?

If none of our environments type checks matches, a local environment can be classified as Unknown.

vscode-python/src/client/pythonEnvironments/base/locators/lowLevel/workspaceVirtualEnvLocator.ts

Line 59 in a393225

return PythonEnvKind.Unknown;

But practically speaking it shouldn't happen. So maybe we shouldn't worry about the Unknown case in local envs.

I think that if we failed to identify an environment it shouldn't be prioritized it over others.

Or we can make an exception case as you suggested here.

[kimadeline]

Besides Venv and Unknown, which other environment types could possibly be categorized as local?

[karthiknadig]

Poetry, conda can both have local and global versions.

[karrtikr]

Virtualenv, Pipenv can be in there as well. Basically I don't think we should define local envs based on kind.

[karrtikr]

LGTM otherwise

[karrtikr]

EnvTypeHeuristic.Local can also be of other types, including Unknown. I think we should be doing the check of whether an env is local prior to checking env types.

[karrtikr]

LGTM