Skip to content

Load SDK from Python venv #5

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
AmaranthineCodices merged 5 commits into from
Jul 16, 2025
Merged

Load SDK from Python venv #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
93f351c
initial migration
AmaranthineCodices Jul 11, 2025
f2374a9
some refactoring + telemetry
AmaranthineCodices Jul 11, 2025
6085ba7
add Custom SDK kind
AmaranthineCodices Jul 11, 2025
ab0ceb0
rudimentary install warning
AmaranthineCodices Jul 14, 2025
3fc63df
minor cleanup
AmaranthineCodices Jul 14, 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
24 changes: 13 additions & 11 deletions extension/commands/run.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ import * as vscode from 'vscode';
import { DisposableContext } from '../utils/disposableContext';
import * as path from 'path';
import * as config from '../utils/config';
import { MAXSDK } from '../sdk/sdk';
import { MAXSDKManager } from '../sdk/sdkManager';
import { MojoDebugConfiguration } from '../debug/debug';
import md5 from 'md5';
import { Optional } from '../types';
import { PythonEnvironmentManager, SDK } from '../pyenv';

type FileArgs = {
runArgs: string[];
Expand All @@ -24,13 +23,16 @@ type FileArgs = {
* This class provides a manager for executing and debugging mojo files.
*/
class ExecutionManager extends DisposableContext {
readonly sdkManager: MAXSDKManager;
readonly envManager: PythonEnvironmentManager;
private context: vscode.ExtensionContext;

constructor(sdkManager: MAXSDKManager, context: vscode.ExtensionContext) {
constructor(
sdkManager: PythonEnvironmentManager,
context: vscode.ExtensionContext,
) {
super();

this.sdkManager = sdkManager;
this.envManager = sdkManager;
this.context = context;
this.activateRunCommands();
}
Expand Down Expand Up @@ -150,7 +152,7 @@ class ExecutionManager extends DisposableContext {
}

// Find the config for processing this file.
const sdk = await this.sdkManager.findSDK(/*hideRepeatedErrors=*/ false);
const sdk = await this.envManager.getActiveSDK();

if (!sdk) {
return;
Expand All @@ -161,7 +163,7 @@ class ExecutionManager extends DisposableContext {
terminal.show();
terminal.sendText(
quote([
sdk.config.mojoDriverPath,
sdk.mojoPath,
'run',
...this.getBuildArgs(doc.fileName),
doc.fileName,
Expand Down Expand Up @@ -212,8 +214,8 @@ class ExecutionManager extends DisposableContext {
/**
* Get a terminal to use for the given file.
*/
getTerminalForFile(doc: vscode.TextDocument, sdk: MAXSDK): vscode.Terminal {
const fullId = `${doc.fileName} · ${sdk.config.modularHomePath}`;
getTerminalForFile(doc: vscode.TextDocument, sdk: SDK): vscode.Terminal {
const fullId = `${doc.fileName} · ${sdk.homePath}`;
// We have to keep the full terminal name short so that VS Code renders it nicely,
// and we have to keep it unique among other files.
const terminalName = `Mojo: ${path.basename(doc.fileName)} · ${md5(fullId).substring(0, 5)}`;
Expand Down Expand Up @@ -285,8 +287,8 @@ class ExecutionManager extends DisposableContext {
* commands.
*/
export function activateRunCommands(
sdkManager: MAXSDKManager,
envManager: PythonEnvironmentManager,
context: vscode.ExtensionContext,
): vscode.Disposable {
return new ExecutionManager(sdkManager, context);
return new ExecutionManager(envManager, context);
}
111 changes: 58 additions & 53 deletions extension/debug/debug.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ import { DisposableContext } from '../utils/disposableContext';
import { getAllOpenMojoFiles, WorkspaceAwareFile } from '../utils/files';
import { activatePickProcessToAttachCommand } from './attachQuickPick';
import { initializeInlineLocalVariablesProvider } from './inlineVariables';
import { MAXSDK } from '../sdk/sdk';
import { MojoExtension } from '../extension';
import { MAXSDKManager } from '../sdk/sdkManager';
import { quote } from 'shell-quote';
import * as util from 'util';
import { execFile as execFileBase } from 'child_process';
import { Optional } from '../types';
import { PythonEnvironmentManager, SDK, SDKKind } from '../pyenv';
import { Logger } from '../logging';
const execFile = util.promisify(execFileBase);

/**
Expand Down Expand Up @@ -76,12 +76,15 @@ const DEBUG_TYPE: string = 'mojo-lldb';
*/
async function findSDKForDebugConfiguration(
config: MojoDebugConfiguration,
sdkManager: MAXSDKManager,
): Promise<Optional<MAXSDK>> {
envManager: PythonEnvironmentManager,
): Promise<Optional<SDK>> {
if (config.modularHomePath !== undefined) {
return sdkManager.createAdHocSDKAndShowError(config.modularHomePath);
return envManager.createSDKFromHomePath(
SDKKind.Custom,
config.modularHomePath,
);
}
return sdkManager.findSDK(/*hideRepeatedErrors=*/ false);
return envManager.getActiveSDK();
}
/**
* This class defines a factory used to find the lldb-vscode binary to use
Expand All @@ -90,10 +93,12 @@ async function findSDKForDebugConfiguration(
class MojoDebugAdapterDescriptorFactory
implements vscode.DebugAdapterDescriptorFactory
{
private sdkManager: MAXSDKManager;
private envManager: PythonEnvironmentManager;
private logger: Logger;

constructor(sdkManager: MAXSDKManager) {
this.sdkManager = sdkManager;
constructor(envManager: PythonEnvironmentManager, logger: Logger) {
this.envManager = envManager;
this.logger = logger;
}

async createDebugAdapterDescriptor(
Expand All @@ -102,54 +107,47 @@ class MojoDebugAdapterDescriptorFactory
): Promise<Optional<vscode.DebugAdapterDescriptor>> {
const sdk = await findSDKForDebugConfiguration(
session.configuration,
this.sdkManager,
this.envManager,
);

// We don't need to show error messages here because
// `findSDKConfigForDebugSession` does that.
if (!sdk) {
this.sdkManager.logger.error(
"Couldn't find an SDK for the debug session",
);
this.logger.error("Couldn't find an SDK for the debug session");
return undefined;
}
this.sdkManager.logger.info(
`Using the SDK ${sdk.config.version.toString()} for the debug session`,
);
if (sdk.config.modularHomePath.endsWith('.derived')) {
this.logger.info(`Using the SDK ${sdk.version} for the debug session`);
if (sdk.homePath.endsWith('.derived')) {
// Debug adapters from dev sdks tend to be corrupted because dependencies
// might need to be rebuilt, so we run a simple verification.
try {
await execFile(sdk.config.mojoLLDBVSCodePath, ['--help']);
await execFile(sdk.dapPath, ['--help']);
} catch (ex: any) {
const { stderr, stdout } = ex;
this.sdkManager.logger.main.outputChannel.appendLine(
this.logger.main.outputChannel.appendLine(
'\n\n\n===== LLDB Debug Adapter verification =====',
);
this.sdkManager.logger.error(
'Unable to execute the LLDB Debug Adapter.',
ex,
);
this.logger.error('Unable to execute the LLDB Debug Adapter.', ex);
if (stdout) {
this.sdkManager.logger.info('stdout: ' + stdout);
this.logger.info('stdout: ' + stdout);
}
if (stderr) {
this.sdkManager.logger.info('stderr: ' + stderr);
this.logger.info('stderr: ' + stderr);
}
this.sdkManager.logger.main.outputChannel.show();
this.logger.main.outputChannel.show();

this.sdkManager.showBazelwRunInstallPrompt(
'The LLDB Debug Adapter seems to be corrupted.',
sdk.config.modularHomePath,
);
// this.envManager.showBazelwRunInstallPrompt(
// 'The LLDB Debug Adapter seems to be corrupted.',
// sdk.homePath,
// );
Comment on lines +139 to +142
Copy link

@mckaydavis mckaydavis Jul 15, 2025

Choose a reason for hiding this comment

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

Why is this commented out but not removed?
If this is not released to users yet, I recommend either re-enabling it.
(or just removing it)

}
}

return new vscode.DebugAdapterExecutable(sdk.config.mojoLLDBVSCodePath, [
return new vscode.DebugAdapterExecutable(sdk.dapPath, [
'--repl-mode',
'variable',
'--pre-init-command',
`?!plugin load '${sdk.config.mojoLLDBPluginPath}'`,
`?!plugin load '${sdk.lldbPluginPath}'`,
]);
}
}
Expand Down Expand Up @@ -178,10 +176,12 @@ class MojoCudaGdbDebugAdapterDescriptorFactory
class MojoDebugConfigurationResolver
implements vscode.DebugConfigurationProvider
{
private sdkManager: MAXSDKManager;
private envManager: PythonEnvironmentManager;
private logger: Logger;

constructor(sdkManager: MAXSDKManager) {
this.sdkManager = sdkManager;
constructor(envManager: PythonEnvironmentManager, logger: Logger) {
this.envManager = envManager;
this.logger = logger;
}

async resolveDebugConfigurationWithSubstitutedVariables?(
Expand All @@ -191,7 +191,7 @@ class MojoDebugConfigurationResolver
): Promise<undefined | vscode.DebugConfiguration> {
const sdk = await findSDKForDebugConfiguration(
debugConfiguration,
this.sdkManager,
this.envManager,
);
// We don't need to show error messages here because
// `findSDKConfigForDebugSession` does that.
Expand All @@ -211,7 +211,7 @@ class MojoDebugConfigurationResolver
const message = `Mojo Debug error: the file '${
debugConfiguration.mojoFile
}' doesn't have the .🔥 or .mojo extension.`;
this.sdkManager.logger.error(message);
this.logger.error(message);
vscode.window.showErrorMessage(message);
return undefined;
}
Expand All @@ -224,7 +224,7 @@ class MojoDebugConfigurationResolver
debugConfiguration.mojoFile,
...(debugConfiguration.args || []),
];
debugConfiguration.program = sdk.config.mojoDriverPath;
debugConfiguration.program = sdk.mojoPath;
}

// We give preference to the init commands specified by the user.
Expand Down Expand Up @@ -277,7 +277,7 @@ class MojoDebugConfigurationResolver

// Pull in the additional visualizers within the lldb-visualizers dir.
if (await sdk.lldbHasPythonScriptingSupport()) {
const visualizersDir = sdk.config.mojoLLDBVisualizersPath;
const visualizersDir = sdk.visualizersPath;
const visualizers = await vscode.workspace.fs.readDirectory(
vscode.Uri.file(visualizersDir),
);
Expand All @@ -291,7 +291,7 @@ class MojoDebugConfigurationResolver
`LLDB_VSCODE_RIT_TIMEOUT_IN_MS=${initializationTimeoutSec * 1000}`, // runInTerminal initialization timeout.
];

env.push(`MODULAR_HOME=${sdk.config.modularHomePath}`);
env.push(`MODULAR_HOME=${sdk.homePath}`);

debugConfiguration.env = [...env, ...(debugConfiguration.env || [])];
return debugConfiguration as vscode.DebugConfiguration;
Expand Down Expand Up @@ -324,18 +324,20 @@ class MojoDebugConfigurationResolver
class MojoCudaGdbDebugConfigurationResolver
implements vscode.DebugConfigurationProvider
{
private sdkManager: MAXSDKManager;
private envManager: PythonEnvironmentManager;
private logger: Logger;

constructor(sdkManager: MAXSDKManager) {
this.sdkManager = sdkManager;
constructor(envManager: PythonEnvironmentManager, logger: Logger) {
this.envManager = envManager;
this.logger = logger;
}

async resolveDebugConfigurationWithSubstitutedVariables?(
_folder: Optional<vscode.WorkspaceFolder>,
debugConfigIn: MojoCudaGdbDebugConfiguration,
_token?: vscode.CancellationToken,
): Promise<undefined | vscode.DebugConfiguration> {
const maybeErrorMessage = await checkNsightInstall(this.sdkManager.logger);
const maybeErrorMessage = await checkNsightInstall(this.logger);
if (maybeErrorMessage) {
return undefined;
}
Expand All @@ -346,7 +348,7 @@ class MojoCudaGdbDebugConfigurationResolver

const sdk = await findSDKForDebugConfiguration(
debugConfigIn as vscode.DebugConfiguration,
this.sdkManager,
this.envManager,
);
// We don't need to show error messages here because
// `findSDKConfigForDebugSession` does that.
Expand All @@ -355,7 +357,7 @@ class MojoCudaGdbDebugConfigurationResolver
}
// If we have a mojoFile config, translate it to program plus args.
if (debugConfigIn.mojoFile) {
debugConfig.program = sdk.config.mojoDriverPath;
debugConfig.program = sdk.mojoPath;
args = [
'run',
'--no-optimization',
Expand All @@ -376,7 +378,7 @@ class MojoCudaGdbDebugConfigurationResolver
// cuda-gdb takes environment as a list of objects like:
// [{"name": "HOME", "value": "/home/ubuntu"}]
let env = [];
env.push(`MODULAR_HOME=${sdk.config.modularHomePath}`);
env.push(`MODULAR_HOME=${sdk.homePath}`);
env = [...env, ...(debugConfigIn.env || [])];
debugConfig.environment = env.map((envStr: string) => {
const split = envStr.split('=');
Expand Down Expand Up @@ -423,17 +425,20 @@ class MojoDebugDynamicConfigurationProvider
* mojo debugging.
*/
export class MojoDebugManager extends DisposableContext {
private sdkManager: MAXSDKManager;
private envManager: PythonEnvironmentManager;

constructor(extension: MojoExtension, sdkManager: MAXSDKManager) {
constructor(extension: MojoExtension, envManager: PythonEnvironmentManager) {
super();
this.sdkManager = sdkManager;
this.envManager = envManager;

// Register the lldb-vscode debug adapter.
this.pushSubscription(
vscode.debug.registerDebugAdapterDescriptorFactory(
DEBUG_TYPE,
new MojoDebugAdapterDescriptorFactory(this.sdkManager),
new MojoDebugAdapterDescriptorFactory(
this.envManager,
extension.logger,
),
),
);

Expand All @@ -457,7 +462,7 @@ export class MojoDebugManager extends DisposableContext {
this.pushSubscription(
vscode.debug.registerDebugConfigurationProvider(
DEBUG_TYPE,
new MojoDebugConfigurationResolver(sdkManager),
new MojoDebugConfigurationResolver(envManager, extension.logger),
),
);

Expand Down Expand Up @@ -498,7 +503,7 @@ export class MojoDebugManager extends DisposableContext {
this.pushSubscription(
vscode.debug.registerDebugConfigurationProvider(
'mojo-cuda-gdb',
new MojoCudaGdbDebugConfigurationResolver(sdkManager),
new MojoCudaGdbDebugConfigurationResolver(envManager, extension.logger),
),
);
}
Expand Down
Loading
Loading