use debug config provider for non workspace debugging

Author: DonJayamanne

package.json

@@ -23,7 +23,7 @@
  "theme": "dark"
  },
  "engines": {
- "vscode": "^1.9.0"
+ "vscode": "^1.17.0"
  },
  "recommendations": [
  "donjayamanne.jupyter"
@@ -46,7 +46,6 @@
  "activationEvents": [
  "onDebug",
  "onLanguage:python",
- "onCommand:python.python-debug.startSession",
  "onCommand:python.execInTerminal",
  "onCommand:python.sortImports",
  "onCommand:python.runtests",
@@ -279,7 +278,6 @@
  "languages": [
  "python"
  ],
- "startSessionCommand": "python.python-debug.startSession",
  "enableBreakpointsFor": {
  "languageIds": [
  "python",

src/client/debugger/configProviders/simpleProvider.ts

@@ -0,0 +1,66 @@
+import * as path from 'path';
+import { PythonSettings } from '../../common/configSettings';
+import { CancellationToken, DebugConfiguration, DebugConfigurationProvider, ProviderResult, Uri, window, workspace, WorkspaceFolder } from 'vscode';
+
+type PythonDebugConfiguration = DebugConfiguration & {
+ stopOnEntry?: boolean,
+ pythonPath?: string,
+ program?: string,
+ cwd?: string,
+ env?: object,
+ envFile?: string,
+ debugOptions?: string[]
+};
+
+export class SimpleConfigurationProvider implements DebugConfigurationProvider {
+ private getProgram(config: PythonDebugConfiguration): string | undefined {
+ const editor = window.activeTextEditor;
+ if (editor && editor.document.languageId === 'python') {
+ return editor.document.fileName;
+ }
+ return undefined;
+ }
+ private getWorkspaceFolder(config: PythonDebugConfiguration): string | undefined {
+ const program = this.getProgram(config);
+ if (!Array.isArray(workspace.workspaceFolders) || workspace.workspaceFolders.length === 0) {
+ return program ? path.dirname(program) : undefined;
+ }
+ if (workspace.workspaceFolders.length === 1) {
+ return workspace.workspaceFolders[0].uri.fsPath;
+ }
+ if (program) {
+ const workspaceFolder = workspace.getWorkspaceFolder(Uri.file(program));
+ if (workspaceFolder) {
+ return workspaceFolder.uri.fsPath;
+ }
+ }
+
+ return undefined;
+ }
+ resolveDebugConfiguration(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration> {
+ if (Object.keys(debugConfiguration).length > 0) {
+ return debugConfiguration;
+ }
+
+ const config = debugConfiguration as PythonDebugConfiguration;
+ const defaultProgram = this.getProgram(config);
+ const workspaceFolder = this.getWorkspaceFolder(config);
+ const envFile = workspaceFolder ? path.join(workspaceFolder, '.env') : undefined;
+ return {
+ name: 'Launch',
+ type: 'python',
+ request: 'launch',
+ stopOnEntry: true,
+ pythonPath: PythonSettings.getInstance().pythonPath,
+ program: defaultProgram,
+ cwd: workspaceFolder,
+ envFile,
+ env: {},
+ debugOptions: [
+ 'WaitOnAbnormalExit',
+ 'WaitOnNormalExit',
+ 'RedirectOutput'
+ ]
+ };
+ }
+}

src/client/debugger/index.ts

@@ -0,0 +1 @@
+export * from './configProviders/simpleProvider';

src/client/extension.ts

@@ -28,11 +28,11 @@ import { WorkspaceSymbols } from './workspaceSymbols/main';
 import { BlockFormatProviders } from './typeFormatters/blockFormatProvider';
 import * as os from 'os';
 import * as fs from 'fs';
-import { activateSingleFileDebug } from './singleFileDebug';
 import { getPathFromPythonCommand } from './common/utils';
 import { JupyterProvider } from './jupyter/provider';
 import { activateGoToObjectDefinitionProvider } from './providers/objectDefinitionProvider';
 import { InterpreterManager } from './interpreter';
+import { SimpleConfigurationProvider } from './debugger';
 
 const PYTHON: vscode.DocumentFilter = { language: 'python' };
 let unitTestOutChannel: vscode.OutputChannel;
@@ -152,7 +152,7 @@ export async function activate(context: vscode.ExtensionContext) {
  const hepProvider = new HelpProvider();
  context.subscriptions.push(hepProvider);
 
- context.subscriptions.push(activateSingleFileDebug());
+ context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider('python', new SimpleConfigurationProvider()));
 }
 
 class PythonExt implements vscode.Disposable {

src/client/singleFileDebug.ts

@@ -114,7 +114,7 @@ suite('Autocomplete', () => {
  const position = new vscode.Position(10, 9);
  const list = await vscode.commands.executeCommand<vscode.CompletionList>('vscode.executeCompletionItemProvider', textDocument.uri, position);
  assert.notEqual(list.items.filter(item => item.label === 'sleep').length, 0, 'sleep not found');
- assert.notEqual(list.items.filter(item => item.documentation.startsWith("Delay execution for a given number of seconds. The argument may be")).length, 0, 'Documentation incorrect');
+ assert.notEqual(list.items.filter(item => item.documentation.toString().startsWith("Delay execution for a given number of seconds. The argument may be")).length, 0, 'Documentation incorrect');
  });
 
  test('For custom class', done => {