Use a python script to launch the debugger (microsoft#2554)

* Use a python script to launch the debugger

Author: DonJayamanne

news/2 Fixes/2509.md

@@ -0,0 +1 @@
+Use a python script to launch the debugger, instead of using `-m` which requires changes to the `PYTHONPATH` variable.

pythonFiles/experimental/ptvsd_launcher.py

@@ -0,0 +1,118 @@
+# Python Tools for Visual Studio
+# Copyright(c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the License); you may not use
+# this file except in compliance with the License. You may obtain a copy of the
+# License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS
+# OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+# MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+# Source Copied from https://github.com/Microsoft/PTVS/blob/master/Python/Product/PythonTools/ptvsd_launcher.py
+"""
+Starts Debugging, expected to start with normal program
+to start as first argument and directory to run from as
+the second argument.
+"""
+
+__author__ = "Microsoft Corporation <ptvshelp@microsoft.com>"
+__version__ = "3.2.0.0"
+
+import os
+import os.path
+import sys
+import traceback
+
+# Arguments are:
+# 1. VS debugger port to connect to.
+# 2. '-g' to use the installed ptvsd package, rather than bundled one.
+# 3. '--nodebug' to launch without debugging.
+# 4. '-m' or '-c' to override the default run-as mode. [optional]
+# 5. Startup script name.
+# 6. Script arguments.
+
+port_num = int(sys.argv[1])
+del sys.argv[0:2]
+
+# Use bundled ptvsd or not?
+bundled_ptvsd = True
+if sys.argv and sys.argv[0] == '-g':
+ bundled_ptvsd = False
+ del sys.argv[0]
+
+# Use bundled ptvsd or not?
+no_debug = False
+if sys.argv and sys.argv[0] == '--nodebug':
+ no_debug = True
+ del sys.argv[0]
+
+# set run_as mode appropriately
+run_as = 'script'
+if sys.argv and sys.argv[0] == '-m':
+ run_as = 'module'
+ del sys.argv[0]
+if sys.argv and sys.argv[0] == '-c':
+ run_as = 'code'
+ del sys.argv[0]
+
+# preserve filename before we del sys
+filename = sys.argv[0]
+
+# fix sys.path to be the script file dir
+sys.path[0] = ''
+
+if not bundled_ptvsd and (sys.platform == 'cli' or sys.version_info < (2, 7) or
+ (sys.version_info >= (3, 0) and sys.version_info < (3, 4))):
+ # This is experimental debugger incompatibility. Exit immediately.
+ # This process will be killed by VS since it does not see a debugger
+ # connect to it. The exit code we will get there will be wrong.
+ # 687: ERROR_DLL_MIGHT_BE_INCOMPATIBLE
+ sys.exit(687)
+
+# Load the debugger package
+try:
+ ptvs_lib_path = None
+ if bundled_ptvsd:
+ ptvs_lib_path = os.path.join(os.path.dirname(__file__), 'ptvsd')
+ sys.path.insert(0, ptvs_lib_path)
+ try:
+ import ptvsd
+ import ptvsd.debugger as vspd
+ ptvsd_loaded = True
+ except ImportError:
+ ptvsd_loaded = False
+ raise
+ vspd.DONT_DEBUG.append(os.path.normcase(__file__))
+except:
+ traceback.print_exc()
+ if not bundled_ptvsd and not ptvsd_loaded:
+ # This is experimental debugger import error. Exit immediately.
+ # This process will be killed by VS since it does not see a debugger
+ # connect to it. The exit code we will get there will be wrong.
+ # 126 : ERROR_MOD_NOT_FOUND
+ sys.exit(126)
+ print('''
+Internal error detected. Please copy the above traceback and report at
+https://github.com/Microsoft/vscode-python/issues/new
+
+Press Enter to close. . .''')
+ try:
+ raw_input()
+ except NameError:
+ input()
+ sys.exit(1)
+finally:
+ if ptvs_lib_path:
+ sys.path.remove(ptvs_lib_path)
+
+if no_debug:
+ vspd.run(filename, port_num, run_as, *sys.argv[1:])
+else:
+ # and start debugging
+ vspd.debug(filename, port_num, '', '', run_as)

src/client/debugger/DebugClients/LocalDebugClient.ts

@@ -8,7 +8,6 @@ import { PathUtils } from '../../common/platform/pathUtils';
 import { CurrentProcess } from '../../common/process/currentProcess';
 import { EnvironmentVariablesService } from '../../common/variables/environment';
 import { IServiceContainer } from '../../ioc/types';
-import { PTVSD_PATH } from '../Common/constants';
 import { DebugOptions, IDebugServer, IPythonProcess, LaunchRequestArguments } from '../Common/Contracts';
 import { IS_WINDOWS } from '../Common/Utils';
 import { BaseDebugServer } from '../DebugServers/BaseDebugServer';
@@ -44,8 +43,7 @@ export class LocalDebugClient extends DebugClient<LaunchRequestArguments> {
  }
  return DebugServerStatus.Unknown;
  }
