Skip to content

Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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
Rich Chiodo (rchiodo) merged 5 commits into from
Dec 9, 2025
Merged

Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy #886

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
2ca0565
Add terminalQuoteCharacter as an option
rchiodo Dec 9, 2025
70d3367
Add unit tests
rchiodo Dec 9, 2025
6622657
Merge branch 'main' into rchiodo/fixSpaces
rchiodo Dec 9, 2025
1c78e3b
Fix other launch unit tests
rchiodo Dec 9, 2025
bbf50f0
Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…
rchiodo Dec 9, 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
2 changes: 1 addition & 1 deletion contributing.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.
```

## Reporting Issues
Expand Down
36 changes: 36 additions & 0 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
"description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
"type": "boolean"
},
"terminalQuoteCharacter": {
"default": null,
"description": "The quoting character to be used by the debugger when quoting terminal commands.",
"type": [
"string",
"null"
],
"enum": [
"\"",
"'",
"`"
],
"enumDescriptions": [
"Double quote (\")",
"Single quote (')",
"Backtick (`)"
]
},
"pathMappings": {
"default": [],
"items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
"description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
"type": "boolean"
},
"terminalQuoteCharacter": {
"default": null,
"description": "The quoting character to be used by the debugger when quoting terminal commands.",
"type": [
"string",
"null"
],
"enum": [
"\"",
"'",
"`"
],
"enumDescriptions": [
"Double quote (\")",
"Single quote (')",
"Backtick (`)"
]
},
"module": {
"default": "",
"description": "Name of the module to be debugged.",
Expand Down
49 changes: 49 additions & 0 deletions src/extension/debugger/configuration/resolvers/launch.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
debugConfiguration.internalConsoleOptions = 'neverOpen';
}

// Compute the terminal quoting character.
if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
const quoteChar = this._computeTerminalQuoteCharacter();
debugConfiguration.terminalQuoteCharacter = quoteChar;
}

if (!Array.isArray(debugConfiguration.debugOptions)) {
debugConfiguration.debugOptions = [];
}
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
: 'launch';
LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
}

private _computeTerminalQuoteCharacter(): string {
const platform = process.platform; // 'win32', 'linux', 'darwin'
const config = getConfiguration('terminal');

let defaultProfile: string | undefined;
let profiles: any;

if (platform === 'win32') {
defaultProfile = config.get<string>('integrated.defaultProfile.windows');
profiles = config.get<any>('integrated.profiles.windows');
} else if (platform === 'linux') {
defaultProfile = config.get<string>('integrated.defaultProfile.linux');
profiles = config.get<any>('integrated.profiles.linux');
} else if (platform === 'darwin') {
defaultProfile = config.get<string>('integrated.defaultProfile.osx');
profiles = config.get<any>('integrated.profiles.osx');
}

if (!defaultProfile || !profiles) {
if (platform === 'win32') {
return "'"; // Default is powershell
} else {
return '"'; // Default is bash/zsh
}
}

const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
const shellPath = profile?.path || '';

if (/powershell|pwsh/i.test(shellPath)) {
return "'";
}
if (/cmd\.exe$/i.test(shellPath)) {
return '"';
}
if (/bash|zsh|fish/i.test(shellPath)) {
return '"';
}

return '"';
}
}
232 changes: 232 additions & 0 deletions src/test/unittest/configuration/resolvers/launch.unit.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
// Mock python configuration for useEnvExtension check
const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
getConfigurationStub.withArgs('python').returns(pythonConfig.object);
// Mock terminal configuration with default values
const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
});

teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
});
});

