Skip to content

Conda hook search #648

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
merged 6 commits into from
Jul 29, 2025
Merged

Conda hook search #648

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6085288
update search for conda-hook.ps1 to include more locations
eleanorjboyd Jul 25, 2025
15b971e
switch to async
eleanorjboyd Jul 25, 2025
b57eff1
fix to not throw
eleanorjboyd Jul 25, 2025
174650e
Attach & for shell integration enabled pwsh case (#652)
anthonykim1 Jul 25, 2025
38bd529
bug: fix gitignore add for more scenarios (#627)
eleanorjboyd Jul 25, 2025
040aea3
Merge branch 'main' into conda-hook-search
eleanorjboyd Jul 27, 2025
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
69 changes: 54 additions & 15 deletions src/managers/conda/condaUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,13 +280,13 @@ function isPrefixOf(roots: string[], e: string): boolean {
return false;
}

function getNamedCondaPythonInfo(
async function getNamedCondaPythonInfo(
name: string,
prefix: string,
executable: string,
version: string,
conda: string,
): PythonEnvironmentInfo {
): Promise<PythonEnvironmentInfo> {
const sv = shortVersion(version);
const shellActivation: Map<string, PythonCommandRunConfiguration[]> = new Map();
const shellDeactivation: Map<string, PythonCommandRunConfiguration[]> = new Map();
Expand Down Expand Up @@ -323,7 +323,7 @@ function getNamedCondaPythonInfo(
]);
shellDeactivation.set(ShellConstants.ZSH, [{ executable: 'conda', args: ['deactivate'] }]);
}
const psActivate = path.join(path.dirname(path.dirname(conda)), 'shell', 'condabin', 'conda-hook.ps1');
const psActivate = await getCondaHookPs1Path(conda);
shellActivation.set(ShellConstants.PWSH, [
{ executable: '&', args: [psActivate] },
{ executable: 'conda', args: ['activate', name] },
Expand Down Expand Up @@ -374,12 +374,12 @@ function getNamedCondaPythonInfo(
};
}

function getPrefixesCondaPythonInfo(
async function getPrefixesCondaPythonInfo(
prefix: string,
executable: string,
version: string,
conda: string,
): PythonEnvironmentInfo {
): Promise<PythonEnvironmentInfo> {
const sv = shortVersion(version);
const shellActivation: Map<string, PythonCommandRunConfiguration[]> = new Map();
const shellDeactivation: Map<string, PythonCommandRunConfiguration[]> = new Map();
Expand Down Expand Up @@ -416,7 +416,7 @@ function getPrefixesCondaPythonInfo(
]);
shellDeactivation.set(ShellConstants.ZSH, [{ executable: 'conda', args: ['deactivate'] }]);
}
const psActivate = path.join(path.dirname(path.dirname(conda)), 'shell', 'condabin', 'conda-hook.ps1');
const psActivate = await getCondaHookPs1Path(conda);
shellActivation.set(ShellConstants.PWSH, [
{ executable: '&', args: [psActivate] },
{ executable: 'conda', args: ['activate', prefix] },
Expand Down Expand Up @@ -487,14 +487,14 @@ function getCondaWithoutPython(name: string, prefix: string, conda: string): Pyt
};
}

function nativeToPythonEnv(
async function nativeToPythonEnv(
e: NativeEnvInfo,
api: PythonEnvironmentApi,
manager: EnvironmentManager,
log: LogOutputChannel,
conda: string,
condaPrefixes: string[],
): PythonEnvironment | undefined {
): Promise<PythonEnvironment | undefined> {
if (!(e.prefix && e.executable && e.version)) {
let name = e.name;
const environment = api.createPythonEnvironmentItem(
Expand All @@ -507,14 +507,14 @@ function nativeToPythonEnv(

if (e.name === 'base') {
const environment = api.createPythonEnvironmentItem(
getNamedCondaPythonInfo('base', e.prefix, e.executable, e.version, conda),
await getNamedCondaPythonInfo('base', e.prefix, e.executable, e.version, conda),
manager,
);
log.info(`Found base environment: ${e.prefix}`);
return environment;
} else if (!isPrefixOf(condaPrefixes, e.prefix)) {
const environment = api.createPythonEnvironmentItem(
getPrefixesCondaPythonInfo(e.prefix, e.executable, e.version, conda),
await getPrefixesCondaPythonInfo(e.prefix, e.executable, e.version, conda),
manager,
);
log.info(`Found prefix environment: ${e.prefix}`);
Expand All @@ -523,7 +523,7 @@ function nativeToPythonEnv(
const basename = path.basename(e.prefix);
const name = e.name ?? basename;
const environment = api.createPythonEnvironmentItem(
getNamedCondaPythonInfo(name, e.prefix, e.executable, e.version, conda),
await getNamedCondaPythonInfo(name, e.prefix, e.executable, e.version, conda),
manager,
);
log.info(`Found named environment: ${e.prefix}`);
Expand Down Expand Up @@ -586,8 +586,8 @@ export async function refreshCondaEnvs(
.filter((e) => e.kind === NativePythonEnvironmentKind.conda);
const collection: PythonEnvironment[] = [];

envs.forEach((e) => {
const environment = nativeToPythonEnv(e, api, manager, log, condaPath, condaPrefixes);
envs.forEach(async (e) => {
const environment = await nativeToPythonEnv(e, api, manager, log, condaPath, condaPrefixes);
if (environment) {
collection.push(environment);
}
Expand Down Expand Up @@ -699,7 +699,7 @@ async function createNamedCondaEnvironment(
const version = await getVersion(envPath);

const environment = api.createPythonEnvironmentItem(
getNamedCondaPythonInfo(envName, envPath, path.join(envPath, bin), version, await getConda()),
await getNamedCondaPythonInfo(envName, envPath, path.join(envPath, bin), version, await getConda()),
manager,
);
return environment;
Expand Down Expand Up @@ -757,7 +757,7 @@ async function createPrefixCondaEnvironment(
const version = await getVersion(prefix);

const environment = api.createPythonEnvironmentItem(
getPrefixesCondaPythonInfo(prefix, path.join(prefix, bin), version, await getConda()),
await getPrefixesCondaPythonInfo(prefix, path.join(prefix, bin), version, await getConda()),
manager,
);
return environment;
Expand Down Expand Up @@ -1052,3 +1052,42 @@ export async function checkForNoPythonCondaEnvironment(
}
return environment;
}

/**
* Returns the best guess path to conda-hook.ps1 given a conda executable path.
*
* Searches for conda-hook.ps1 in these locations (relative to the conda root):
* - shell/condabin/
* - Library/shell/condabin/
* - condabin/
* - etc/profile.d/
*/
async function getCondaHookPs1Path(condaPath: string): Promise<string> {
const condaRoot = path.dirname(path.dirname(condaPath));

const condaRootCandidates: string[] = [
path.join(condaRoot, 'shell', 'condabin'),
path.join(condaRoot, 'Library', 'shell', 'condabin'),
path.join(condaRoot, 'condabin'),
path.join(condaRoot, 'etc', 'profile.d'),
];

const checks = condaRootCandidates.map(async (hookSearchDir) => {
const candidate = path.join(hookSearchDir, 'conda-hook.ps1');
if (await fse.pathExists(candidate)) {
traceInfo(`Conda hook found at: ${candidate}`);
return candidate;
}
return undefined;
});
const results = await Promise.all(checks);
const found = results.find(Boolean);
if (found) {
return found as string;
}
throw new Error(
`Conda hook not found in expected locations. Tried: ${condaRootCandidates.join(
', ',
)} based on conda executable at ${condaPath}.`,
);
Copy link
Member

@karthiknadig karthiknadig Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not block the discovery right?

Copy link
Member Author

@eleanorjboyd eleanorjboyd Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm good point- will fix

}