Skip to content

Ensure pyenv virtual envs are not skipped when in discovery experiment #15451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karthiknadig merged 4 commits into from
Feb 19, 2021
Merged

Ensure pyenv virtual envs are not skipped when in discovery experiment #15451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
484c8e4
Ensure pyenv virtual envs are not skipped
karthiknadig Feb 18, 2021
6fdfb55
Add news
karthiknadig Feb 18, 2021
63d3de5
Clean up
karthiknadig Feb 18, 2021
69c71e8
Address comments
karthiknadig Feb 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/2 Fixes/15439.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix for missing pyenv virtual environments from selectable environments.
32 changes: 22 additions & 10 deletions src/client/pythonEnvironments/common/externalDependencies.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,23 +97,35 @@ export async function getFileInfo(filePath: string): Promise<{ ctime: number; mt
}
}

export async function resolveSymbolicLink(filepath: string): Promise<string> {
const stats = await fsapi.lstat(filepath);
export async function resolveSymbolicLink(absPath: string): Promise<string> {
const stats = await fsapi.lstat(absPath);
if (stats.isSymbolicLink()) {
const link = await fsapi.readlink(filepath);
const link = await fsapi.readlink(absPath);
return resolveSymbolicLink(link);
}
return filepath;
return absPath;
}

export async function* getSubDirs(root: string): AsyncIterableIterator<string> {
const dirContents = await fsapi.readdir(root);
/**
* Returns full path to sub directories of a given directory.
* @param root
* @param resolveSymlinks
*/
export async function* getSubDirs(root: string, resolveSymlinks: boolean): AsyncIterableIterator<string> {
const dirContents = await fsapi.promises.readdir(root, { withFileTypes: true });
const generators = dirContents.map((item) => {
async function* generator() {
const stat = await fsapi.lstat(path.join(root, item));

if (stat.isDirectory()) {
yield item;
const fullPath = path.join(root, item.name);
if (item.isDirectory()) {
yield fullPath;
} else if (resolveSymlinks && item.isSymbolicLink()) {
// The current FS item is a symlink. It can potentially be a file
// or a directory. Resolve it first and then check if it is a directory.
const resolvedPath = await resolveSymbolicLink(fullPath);
const resolvedPathStat = await fsapi.lstat(resolvedPath);
if (resolvedPathStat.isDirectory()) {
yield resolvedPath;
}
}
}

Expand Down
16 changes: 8 additions & 8 deletions src/client/pythonEnvironments/discovery/locators/services/pyenvLocator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,15 +259,15 @@ export function parsePyenvVersion(str: string): Promise<IPyenvVersionStrings | u
async function* getPyenvEnvironments(): AsyncIterableIterator<PythonEnvInfo> {
const pyenvVersionDir = getPyenvVersionsDir();

const subDirs = getSubDirs(pyenvVersionDir);
for await (const subDir of subDirs) {
const envDir = path.join(pyenvVersionDir, subDir);
const interpreterPath = await getInterpreterPathFromDir(envDir);
const subDirs = getSubDirs(pyenvVersionDir, true);
for await (const subDirPath of subDirs) {
const envDirName = path.basename(subDirPath);
const interpreterPath = await getInterpreterPathFromDir(subDirPath);

if (interpreterPath) {
// The sub-directory name sometimes can contain distro and python versions.
// here we attempt to extract the texts out of the name.
const versionStrings = await parsePyenvVersion(subDir);
const versionStrings = await parsePyenvVersion(envDirName);

// Here we look for near by files, or config files to see if we can get python version info
// without running python itself.
Expand All @@ -290,7 +290,7 @@ async function* getPyenvEnvironments(): AsyncIterableIterator<PythonEnvInfo> {
// `pyenv local|global <env-name>` or `pyenv shell <env-name>`
//
// For the display name we are going to treat these as `pyenv` environments.
const display = `${subDir}:pyenv`;
const display = `${envDirName}:pyenv`;

const org = versionStrings && versionStrings.distro ? versionStrings.distro : '';

Expand All @@ -299,14 +299,14 @@ async function* getPyenvEnvironments(): AsyncIterableIterator<PythonEnvInfo> {
const envInfo = buildEnvInfo({
kind: PythonEnvKind.Pyenv,
executable: interpreterPath,
location: envDir,
location: subDirPath,
version: pythonVersion,
source: [PythonEnvSource.Pyenv],
display,
org,
fileInfo,
});
envInfo.name = subDir;
envInfo.name = envDirName;

yield envInfo;
}
Expand Down