suite('terminalQuoteCharacter tests', () => {
let platformStub: sinon.SinonStub;

function setupTerminalProfile(
profile: string | undefined,
path: string = 'bash',
platform: NodeJS.Platform = 'linux',
) {
const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

// Mock process.platform
if (platformStub) {
platformStub.restore();
}
platformStub = sinon.stub(process, 'platform').value(platform);

if (platform === 'win32') {
terminalConfig
.setup((c) => c.get<string>('integrated.defaultProfile.windows'))
.returns(() => profile);
const profiles: any = {};
if (profile) {
profiles[profile] = { path };
}
terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
} else if (platform === 'linux') {
terminalConfig
.setup((c) => c.get<string>('integrated.defaultProfile.linux'))
.returns(() => profile);
const profiles: any = {};
if (profile) {
profiles[profile] = { path };
}
terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
} else if (platform === 'darwin') {
terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
const profiles: any = {};
if (profile) {
profiles[profile] = { path };
}
terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
}

getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
}

test('Default terminalQuoteCharacter is computed for bash shell', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('Bash', '/bin/bash', 'linux');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
});

test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
});

test('Default terminalQuoteCharacter is computed for fish shell', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
});

test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile(
'PowerShell',
'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
'win32',
);

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
});

test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
});

test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile(undefined, 'bash', 'linux');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
});

test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('Bash', '/bin/bash', 'linux');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
terminalQuoteCharacter: "'",
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
});

test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
terminalQuoteCharacter: '',
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
});

test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('Bash', '/bin/bash', 'linux');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
terminalQuoteCharacter: '""',
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
});

test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
});

test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath, workspaceFolder);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
setupTerminalProfile(
'PowerShell',
'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
'win32',
);

const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
});

expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
});
});
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy by rchiodo · Pull Request #886 · microsoft/vscode-python-debugger · GitHub
Skip to content
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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

Rich Chiodo (rchiodo)
merged 5 commits into

from

Dec 9, 2025
 Merged


Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy
#886
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
2ca0565

Add terminalQuoteCharacter as an option


rchiodo Dec 9, 2025
70d3367

Add unit tests


rchiodo Dec 9, 2025
6622657

Merge branch 'main' into rchiodo/fixSpaces


rchiodo Dec 9, 2025
1c78e3b

Fix other launch unit tests


rchiodo Dec 9, 2025
bbf50f0

Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…


rchiodo Dec 9, 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


2 changes: 1 addition & 1 deletion
contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.

```

## Reporting Issues
Expand Down

36 changes: 36 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "pathMappings": {
 "default": [],
 "items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "module": {
 "default": "",
 "description": "Name of the module to be debugged.",
Expand Down

49 changes: 49 additions & 0 deletions
src/extension/debugger/configuration/resolvers/launch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
 debugConfiguration.internalConsoleOptions = 'neverOpen';
 }

 // Compute the terminal quoting character.
 if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
 const quoteChar = this._computeTerminalQuoteCharacter();
 debugConfiguration.terminalQuoteCharacter = quoteChar;
 }

 if (!Array.isArray(debugConfiguration.debugOptions)) {
 debugConfiguration.debugOptions = [];
 }
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 : 'launch';
 LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
 }

 private _computeTerminalQuoteCharacter(): string {
 const platform = process.platform; // 'win32', 'linux', 'darwin'
 const config = getConfiguration('terminal');

 let defaultProfile: string | undefined;
 let profiles: any;

 if (platform === 'win32') {
 defaultProfile = config.get<string>('integrated.defaultProfile.windows');
 profiles = config.get<any>('integrated.profiles.windows');
 } else if (platform === 'linux') {
 defaultProfile = config.get<string>('integrated.defaultProfile.linux');
 profiles = config.get<any>('integrated.profiles.linux');
 } else if (platform === 'darwin') {
 defaultProfile = config.get<string>('integrated.defaultProfile.osx');
 profiles = config.get<any>('integrated.profiles.osx');
 }

 if (!defaultProfile || !profiles) {
 if (platform === 'win32') {
 return "'"; // Default is powershell
 } else {
 return '"'; // Default is bash/zsh
 }
 }

 const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
 const shellPath = profile?.path || '';

 if (/powershell|pwsh/i.test(shellPath)) {
 return "'";
 }
 if (/cmd\.exe$/i.test(shellPath)) {
 return '"';
 }
 if (/bash|zsh|fish/i.test(shellPath)) {
 return '"';
 }

 return '"';
 }
}

232 changes: 232 additions & 0 deletions
src/test/unittest/configuration/resolvers/launch.unit.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
 getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
 getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
 // Mock python configuration for useEnvExtension check
 const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
 getConfigurationStub.withArgs('python').returns(pythonConfig.object);
 // Mock terminal configuration with default values
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
 terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 });

 teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
 });
 });

 suite('terminalQuoteCharacter tests', () => {
 let platformStub: sinon.SinonStub;

 function setupTerminalProfile(
 profile: string | undefined,
 path: string = 'bash',
 platform: NodeJS.Platform = 'linux',
 ) {
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

 // Mock process.platform
 if (platformStub) {
 platformStub.restore();
 }
 platformStub = sinon.stub(process, 'platform').value(platform);

 if (platform === 'win32') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.windows'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
 } else if (platform === 'linux') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.linux'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
 } else if (platform === 'darwin') {
 terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
 }

 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 }

 test('Default terminalQuoteCharacter is computed for bash shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for fish shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(undefined, 'bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: "'",
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '""',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy by rchiodo · Pull Request #886 · microsoft/vscode-python-debugger · GitHub
Skip to content
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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

Rich Chiodo (rchiodo)
merged 5 commits into

from

Dec 9, 2025
 Merged


Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy
#886
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
2ca0565

Add terminalQuoteCharacter as an option


rchiodo Dec 9, 2025
70d3367

Add unit tests


rchiodo Dec 9, 2025
6622657

Merge branch 'main' into rchiodo/fixSpaces


rchiodo Dec 9, 2025
1c78e3b

Fix other launch unit tests


rchiodo Dec 9, 2025
bbf50f0

Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…


rchiodo Dec 9, 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


2 changes: 1 addition & 1 deletion
contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.

```

