Remove all other version of debugpy (microsoft#11689)

* Remove all other version of debugpy * Add news * fix linting * Fix debugpy install for py 2.7 tests

Author: karthiknadig

.github/workflows/ci.yml

@@ -46,7 +46,6 @@ jobs:
  run: |
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
- python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
 
  - name: Install debugpy wheels
  run: |
@@ -259,9 +258,8 @@ jobs:
  run: |
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
- python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
- # We need to have debugpy available in wheels/ so that tests relying on it keep passing, but we don't need install_debugpy's logic in the test phase.
- python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
+ # We need to have debugpy so that tests relying on it keep passing, but we don't need install_debugpy's logic in the test phase.
+ python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
 
  - name: Install test requirements
  run: python -m pip install --upgrade -r build/test-requirements.txt
@@ -272,14 +270,20 @@ jobs:
  python -m pip install --upgrade -r ./build/ipython-test-requirements.txt
  if: matrix.test-suite == 'python-unit'
 
- - name: Install debugpy wheels
+ - name: Install debugpy wheels (python 3.8)
  run: |
  python -m pip install wheel
  python -m pip --disable-pip-version-check install -r build/debugger-install-requirements.txt
  python ./pythonFiles/install_debugpy.py
  shell: bash
  if: matrix.test-suite == 'debugger' && matrix.python == 3.8
 
+ - name: Install debugpy (python 2.7)
+ run: |
+ python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
+ shell: bash
+ if: matrix.test-suite == 'debugger' && matrix.python == 2.7
+
  - name: Install functional test requirements
  run: |
  python -m pip install numpy
@@ -454,7 +458,7 @@ jobs:
  python -m pip install --upgrade -r build/test-requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
- python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
+ python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
  shell: bash
 
  - name: pip install ipython requirements

CONTRIBUTING.md

@@ -301,7 +301,9 @@ Steps to build the extension on your machine once you've cloned the repo:
 > npm ci
 > python3 -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
 > python3 -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
-> python3 -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
+# For python 3.6 and lower use this command to install the debugger
+> python3 -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
+# For python 3.7 and greater use this command to install the debugger
 > python3 -m pip --disable-pip-version-check install -r build/debugger-install-requirements.txt
 > python3 ./pythonFiles/install_debugpy.py
 > npm run clean

build/ci/templates/steps/build.yml

@@ -21,7 +21,6 @@ steps:
  - bash: |
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
- python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
  failOnStderr: true
  displayName: 'pip install requirements'
 

build/ci/templates/test_phases.yml

@@ -94,7 +94,7 @@ steps:
  python -m pip install --upgrade -r build/test-requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
  python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
- python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/debugpy/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
+ python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade --pre debugpy
  displayName: 'pip install system test requirements'
  condition: and(succeeded(), eq(variables['NeedsPythonTestReqs'], 'true'))
 
@@ -161,7 +161,7 @@ steps:
  # Run the pip installs in the 3 environments (windows)
  - script: |
  call activate base
- conda install --quiet -y --file build/ci/conda_base.yml 
+ conda install --quiet -y --file build/ci/conda_base.yml
  python -m pip install --upgrade -r build/conda-functional-requirements.txt
  call activate conda_env_1
  python -m pip install --upgrade -r build/conda-functional-requirements.txt

gulpfile.js

@@ -405,37 +405,6 @@ gulp.task('installNewDebugpy', async () => {
  }
 
  rmrf.sync('./pythonFiles/lib/temp');
-
- // Install source only version of new DEBUGPY for use with all other python versions.
- const args = [
- '-m',
- 'pip',
- '--disable-pip-version-check',
- 'install',
- '-t',
- './pythonFiles/lib/python/debugpy/no_wheels',
- '--no-cache-dir',
- '--implementation',
- 'py',
- '--no-deps',
- '--upgrade',
- '--pre',
- 'debugpy'
- ];
- const successWithoutWheels = await spawnAsync(process.env.CI_PYTHON_PATH || 'python3', args, undefined, true)
- .then(() => true)
- .catch((ex) => {
- console.error("Failed to install DEBUGPY using 'python3'", ex);
- return false;
- });
- if (!successWithoutWheels) {
- console.info(
- "Failed to install source only version of new DEBUGPY using 'python3', attempting to install using 'python'"
- );
- await spawnAsync('python', args).catch((ex) =>
- console.error("Failed to install source only DEBUGPY using 'python'", ex)
- );
- }
 });
 
 // Install the last stable version of old PTVSD (which includes a middle layer adapter and requires ptvsd_launcher.py)

news/2 Fixes/11686.md

@@ -0,0 +1 @@
+Fixes issue with importing `debupy` in interactive window.

pythonFiles/install_debugpy.py

@@ -7,9 +7,7 @@
 
 
 EXTENSION_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-DEBUGGER_DEST = os.path.join(
- EXTENSION_ROOT, "pythonFiles", "lib", "python", "debugpy", "wheels"
-)
+DEBUGGER_DEST = os.path.join(EXTENSION_ROOT, "pythonFiles", "lib", "python")
 DEBUGGER_PACKAGE = "debugpy"
 DEBUGGER_PYTHON_VERSIONS = ("cp37",)
 