- // tslint:disable-next-line:no-any
- constructor(args: LaunchRequestArguments, debugSession: DebugSession, private canLaunchTerminal: boolean, private launcherScriptProvider: IDebugLauncherScriptProvider) {
+ constructor(args: LaunchRequestArguments, debugSession: DebugSession, private canLaunchTerminal: boolean, protected launcherScriptProvider: IDebugLauncherScriptProvider) {
  super(args, debugSession);
  }
 
@@ -82,8 +80,6 @@ export class LocalDebugClient extends DebugClient<LaunchRequestArguments> {
  const environmentVariablesService = new EnvironmentVariablesService(pathUtils);
  const helper = new DebugClientHelper(environmentVariablesService, pathUtils, currentProcess);
  const environmentVariables = await helper.getEnvironmentVariables(this.args);
- // Import the PTVSD debugger, allowing users to use their own latest copies.
- environmentVariablesService.appendPythonPath(environmentVariables, PTVSD_PATH);
  // tslint:disable-next-line:max-func-body-length cyclomatic-complexity no-any
  return new Promise<any>((resolve, reject) => {
  const fileDir = this.args && this.args.program ? path.dirname(this.args.program) : '';

src/client/debugger/DebugClients/launcherProvider.ts

@@ -6,16 +6,17 @@
 // tslint:disable:max-classes-per-file
 
 import * as path from 'path';
+import { EXTENSION_ROOT_DIR } from '../../common/constants';
 import { IDebugLauncherScriptProvider } from '../types';
 
 export class NoDebugLauncherScriptProvider implements IDebugLauncherScriptProvider {
  public getLauncherFilePath(): string {
- return path.join(path.dirname(__dirname), '..', '..', '..', 'pythonFiles', 'PythonTools', 'visualstudio_py_launcher_nodebug.py');
+ return path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'experimental', 'ptvsd_launcher.py');
  }
 }
 
 export class DebuggerLauncherScriptProvider implements IDebugLauncherScriptProvider {
  public getLauncherFilePath(): string {
- return path.join(path.dirname(__dirname), '..', '..', '..', 'pythonFiles', 'PythonTools', 'visualstudio_py_launcher.py');
+ return path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'experimental', 'ptvsd_launcher.py');
  }
 }

src/client/debugger/DebugClients/localDebugClientV2.ts

@@ -13,8 +13,9 @@ export class LocalDebugClientV2 extends LocalDebugClient {
  super(args, debugSession, canLaunchTerminal, launcherScriptProvider);
  }
  protected buildDebugArguments(cwd: string, debugPort: number): string[] {
+ const launcher = this.launcherScriptProvider.getLauncherFilePath();
  const noDebugArg = this.args.noDebug ? ['--nodebug'] : [];
- return ['-m', 'ptvsd', ...noDebugArg, '--host', 'localhost', '--port', debugPort.toString()];
+ return [launcher, debugPort.toString(), ...noDebugArg];
  }
  protected buildStandardArguments() {
  const programArgs = Array.isArray(this.args.args) && this.args.args.length > 0 ? this.args.args : [];

src/test/debugger/launcherScriptProvider.test.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { expect } from 'chai';
+import * as path from 'path';
+import { EXTENSION_ROOT_DIR } from '../../client/common/constants';
+import { DebuggerLauncherScriptProvider, NoDebugLauncherScriptProvider } from '../../client/debugger/DebugClients/launcherProvider';
+
+suite('Debugger - Launcher Script Provider', () => {
+ test('Ensure debugger gets the launcher from PythonTools directory', () => {
+ const launcherPath = new DebuggerLauncherScriptProvider().getLauncherFilePath();
+ const expectedPath = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'experimental', 'ptvsd_launcher.py');
+ expect(launcherPath).to.be.equal(expectedPath);
+ });
+ test('Ensure debugger gets the non debug launcher from PythonTools directory', () => {
+ const launcherPath = new NoDebugLauncherScriptProvider().getLauncherFilePath();
+ const expectedPath = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'experimental', 'ptvsd_launcher.py');
+ expect(launcherPath).to.be.equal(expectedPath);
+ });
+});