## Reporting Issues
Expand Down

36 changes: 36 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "pathMappings": {
 "default": [],
 "items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "module": {
 "default": "",
 "description": "Name of the module to be debugged.",
Expand Down

49 changes: 49 additions & 0 deletions
src/extension/debugger/configuration/resolvers/launch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
 debugConfiguration.internalConsoleOptions = 'neverOpen';
 }

 // Compute the terminal quoting character.
 if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
 const quoteChar = this._computeTerminalQuoteCharacter();
 debugConfiguration.terminalQuoteCharacter = quoteChar;
 }

 if (!Array.isArray(debugConfiguration.debugOptions)) {
 debugConfiguration.debugOptions = [];
 }
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 : 'launch';
 LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
 }

 private _computeTerminalQuoteCharacter(): string {
 const platform = process.platform; // 'win32', 'linux', 'darwin'
 const config = getConfiguration('terminal');

 let defaultProfile: string | undefined;
 let profiles: any;

 if (platform === 'win32') {
 defaultProfile = config.get<string>('integrated.defaultProfile.windows');
 profiles = config.get<any>('integrated.profiles.windows');
 } else if (platform === 'linux') {
 defaultProfile = config.get<string>('integrated.defaultProfile.linux');
 profiles = config.get<any>('integrated.profiles.linux');
 } else if (platform === 'darwin') {
 defaultProfile = config.get<string>('integrated.defaultProfile.osx');
 profiles = config.get<any>('integrated.profiles.osx');
 }

 if (!defaultProfile || !profiles) {
 if (platform === 'win32') {
 return "'"; // Default is powershell
 } else {
 return '"'; // Default is bash/zsh
 }
 }

 const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
 const shellPath = profile?.path || '';

 if (/powershell|pwsh/i.test(shellPath)) {
 return "'";
 }
 if (/cmd\.exe$/i.test(shellPath)) {
 return '"';
 }
 if (/bash|zsh|fish/i.test(shellPath)) {
 return '"';
 }

 return '"';
 }
}