src/client/datascience/jupyter/jupyterDebugger.ts

@@ -238,20 +238,13 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  * @returns {Promise<string>}
  * @memberof JupyterDebugger
  */
- private async getDebuggerPath(notebook: INotebook): Promise<string> {
+ private async getDebuggerPath(_notebook: INotebook): Promise<string> {
  if (this.debuggerPackage === 'ptvsd') {
  return path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python', 'old_ptvsd');
  }
- const pythonVersion = await this.getKernelPythonVersion(notebook);
- // The new debug adapter with wheels is only supported in 3.7
- // Code can be found here (src/client/debugger/extension/adapter/factory.ts).
- if (pythonVersion && pythonVersion.major === 3 && pythonVersion.minor === 7) {
- // Return debugger with wheels
- return path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python', 'debugpy', 'wheels');
- }
 
  // We are here so this is NOT python 3.7, return debugger without wheels
- return path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python', 'debugpy', 'no_wheels');
+ return path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python');
  }
  private async calculateDebuggerPathList(notebook: INotebook): Promise<string | undefined> {
  const extraPaths: string[] = [];
@@ -328,11 +321,6 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  return notebook.execute(code, Identifiers.EmptyFileName, 0, uuid(), undefined, true);
  }
 
- private async getKernelPythonVersion(notebook: INotebook): Promise<Version | undefined> {
- const execResults = await this.executeSilently(notebook, 'import sys;print(sys.version)');
- return this.parseVersionInfo(execResults, 'pythonVersionInfo');
- }
-
  private async debuggerCheck(notebook: INotebook): Promise<Version | undefined> {
  // We don't want to actually import the debugger to check version so run
  // python instead. If we import an old version it's hard to get rid of on

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

@@ -75,23 +75,17 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
  return new DebugAdapterExecutable(pythonPath, [configuration.debugAdapterPath, ...logArgs]);
  }
 
- const debuggerPathToUse = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python', 'debugpy');
-
- if (await this.useNewDebugger(pythonPath)) {
- sendTelemetryEvent(EventName.DEBUG_ADAPTER_USING_WHEELS_PATH, undefined, { usingWheels: true });
- return new DebugAdapterExecutable(pythonPath, [
- path.join(debuggerPathToUse, 'wheels', 'debugpy', 'adapter'),
- ...logArgs
- ]);
- } else {
- sendTelemetryEvent(EventName.DEBUG_ADAPTER_USING_WHEELS_PATH, undefined, {
- usingWheels: false
- });
- return new DebugAdapterExecutable(pythonPath, [
- path.join(debuggerPathToUse, 'no_wheels', 'debugpy', 'adapter'),
- ...logArgs
- ]);
- }
+ const debuggerAdapterPathToUse = path.join(
+ EXTENSION_ROOT_DIR,
+ 'pythonFiles',
+ 'lib',
+ 'python',
+ 'debugpy',
+ 'adapter'
+ );
+
+ sendTelemetryEvent(EventName.DEBUG_ADAPTER_USING_WHEELS_PATH, undefined, { usingWheels: true });
+ return new DebugAdapterExecutable(pythonPath, [debuggerAdapterPathToUse, ...logArgs]);
  }
  } else {
  this.experimentsManager.sendTelemetryIfInExperiment(DebugAdapterNewPtvsd.control);
@@ -105,22 +99,6 @@ export class DebugAdapterDescriptorFactory implements IDebugAdapterDescriptorFac
  throw new Error('Debug Adapter Executable not provided');
  }
 
- /**
- * Check and return whether the user should and can use the new Debugger wheels or not.
- *
- * @param {string} pythonPath Path to the python executable used to launch the Python Debug Adapter (result of `this.getPythonPath()`)
- * @returns {Promise<boolean>} Whether the user should and can use the new Debugger wheels or not.
- * @memberof DebugAdapterDescriptorFactory
- */
- private async useNewDebugger(pythonPath: string): Promise<boolean> {
- const interpreterInfo = await this.interpreterService.getInterpreterDetails(pythonPath);
- if (!interpreterInfo || !interpreterInfo.version || !interpreterInfo.version.raw.startsWith('3.7')) {
- return false;
- }
-
- return true;
- }
-
  /**
  * Get the python executable used to launch the Python Debug Adapter.
  * In the case of `attach` scenarios, just use the workspace interpreter, else first available one.

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

@@ -9,7 +9,7 @@ import '../../../common/extensions';
 
 const pathToPythonLibDir = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'lib', 'python');
 const pathToScript = path.join(EXTENSION_ROOT_DIR, 'pythonFiles', 'ptvsd_launcher.py');
-const pathToDebugger = path.join(pathToPythonLibDir, 'debugpy', 'no_wheels', 'debugpy');
+const pathToDebugger = path.join(pathToPythonLibDir, 'debugpy');
 
 export type RemoteDebugOptions = {
  host: string;