Skip to content

support interpreter paths with spaces #499

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 7 commits into from
Nov 13, 2024
Merged

support interpreter paths with spaces #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5955540
support interpreter paths with spaces
eleanorjboyd Nov 6, 2024
e624120
use fileToCommandArgumentForPythonExt and add test
eleanorjboyd Nov 11, 2024
51f0770
fix unnecessary edit
eleanorjboyd Nov 11, 2024
f79e512
Merge branch 'main' into rectangular-falcon
eleanorjboyd Nov 11, 2024
fc9dc6c
switch to use path.join
eleanorjboyd Nov 12, 2024
d3f94b4
error fix
eleanorjboyd Nov 12, 2024
07026d3
fix path to match desired
eleanorjboyd Nov 12, 2024
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
4 changes: 3 additions & 1 deletion src/extension/debugger/adapter/factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { Commands, EXTENSION_ROOT_DIR } from '../../common/constants';
import { Common, DebugConfigStrings, Interpreters } from '../../common/utils/localize';
import { IPersistentStateFactory } from '../../common/types';
import { ResolvedEnvironment } from '@vscode/python-extension';
import { fileToCommandArgumentForPythonExt } from '../../common/stringUtils';

// persistent state names, exported to make use of in testing
export enum debugStateKeys {
Expand Down Expand Up @@ -76,7 +77,7 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
sendTelemetryEvent(EventName.DEBUGGER_ATTACH_TO_LOCAL_PROCESS);
}

const executable = command.shift() ?? 'python';
let executable = command.shift() ?? 'python';

// "logToFile" is not handled directly by the adapter - instead, we need to pass
// the corresponding CLI switch when spawning it.
Expand All @@ -85,6 +86,7 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
if (configuration.debugAdapterPath !== undefined) {
const args = command.concat([configuration.debugAdapterPath, ...logArgs]);
traceLog(`DAP Server launched with command: ${executable} ${args.join(' ')}`);
executable = fileToCommandArgumentForPythonExt(executable);
return new DebugAdapterExecutable(executable, args);
}

Expand Down
23 changes: 22 additions & 1 deletion src/test/unittest/adapter/factory.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ suite('Debugging - Adapter Factory', () => {

const nodeExecutable = undefined;
const debugAdapterPath = path.join(EXTENSION_ROOT_DIR, 'bundled', 'libs', 'debugpy', 'adapter');
const pythonPath = path.join('path', 'to', 'python', 'interpreter');
const pythonPath = 'path/to/python/interpreter';
const interpreter = {
architecture: Architecture.Unknown,
path: pythonPath,
Expand Down Expand Up @@ -291,6 +291,27 @@ suite('Debugging - Adapter Factory', () => {

assert.deepStrictEqual(descriptor, debugExecutable);
});
test('Add quotes to interpreter path with spaces', async () => {
const customAdapterPath = 'custom/debug/adapter/customAdapterPath';
const session = createSession({ debugAdapterPath: customAdapterPath });
const interpreterPathSpaces = 'path/to/python interpreter with spaces';
const interpreterPathSpacesQuoted = `"${interpreterPathSpaces}"`;
const debugExecutable = new DebugAdapterExecutable(interpreterPathSpacesQuoted, [customAdapterPath]);

getInterpreterDetailsStub.resolves({ path: [interpreterPathSpaces] });
const interpreterSpacePath = {
architecture: Architecture.Unknown,
path: interpreterPathSpaces,
sysPrefix: '',
sysVersion: '',
envType: 'Unknow',
version: new SemVer('3.7.4-test'),
};
resolveEnvironmentStub.withArgs(interpreterPathSpaces).resolves(interpreterSpacePath);
const descriptor = await factory.createDebugAdapterDescriptor(session, nodeExecutable);

assert.deepStrictEqual(descriptor, debugExecutable);
});

test('Use "debugAdapterPython" when specified', async () => {
const session = createSession({ debugAdapterPython: '/bin/custompy' });
Expand Down
Loading