232 changes: 232 additions & 0 deletions
src/test/unittest/configuration/resolvers/launch.unit.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
 getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
 getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
 // Mock python configuration for useEnvExtension check
 const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
 getConfigurationStub.withArgs('python').returns(pythonConfig.object);
 // Mock terminal configuration with default values
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
 terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 });

 teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
 });
 });

 suite('terminalQuoteCharacter tests', () => {
 let platformStub: sinon.SinonStub;

 function setupTerminalProfile(
 profile: string | undefined,
 path: string = 'bash',
 platform: NodeJS.Platform = 'linux',
 ) {
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

 // Mock process.platform
 if (platformStub) {
 platformStub.restore();
 }
 platformStub = sinon.stub(process, 'platform').value(platform);

 if (platform === 'win32') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.windows'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
 } else if (platform === 'linux') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.linux'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
 } else if (platform === 'darwin') {
 terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
 }

 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 }

 test('Default terminalQuoteCharacter is computed for bash shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for fish shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(undefined, 'bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: "'",
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '""',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy by rchiodo · Pull Request #886 · microsoft/vscode-python-debugger · GitHub
Skip to content
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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

Rich Chiodo (rchiodo)
merged 5 commits into

from

Dec 9, 2025
 Merged


Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy
#886
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
2ca0565

Add terminalQuoteCharacter as an option


rchiodo Dec 9, 2025
70d3367

Add unit tests


rchiodo Dec 9, 2025
6622657

Merge branch 'main' into rchiodo/fixSpaces


rchiodo Dec 9, 2025
1c78e3b

Fix other launch unit tests


rchiodo Dec 9, 2025
bbf50f0

Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…


rchiodo Dec 9, 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


2 changes: 1 addition & 1 deletion
contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.

```

## Reporting Issues
Expand Down

36 changes: 36 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "pathMappings": {
 "default": [],
 "items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "module": {
 "default": "",
 "description": "Name of the module to be debugged.",
Expand Down

49 changes: 49 additions & 0 deletions
src/extension/debugger/configuration/resolvers/launch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
 debugConfiguration.internalConsoleOptions = 'neverOpen';
 }

 // Compute the terminal quoting character.
 if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
 const quoteChar = this._computeTerminalQuoteCharacter();
 debugConfiguration.terminalQuoteCharacter = quoteChar;
 }

 if (!Array.isArray(debugConfiguration.debugOptions)) {
 debugConfiguration.debugOptions = [];
 }
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 : 'launch';
 LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
 }

 private _computeTerminalQuoteCharacter(): string {
 const platform = process.platform; // 'win32', 'linux', 'darwin'
 const config = getConfiguration('terminal');

 let defaultProfile: string | undefined;
 let profiles: any;

 if (platform === 'win32') {
 defaultProfile = config.get<string>('integrated.defaultProfile.windows');
 profiles = config.get<any>('integrated.profiles.windows');
 } else if (platform === 'linux') {
 defaultProfile = config.get<string>('integrated.defaultProfile.linux');
 profiles = config.get<any>('integrated.profiles.linux');
 } else if (platform === 'darwin') {
 defaultProfile = config.get<string>('integrated.defaultProfile.osx');
 profiles = config.get<any>('integrated.profiles.osx');
 }

 if (!defaultProfile || !profiles) {
 if (platform === 'win32') {
 return "'"; // Default is powershell
 } else {
 return '"'; // Default is bash/zsh
 }
 }

 const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
 const shellPath = profile?.path || '';

 if (/powershell|pwsh/i.test(shellPath)) {
 return "'";
 }
 if (/cmd\.exe$/i.test(shellPath)) {
 return '"';
 }
 if (/bash|zsh|fish/i.test(shellPath)) {
 return '"';
 }

 return '"';
 }
}

232 changes: 232 additions & 0 deletions
src/test/unittest/configuration/resolvers/launch.unit.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
 getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
 getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
 // Mock python configuration for useEnvExtension check
 const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
 getConfigurationStub.withArgs('python').returns(pythonConfig.object);
 // Mock terminal configuration with default values
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
 terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 });

 teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
 });
 });

 suite('terminalQuoteCharacter tests', () => {
 let platformStub: sinon.SinonStub;

 function setupTerminalProfile(
 profile: string | undefined,
 path: string = 'bash',
 platform: NodeJS.Platform = 'linux',
 ) {
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

 // Mock process.platform
 if (platformStub) {
 platformStub.restore();
 }
 platformStub = sinon.stub(process, 'platform').value(platform);

 if (platform === 'win32') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.windows'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
 } else if (platform === 'linux') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.linux'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
 } else if (platform === 'darwin') {
 terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
 }

 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 }

 test('Default terminalQuoteCharacter is computed for bash shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for fish shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(undefined, 'bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: "'",
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '""',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy by rchiodo · Pull Request #886 · microsoft/vscode-python-debugger · GitHub
Skip to content
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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

Rich Chiodo (rchiodo)
merged 5 commits into

from

Dec 9, 2025
 Merged


Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy
#886
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
2ca0565

Add terminalQuoteCharacter as an option


rchiodo Dec 9, 2025
70d3367

Add unit tests


rchiodo Dec 9, 2025
6622657

Merge branch 'main' into rchiodo/fixSpaces


rchiodo Dec 9, 2025
1c78e3b

Fix other launch unit tests


rchiodo Dec 9, 2025
bbf50f0

Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…


rchiodo Dec 9, 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


2 changes: 1 addition & 1 deletion
contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.

```

## Reporting Issues
Expand Down

36 changes: 36 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "pathMappings": {
 "default": [],
 "items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "module": {
 "default": "",
 "description": "Name of the module to be debugged.",
Expand Down

49 changes: 49 additions & 0 deletions
src/extension/debugger/configuration/resolvers/launch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
 debugConfiguration.internalConsoleOptions = 'neverOpen';
 }

 // Compute the terminal quoting character.
 if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
 const quoteChar = this._computeTerminalQuoteCharacter();
 debugConfiguration.terminalQuoteCharacter = quoteChar;
 }

 if (!Array.isArray(debugConfiguration.debugOptions)) {
 debugConfiguration.debugOptions = [];
 }
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 : 'launch';
 LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
 }

 private _computeTerminalQuoteCharacter(): string {
 const platform = process.platform; // 'win32', 'linux', 'darwin'
 const config = getConfiguration('terminal');

 let defaultProfile: string | undefined;
 let profiles: any;

 if (platform === 'win32') {
 defaultProfile = config.get<string>('integrated.defaultProfile.windows');
 profiles = config.get<any>('integrated.profiles.windows');
 } else if (platform === 'linux') {
 defaultProfile = config.get<string>('integrated.defaultProfile.linux');
 profiles = config.get<any>('integrated.profiles.linux');
 } else if (platform === 'darwin') {
 defaultProfile = config.get<string>('integrated.defaultProfile.osx');
 profiles = config.get<any>('integrated.profiles.osx');
 }

 if (!defaultProfile || !profiles) {
 if (platform === 'win32') {
 return "'"; // Default is powershell
 } else {
 return '"'; // Default is bash/zsh
 }
 }

 const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
 const shellPath = profile?.path || '';

 if (/powershell|pwsh/i.test(shellPath)) {
 return "'";
 }
 if (/cmd\.exe$/i.test(shellPath)) {
 return '"';
 }
 if (/bash|zsh|fish/i.test(shellPath)) {
 return '"';
 }

 return '"';
 }
}

