Support debugging python 3.6 (microsoft#19559)

Author: FossenWang

pythonFiles/dispatch_debugpy/__main__.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import os
+import sys
+
+PY36 = sys.version_info < (3, 7)
+
+
+if __name__ == "__main__":
+    # Launch diffrent version of debugpy according to python version.
+    # Change `sys.path` to find debugpy package.
+    if "debugpy" not in sys.modules:
+        root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+        python_dir = "python" if not PY36 else "python36"
+        sys.path[0] = os.path.join(root, "lib", python_dir)
+
+        import debugpy  # noqa
+
+        del sys.path[0]
+
+    from debugpy.server import cli
+
+    cli.main()

pythonFiles/dispatch_debugpy/adapter/__main__.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import os
+import sys
+
+PY36 = sys.version_info < (3, 7)
+
+
+if __name__ == "__main__":
+    # Launch diffrent version of debugpy according to python version.
+    # Change `sys.path` to find debugpy package.
+    if "debugpy" not in sys.modules:
+        root = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+        python_dir = "python" if not PY36 else "python36"
+        sys.path[0] = os.path.join(root, "lib", python_dir)
+
+        import debugpy  # noqa
+
+        del sys.path[0]
+
+    from debugpy.adapter.__main__ import main, _parse_argv
+
+    main(_parse_argv(sys.argv))

pythonFiles/dispatch_debugpy/launcher/__main__.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import os
+import sys
+
+PY36 = sys.version_info < (3, 7)
+
+
+if __name__ == "__main__":
+    # Launch diffrent version of debugpy according to python version.
+    # Change `sys.path` to find debugpy package.
+    if "debugpy" not in sys.modules:
+        root = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+        python_dir = "python" if not PY36 else "python36"
+        sys.path[0] = os.path.join(root, "lib", python_dir)
+
+        import debugpy  # noqa
+
+        del sys.path[0]
+
+    from debugpy.launcher.__main__ import main
+
+    main()

pythonFiles/install_debugpy.py

@@ -15,6 +15,10 @@
 DEBUGGER_PYTHON_ABI_VERSIONS = ("cp310",)
 DEBUGGER_VERSION = "1.6.7"  # can also be "latest"
 
+PY36_DEBUGGER_DEST = os.path.join(EXTENSION_ROOT, "pythonFiles", "lib", "python36")
+PY36_DEBUGGER_PYTHON_ABI_VERSIONS = ("cp39",)
+PY36_DEBUGGER_VERSION = "1.5.1"  # the last version supporting Python 3.6 and below
+
 
 def _contains(s, parts=()):
     return any(p in s for p in parts)
@@ -28,11 +32,11 @@ def _get_package_data():
         return json.loads(response.read())
 
 
-def _get_debugger_wheel_urls(data, version):
+def _get_debugger_wheel_urls(data, version, python_abi_versions):
     return list(
         r["url"]
         for r in data["releases"][version]
-        if _contains(r["url"], DEBUGGER_PYTHON_ABI_VERSIONS)
+        if _contains(r["url"], python_abi_versions)
     )
 
 
@@ -58,9 +62,12 @@ def main(root):
     else:
         use_version = DEBUGGER_VERSION
 
-    for url in _get_debugger_wheel_urls(data, use_version):
+    for url in _get_debugger_wheel_urls(data, use_version, DEBUGGER_PYTHON_ABI_VERSIONS):
         _download_and_extract(root, url, use_version)
 
+    for url in _get_debugger_wheel_urls(data, use_version, PY36_DEBUGGER_PYTHON_ABI_VERSIONS):
+        _download_and_extract(PY36_DEBUGGER_DEST, url, PY36_DEBUGGER_VERSION)
+
 
 if __name__ == "__main__":
     main(DEBUGGER_DEST)

src/client/apiTypes.ts

@@ -23,7 +23,7 @@ export interface IExtensionApi {
         /**
          * Generate an array of strings for commands to pass to the Python executable to launch the debugger for remote debugging.
          * Users can append another array of strings of what they want to execute along with relevant arguments to Python.
-         * E.g `['/Users/..../pythonVSCode/pythonFiles/lib/python/debugpy', '--listen', 'localhost:57039', '--wait-for-client']`
+         * E.g `['/Users/..../pythonVSCode/pythonFiles/dispatch_debugpy', '--listen', 'localhost:57039', '--wait-for-client']`
          * @param {string} host
          * @param {number} port
          * @param {boolean} [waitUntilDebuggerAttaches=true]

src/client/debugger/extension/adapter/factory.ts

@@ -94,9 +94,7 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
             const debuggerAdapterPathToUse = path.join(
                 EXTENSION_ROOT_DIR,
                 'pythonFiles',
-                'lib',
-                'python',
-                'debugpy',
+                'dispatch_debugpy',
                 'adapter',
             );
 
@@ -163,7 +161,7 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
         }
         const prompts = [Interpreters.changePythonInterpreter, Common.doNotShowAgain];
         const selection = await showErrorMessage(
-            l10n.t('The debugger in the python extension no longer supports python versions minor than 3.7.'),
+            l10n.t('The debugger in the python extension no longer supports python versions minor than 2.7.'),
             { modal: true },
             ...prompts,
         );
@@ -183,7 +181,7 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
 
     private async getExecutableCommand(interpreter: PythonEnvironment | undefined): Promise<string[]> {
         if (interpreter) {
-            if ((interpreter.version?.major ?? 0) < 3 || (interpreter.version?.minor ?? 0) <= 6) {
+            if ((interpreter.version?.major ?? 0) < 3) {
                 this.showDeprecatedPythonMessage();
             }
             return interpreter.path.length > 0 ? [interpreter.path] : [];

src/client/debugger/extension/adapter/remoteLaunchers.ts

@@ -7,8 +7,7 @@ import * as path from 'path';
 import { EXTENSION_ROOT_DIR } from '../../../common/constants';
 import '../../../common/extensions';
 
-const pathToPythonLibDir = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python');
-const pathToDebugger = path.join(pathToPythonLibDir, 'debugpy');
+const pathToDebugger = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'dispatch_debugpy');
 
 type RemoteDebugOptions = {
     host: string;

src/client/jupyter/jupyterIntegration.ts

@@ -124,7 +124,7 @@ type PythonApiForJupyterExtension = {
         resource?: InterpreterUri,
     ): Promise<ProductInstallStatus>;
     /**
-     * Returns path to where `debugpy` is. In python extension this is `/pythonFiles/lib/python`.
+     * Returns path to where `debugpy` is. In python extension this is `/pythonFiles/dispatch_debugpy`.
      */
     getDebuggerPath(): Promise<string>;
     /**

src/test/api.functional.test.ts

@@ -19,7 +19,7 @@ import { IServiceContainer, IServiceManager } from '../client/ioc/types';
 import { IDiscoveryAPI } from '../client/pythonEnvironments/base/locator';
 
 suite('Extension API', () => {
-    const debuggerPath = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python', 'debugpy');
+    const debuggerPath = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'dispatch_debugpy');
     const debuggerHost = 'somehost';
     const debuggerPort = 12345;
 

src/test/debugger/extension/adapter/factory.unit.test.ts

@@ -39,7 +39,7 @@ suite('Debugging - Adapter Factory', () => {
     let commandManager: ICommandManager;
 
     const nodeExecutable = undefined;
-    const debugAdapterPath = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python', 'debugpy', 'adapter');
+    const debugAdapterPath = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'dispatch_debugpy', 'adapter');
     const pythonPath = path.join('path', 'to', 'python', 'interpreter');
     const interpreter = {
         architecture: Architecture.Unknown,
@@ -157,7 +157,7 @@ suite('Debugging - Adapter Factory', () => {
         sinon.assert.calledOnce(showErrorMessageStub);
     });
 
-    test('Display a message if python version is less than 3.7', async () => {
+    test('Display a message if python version is less than 3', async () => {
         when(interpreterService.getInterpreters(anything())).thenReturn([]);
         const session = createSession({});
         const deprecatedInterpreter = {
@@ -166,7 +166,7 @@ suite('Debugging - Adapter Factory', () => {
             sysPrefix: '',
             sysVersion: '',
             envType: EnvironmentType.Unknown,
-            version: new SemVer('3.6.12-test'),
+            version: new SemVer('2.7.12-test'),
         };
         when(state.value).thenReturn(false);
         when(interpreterService.getActiveInterpreter(anything())).thenResolve(deprecatedInterpreter);

src/test/debugger/extension/adapter/remoteLaunchers.unit.test.ts

@@ -52,10 +52,9 @@ suite('External debugpy Debugger Launcher', () => {
 });
 
 suite('Path To Debugger Package', () => {
-    const pathToPythonLibDir = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python');
     test('Path to debugpy debugger package', () => {
         const actual = launchers.getDebugpyPackagePath();
-        const expected = path.join(pathToPythonLibDir, 'debugpy');
+        const expected = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'dispatch_debugpy');
         expect(actual).to.be.deep.equal(expected);
     });
 });