Deprecate ptvsd for data science (microsoft#12105)

Author: joyceerhl

build/existingFiles.json

@@ -403,7 +403,6 @@
  "src/test/configuration/interpreterSelector.unit.test.ts",
  "src/test/constants.ts",
  "src/test/core.ts",
- "src/test/debugger/attach.ptvsd.test.ts",
  "src/test/debugger/capabilities.test.ts",
  "src/test/debugger/common/constants.ts",
  "src/test/debugger/common/debugStreamProvider.test.ts",

news/3 Code Health/11993.md

@@ -0,0 +1 @@
+Replace python.dataScience.ptvsdDistPath with python.dataScience.debugpyDistPath.

news/3 Code Health/11996.md

@@ -0,0 +1 @@
+Rename ptvsd to debugpy in Telemetry.

package.json

@@ -2050,11 +2050,10 @@
  "description": "Set of debug commands to put as code lens above a cell while debugging.",
  "scope": "resource"
  },
- "python.dataScience.ptvsdDistPath": {
+ "python.dataScience.debugpyDistPath": {
  "type": "string",
  "default": "",
- "description": "Path to ptvsd experimental bits for debugging cells.",
- "deprecationMessage": "This setting has been deprecated in favor of 'debugpyDistPath'.",
+ "description": "Path to debugpy bits for debugging cells.",
  "scope": "resource"
  },
  "python.dataScience.stopOnFirstLineWhileDebugging": {

pythonFiles/ptvsd_launcher.py

@@ -370,7 +370,7 @@ export interface IDataScienceSettings {
  enablePlotViewer?: boolean;
  codeLenses?: string;
  debugCodeLenses?: string;
- ptvsdDistPath?: string;
+ debugpyDistPath?: string;
  stopOnFirstLineWhileDebugging?: boolean;
  textOutputLimit?: number;
  magicCommandsAsComments?: boolean;

src/client/common/types.ts

@@ -251,10 +251,10 @@ export enum Telemetry {
  HashedCellOutputMimeTypePerf = 'DS_INTERNAL.HASHED_OUTPUT_MIME_TYPE_PERF',
  HashedNotebookCellOutputMimeTypePerf = 'DS_INTERNAL.HASHED_NOTEBOOK_OUTPUT_MIME_TYPE_PERF',
  JupyterInstalledButNotKernelSpecModule = 'DS_INTERNAL.JUPYTER_INTALLED_BUT_NO_KERNELSPEC_MODULE',
- PtvsdPromptToInstall = 'DATASCIENCE.PTVSD_PROMPT_TO_INSTALL',
- PtvsdSuccessfullyInstalled = 'DATASCIENCE.PTVSD_SUCCESSFULLY_INSTALLED',
- PtvsdInstallFailed = 'DATASCIENCE.PTVSD_INSTALL_FAILED',
- PtvsdInstallCancelled = 'DATASCIENCE.PTVSD_INSTALL_CANCELLED',
+ DebugpyPromptToInstall = 'DATASCIENCE.DEBUGPY_PROMPT_TO_INSTALL',
+ DebugpySuccessfullyInstalled = 'DATASCIENCE.DEBUGPY_SUCCESSFULLY_INSTALLED',
+ DebugpyInstallFailed = 'DATASCIENCE.DEBUGPY_INSTALL_FAILED',
+ DebugpyInstallCancelled = 'DATASCIENCE.DEBUGPY_INSTALL_CANCELLED',
  ScrolledToCell = 'DATASCIENCE.SCROLLED_TO_CELL',
  ExecuteNativeCell = 'DATASCIENCE.NATIVE.EXECUTE_NATIVE_CELL',
  CreateNewNotebook = 'DATASCIENCE.NATIVE.CREATE_NEW_NOTEBOOK',

src/client/datascience/constants.ts

@@ -244,7 +244,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
 
  // Add the settings path first as it takes precedence over the ptvsd extension path
  // tslint:disable-next-line:no-multiline-string
- let settingsPath = this.configService.getSettings(notebook.resource).datascience.ptvsdDistPath;
+ let settingsPath = this.configService.getSettings(notebook.resource).datascience.debugpyDistPath;
  // Escape windows path chars so they end up in the source escaped
  if (settingsPath) {
  if (this.platform.isWindows) {
@@ -376,7 +376,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  return version.major > required.major || (version.major === required.major && version.minor >= required.minor);
  }
 
- @captureTelemetry(Telemetry.PtvsdPromptToInstall)
+ @captureTelemetry(Telemetry.DebugpyPromptToInstall)
  private async promptToInstallDebugger(
  notebook: INotebook,
  oldVersion: Version | undefined,
@@ -399,7 +399,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  await this.installDebugger(notebook);
  } else {
  // If they don't want to install, throw so we exit out of debugging
- sendTelemetryEvent(Telemetry.PtvsdInstallCancelled);
+ sendTelemetryEvent(Telemetry.DebugpyInstallCancelled);
  throw new JupyterDebuggerNotInstalledError(this.debuggerPackage);
  }
  }
@@ -416,13 +416,13 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  const installResultsString = this.extractOutput(debuggerInstallResults[0]);
 
  if (installResultsString && installResultsString.includes('Successfully installed')) {
- sendTelemetryEvent(Telemetry.PtvsdSuccessfullyInstalled);
+ sendTelemetryEvent(Telemetry.DebugpySuccessfullyInstalled);
  traceInfo(`${this.debuggerPackage} successfully installed`);
  return;
  }
  }
  traceCellResults(`Installing ${this.debuggerPackage}`, debuggerInstallResults);
- sendTelemetryEvent(Telemetry.PtvsdInstallFailed);
+ sendTelemetryEvent(Telemetry.DebugpyInstallFailed);
  traceError(`Failed to install ${this.debuggerPackage}`);
  // Failed to install debugger, throw to exit debugging
  throw new JupyterDebuggerNotInstalledError(this.debuggerPackage);

src/client/datascience/jupyter/jupyterDebugger.ts

@@ -1655,10 +1655,10 @@ export interface IEventNamePropertyMapping {
  [Telemetry.NotebookOpenTime]: number;
  [Telemetry.PandasNotInstalled]: never | undefined;
  [Telemetry.PandasTooOld]: never | undefined;
- [Telemetry.PtvsdInstallCancelled]: never | undefined;
- [Telemetry.PtvsdInstallFailed]: never | undefined;
- [Telemetry.PtvsdPromptToInstall]: never | undefined;
- [Telemetry.PtvsdSuccessfullyInstalled]: never | undefined;
+ [Telemetry.DebugpyInstallCancelled]: never | undefined;
+ [Telemetry.DebugpyInstallFailed]: never | undefined;
+ [Telemetry.DebugpyPromptToInstall]: never | undefined;
+ [Telemetry.DebugpySuccessfullyInstalled]: never | undefined;
  [Telemetry.OpenNotebook]: { scope: 'command' | 'file' };
  [Telemetry.OpenNotebookAll]: never | undefined;
  [Telemetry.OpenedInteractiveWindow]: never | undefined;