232 changes: 232 additions & 0 deletions
src/test/unittest/configuration/resolvers/launch.unit.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
 getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
 getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
 // Mock python configuration for useEnvExtension check
 const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
 getConfigurationStub.withArgs('python').returns(pythonConfig.object);
 // Mock terminal configuration with default values
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
 terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 });

 teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
 });
 });

 suite('terminalQuoteCharacter tests', () => {
 let platformStub: sinon.SinonStub;

 function setupTerminalProfile(
 profile: string | undefined,
 path: string = 'bash',
 platform: NodeJS.Platform = 'linux',
 ) {
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

 // Mock process.platform
 if (platformStub) {
 platformStub.restore();
 }
 platformStub = sinon.stub(process, 'platform').value(platform);

 if (platform === 'win32') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.windows'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
 } else if (platform === 'linux') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.linux'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
 } else if (platform === 'darwin') {
 terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
 }

 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 }

 test('Default terminalQuoteCharacter is computed for bash shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for fish shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(undefined, 'bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: "'",
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '""',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy by rchiodo · Pull Request #886 · microsoft/vscode-python-debugger · GitHub
Skip to content
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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

Rich Chiodo (rchiodo)
merged 5 commits into

from

Dec 9, 2025
 Merged


Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy
#886
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
2ca0565

Add terminalQuoteCharacter as an option


rchiodo Dec 9, 2025
70d3367

Add unit tests


rchiodo Dec 9, 2025
6622657

Merge branch 'main' into rchiodo/fixSpaces


rchiodo Dec 9, 2025
1c78e3b

Fix other launch unit tests


rchiodo Dec 9, 2025
bbf50f0

Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…


rchiodo Dec 9, 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


2 changes: 1 addition & 1 deletion
contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.

```

## Reporting Issues
Expand Down

36 changes: 36 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "pathMappings": {
 "default": [],
 "items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "module": {
 "default": "",
 "description": "Name of the module to be debugged.",
Expand Down

49 changes: 49 additions & 0 deletions
src/extension/debugger/configuration/resolvers/launch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
 debugConfiguration.internalConsoleOptions = 'neverOpen';
 }

 // Compute the terminal quoting character.
 if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
 const quoteChar = this._computeTerminalQuoteCharacter();
 debugConfiguration.terminalQuoteCharacter = quoteChar;
 }

 if (!Array.isArray(debugConfiguration.debugOptions)) {
 debugConfiguration.debugOptions = [];
 }
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 : 'launch';
 LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
 }

 private _computeTerminalQuoteCharacter(): string {
 const platform = process.platform; // 'win32', 'linux', 'darwin'
 const config = getConfiguration('terminal');

 let defaultProfile: string | undefined;
 let profiles: any;

 if (platform === 'win32') {
 defaultProfile = config.get<string>('integrated.defaultProfile.windows');
 profiles = config.get<any>('integrated.profiles.windows');
 } else if (platform === 'linux') {
 defaultProfile = config.get<string>('integrated.defaultProfile.linux');
 profiles = config.get<any>('integrated.profiles.linux');
 } else if (platform === 'darwin') {
 defaultProfile = config.get<string>('integrated.defaultProfile.osx');
 profiles = config.get<any>('integrated.profiles.osx');
 }

 if (!defaultProfile || !profiles) {
 if (platform === 'win32') {
 return "'"; // Default is powershell
 } else {
 return '"'; // Default is bash/zsh
 }
 }

 const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
 const shellPath = profile?.path || '';

 if (/powershell|pwsh/i.test(shellPath)) {
 return "'";
 }
 if (/cmd\.exe$/i.test(shellPath)) {
 return '"';
 }
 if (/bash|zsh|fish/i.test(shellPath)) {
 return '"';
 }

 return '"';
 }
}

232 changes: 232 additions & 0 deletions
src/test/unittest/configuration/resolvers/launch.unit.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
 getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
 getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
 // Mock python configuration for useEnvExtension check
 const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
 getConfigurationStub.withArgs('python').returns(pythonConfig.object);
 // Mock terminal configuration with default values
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
 terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 });

 teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
 });
 });

 suite('terminalQuoteCharacter tests', () => {
 let platformStub: sinon.SinonStub;

 function setupTerminalProfile(
 profile: string | undefined,
 path: string = 'bash',
 platform: NodeJS.Platform = 'linux',
 ) {
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

 // Mock process.platform
 if (platformStub) {
 platformStub.restore();
 }
 platformStub = sinon.stub(process, 'platform').value(platform);

 if (platform === 'win32') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.windows'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
 } else if (platform === 'linux') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.linux'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
 } else if (platform === 'darwin') {
 terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
 }

 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 }

 test('Default terminalQuoteCharacter is computed for bash shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for fish shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(undefined, 'bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: "'",
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '""',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });
 });
 });
});
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy by rchiodo · Pull Request #886 · microsoft/vscode-python-debugger · GitHub
Skip to content
Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy#886

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

Rich Chiodo (rchiodo)
merged 5 commits into

from

Dec 9, 2025
 Merged


Add 'terminalQuoteCharacter' to the debug configuration we send to debugpy
#886
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
2ca0565

Add terminalQuoteCharacter as an option


rchiodo Dec 9, 2025
70d3367

Add unit tests


rchiodo Dec 9, 2025
6622657

Merge branch 'main' into rchiodo/fixSpaces


rchiodo Dec 9, 2025
1c78e3b

Fix other launch unit tests


rchiodo Dec 9, 2025
bbf50f0

Merge branch 'rchiodo/fixSpaces' of https://github.com/rchiodo/vscode…


rchiodo Dec 9, 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


2 changes: 1 addition & 1 deletion
contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ source .venv/bin/activate
Install then setup with nox.
```
python3 -m pip install nox
nox --session setup_repo
nox
Comment thread
eleanorjboyd marked this conversation as resolved.

```

## Reporting Issues
Expand Down

36 changes: 36 additions & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -256,6 +256,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "pathMappings": {
 "default": [],
 "items": {
Expand DownExpand Up@@ -452,6 +470,24 @@
 "description": "Enable logging of debugger events to a log file. This file can be found in the debugpy extension install folder.",
 "type": "boolean"
 },
 "terminalQuoteCharacter": {
 "default": null,
 "description": "The quoting character to be used by the debugger when quoting terminal commands.",
 "type": [
 "string",
 "null"
 ],
 "enum": [
 "\"",
 "'",
 "`"
 ],
 "enumDescriptions": [
 "Double quote (\")",
 "Single quote (')",
 "Backtick (`)"
 ]
 },
 "module": {
 "default": "",
 "description": "Name of the module to be debugged.",
Expand Down

49 changes: 49 additions & 0 deletions
src/extension/debugger/configuration/resolvers/launch.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,6 +105,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 if (debugConfiguration.console !== 'internalConsole' && !debugConfiguration.internalConsoleOptions) {
 debugConfiguration.internalConsoleOptions = 'neverOpen';
 }

 // Compute the terminal quoting character.
 if (!debugConfiguration.terminalQuoteCharacter || debugConfiguration.terminalQuoteCharacter.length !== 1) {
 const quoteChar = this._computeTerminalQuoteCharacter();
 debugConfiguration.terminalQuoteCharacter = quoteChar;
 }

 if (!Array.isArray(debugConfiguration.debugOptions)) {
 debugConfiguration.debugOptions = [];
 }
Expand DownExpand Up@@ -182,4 +189,46 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
 : 'launch';
 LaunchConfigurationResolver.sendTelemetry(trigger, debugConfiguration);
 }

 private _computeTerminalQuoteCharacter(): string {
 const platform = process.platform; // 'win32', 'linux', 'darwin'
 const config = getConfiguration('terminal');

 let defaultProfile: string | undefined;
 let profiles: any;

 if (platform === 'win32') {
 defaultProfile = config.get<string>('integrated.defaultProfile.windows');
 profiles = config.get<any>('integrated.profiles.windows');
 } else if (platform === 'linux') {
 defaultProfile = config.get<string>('integrated.defaultProfile.linux');
 profiles = config.get<any>('integrated.profiles.linux');
 } else if (platform === 'darwin') {
 defaultProfile = config.get<string>('integrated.defaultProfile.osx');
 profiles = config.get<any>('integrated.profiles.osx');
 }

 if (!defaultProfile || !profiles) {
 if (platform === 'win32') {
 return "'"; // Default is powershell
 } else {
 return '"'; // Default is bash/zsh
 }
 }

 const profile = defaultProfile ? profiles[defaultProfile] : profiles[0];
 const shellPath = profile?.path || '';

 if (/powershell|pwsh/i.test(shellPath)) {
 return "'";
 }
 if (/cmd\.exe$/i.test(shellPath)) {
 return '"';
 }
 if (/bash|zsh|fish/i.test(shellPath)) {
 return '"';
 }

 return '"';
 }
}

232 changes: 232 additions & 0 deletions
src/test/unittest/configuration/resolvers/launch.unit.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,15 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 getDebugEnvironmentVariablesStub = sinon.stub(helper, 'getDebugEnvironmentVariables');
 getConfigurationStub = sinon.stub(vscodeapi, 'getConfiguration');
 getConfigurationStub.withArgs('debugpy', sinon.match.any).returns(createMoqConfiguration(true));
 // Mock python configuration for useEnvExtension check
 const pythonConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 pythonConfig.setup((p) => p.get<boolean>('useEnvironmentsExtension', false)).returns(() => false);
 getConfigurationStub.withArgs('python').returns(pythonConfig.object);
 // Mock terminal configuration with default values
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
 terminalConfig.setup((c) => c.get<string>(TypeMoq.It.isAnyString())).returns(() => undefined);
 terminalConfig.setup((c) => c.get<any>(TypeMoq.It.isAnyString())).returns(() => undefined);
 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 });

 teardown(() => {
Expand DownExpand Up@@ -1045,5 +1054,228 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
 await testSetting(requestType, { subProcess: true }, DebugOptions.SubProcess, true);
 });
 });

 suite('terminalQuoteCharacter tests', () => {
 let platformStub: sinon.SinonStub;

 function setupTerminalProfile(
 profile: string | undefined,
 path: string = 'bash',
 platform: NodeJS.Platform = 'linux',
 ) {
 const terminalConfig = TypeMoq.Mock.ofType<WorkspaceConfiguration>();

 // Mock process.platform
 if (platformStub) {
 platformStub.restore();
 }
 platformStub = sinon.stub(process, 'platform').value(platform);

 if (platform === 'win32') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.windows'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.windows')).returns(() => profiles);
 } else if (platform === 'linux') {
 terminalConfig
 .setup((c) => c.get<string>('integrated.defaultProfile.linux'))
 .returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.linux')).returns(() => profiles);
 } else if (platform === 'darwin') {
 terminalConfig.setup((c) => c.get<string>('integrated.defaultProfile.osx')).returns(() => profile);
 const profiles: any = {};
 if (profile) {
 profiles[profile] = { path };
 }
 terminalConfig.setup((c) => c.get<any>('integrated.profiles.osx')).returns(() => profiles);
 }

 getConfigurationStub.withArgs('terminal').returns(terminalConfig.object);
 }

 test('Default terminalQuoteCharacter is computed for bash shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for zsh shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Zsh', '/bin/zsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for fish shell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Fish', '/usr/bin/fish', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is computed for PowerShell', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Default terminalQuoteCharacter is computed for cmd.exe', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Command Prompt', 'C:\\Windows\\System32\\cmd.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('Default terminalQuoteCharacter is double quote when terminal profile is not configured', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(undefined, 'bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('User-provided terminalQuoteCharacter is preserved when valid (single character)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: "'",
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (empty string) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell', 'powershell.exe', 'win32');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('Invalid terminalQuoteCharacter (multi-character) triggers fallback to computed default', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('Bash', '/bin/bash', 'linux');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 terminalQuoteCharacter: '""',
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', '"');
 });

 test('terminalQuoteCharacter handles pwsh (PowerShell Core)', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile('PowerShell Core', '/usr/local/bin/pwsh', 'darwin');

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });

 test('terminalQuoteCharacter is case-insensitive for shell detection', async () => {
 const pythonPath = `PythonPath_${new Date().toString()}`;
 const workspaceFolder = createMoqWorkspaceFolder(__dirname);
 const pythonFile = 'xyz.py';
 setupIoc(pythonPath, workspaceFolder);
 setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
 setupTerminalProfile(
 'PowerShell',
 'C:\\WINDOWS\\System32\\WindowsPowerShell\\v1.0\\POWERSHELL.EXE',
 'win32',
 );

 const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
 ...launch,
 });

 expect(debugConfig).to.have.property('terminalQuoteCharacter', "'");
 });
 });
 });
});
Loading