Skip to content

Commit 4b20034

Browse files
joyceerhlkarthiknadig
joyceerhl
authored and
karthiknadig
committed
Deprecate ptvsd for data science (#12105)
1 parent 475b046 commit 4b20034

9 files changed

Lines changed: 18 additions & 66 deletions

File tree

‎build/existingFiles.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,6 @@
403403
"src/test/configuration/interpreterSelector.unit.test.ts",
404404
"src/test/constants.ts",
405405
"src/test/core.ts",
406-
"src/test/debugger/attach.ptvsd.test.ts",
407406
"src/test/debugger/capabilities.test.ts",
408407
"src/test/debugger/common/constants.ts",
409408
"src/test/debugger/common/debugStreamProvider.test.ts",

‎news/3 Code Health/11993.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace python.dataScience.ptvsdDistPath with python.dataScience.debugpyDistPath.

‎news/3 Code Health/11996.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Rename ptvsd to debugpy in Telemetry.

‎package.json‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2050,11 +2050,10 @@
20502050
"description": "Set of debug commands to put as code lens above a cell while debugging.",
20512051
"scope": "resource"
20522052
},
2053-
"python.dataScience.ptvsdDistPath": {
2053+
"python.dataScience.debugpyDistPath": {
20542054
"type": "string",
20552055
"default": "",
2056-
"description": "Path to ptvsd experimental bits for debugging cells.",
2057-
"deprecationMessage": "This setting has been deprecated in favor of 'debugpyDistPath'.",
2056+
"description": "Path to debugpy bits for debugging cells.",
20582057
"scope": "resource"
20592058
},
20602059
"python.dataScience.stopOnFirstLineWhileDebugging": {

‎pythonFiles/ptvsd_launcher.py‎

Lines changed: 0 additions & 48 deletions
This file was deleted.

‎src/client/common/types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ export interface IDataScienceSettings {
370370
enablePlotViewer?: boolean;
371371
codeLenses?: string;
372372
debugCodeLenses?: string;
373-
ptvsdDistPath?: string;
373+
debugpyDistPath?: string;
374374
stopOnFirstLineWhileDebugging?: boolean;
375375
textOutputLimit?: number;
376376
magicCommandsAsComments?: boolean;

‎src/client/datascience/constants.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,10 +251,10 @@ export enum Telemetry {
251251
HashedCellOutputMimeTypePerf = 'DS_INTERNAL.HASHED_OUTPUT_MIME_TYPE_PERF',
252252
HashedNotebookCellOutputMimeTypePerf = 'DS_INTERNAL.HASHED_NOTEBOOK_OUTPUT_MIME_TYPE_PERF',
253253
JupyterInstalledButNotKernelSpecModule = 'DS_INTERNAL.JUPYTER_INTALLED_BUT_NO_KERNELSPEC_MODULE',
254-
PtvsdPromptToInstall = 'DATASCIENCE.PTVSD_PROMPT_TO_INSTALL',
255-
PtvsdSuccessfullyInstalled = 'DATASCIENCE.PTVSD_SUCCESSFULLY_INSTALLED',
256-
PtvsdInstallFailed = 'DATASCIENCE.PTVSD_INSTALL_FAILED',
257-
PtvsdInstallCancelled = 'DATASCIENCE.PTVSD_INSTALL_CANCELLED',
254+
DebugpyPromptToInstall = 'DATASCIENCE.DEBUGPY_PROMPT_TO_INSTALL',
255+
DebugpySuccessfullyInstalled = 'DATASCIENCE.DEBUGPY_SUCCESSFULLY_INSTALLED',
256+
DebugpyInstallFailed = 'DATASCIENCE.DEBUGPY_INSTALL_FAILED',
257+
DebugpyInstallCancelled = 'DATASCIENCE.DEBUGPY_INSTALL_CANCELLED',
258258
ScrolledToCell = 'DATASCIENCE.SCROLLED_TO_CELL',
259259
ExecuteNativeCell = 'DATASCIENCE.NATIVE.EXECUTE_NATIVE_CELL',
260260
CreateNewNotebook = 'DATASCIENCE.NATIVE.CREATE_NEW_NOTEBOOK',

‎src/client/datascience/jupyter/jupyterDebugger.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
244244

245245
// Add the settings path first as it takes precedence over the ptvsd extension path
246246
// tslint:disable-next-line:no-multiline-string
247-
let settingsPath = this.configService.getSettings(notebook.resource).datascience.ptvsdDistPath;
247+
let settingsPath = this.configService.getSettings(notebook.resource).datascience.debugpyDistPath;
248248
// Escape windows path chars so they end up in the source escaped
249249
if (settingsPath) {
250250
if (this.platform.isWindows) {
@@ -376,7 +376,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
376376
return version.major > required.major || (version.major === required.major && version.minor >= required.minor);
377377
}
378378

379-
@captureTelemetry(Telemetry.PtvsdPromptToInstall)
379+
@captureTelemetry(Telemetry.DebugpyPromptToInstall)
380380
private async promptToInstallDebugger(
381381
notebook: INotebook,
382382
oldVersion: Version | undefined,
@@ -399,7 +399,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
399399
await this.installDebugger(notebook);
400400
} else {
401401
// If they don't want to install, throw so we exit out of debugging
402-
sendTelemetryEvent(Telemetry.PtvsdInstallCancelled);
402+
sendTelemetryEvent(Telemetry.DebugpyInstallCancelled);
403403
throw new JupyterDebuggerNotInstalledError(this.debuggerPackage);
404404
}
405405
}
@@ -416,13 +416,13 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
416416
const installResultsString = this.extractOutput(debuggerInstallResults[0]);
417417

418418
if (installResultsString && installResultsString.includes('Successfully installed')) {
419-
sendTelemetryEvent(Telemetry.PtvsdSuccessfullyInstalled);
419+
sendTelemetryEvent(Telemetry.DebugpySuccessfullyInstalled);
420420
traceInfo(`${this.debuggerPackage} successfully installed`);
421421
return;
422422
}
423423
}
424424
traceCellResults(`Installing ${this.debuggerPackage}`, debuggerInstallResults);
425-
sendTelemetryEvent(Telemetry.PtvsdInstallFailed);
425+
sendTelemetryEvent(Telemetry.DebugpyInstallFailed);
426426
traceError(`Failed to install ${this.debuggerPackage}`);
427427
// Failed to install debugger, throw to exit debugging
428428
throw new JupyterDebuggerNotInstalledError(this.debuggerPackage);

‎src/client/telemetry/index.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1655,10 +1655,10 @@ export interface IEventNamePropertyMapping {
16551655
[Telemetry.NotebookOpenTime]: number;
16561656
[Telemetry.PandasNotInstalled]: never | undefined;
16571657
[Telemetry.PandasTooOld]: never | undefined;
1658-
[Telemetry.PtvsdInstallCancelled]: never | undefined;
1659-
[Telemetry.PtvsdInstallFailed]: never | undefined;
1660-
[Telemetry.PtvsdPromptToInstall]: never | undefined;
1661-
[Telemetry.PtvsdSuccessfullyInstalled]: never | undefined;
1658+
[Telemetry.DebugpyInstallCancelled]: never | undefined;
1659+
[Telemetry.DebugpyInstallFailed]: never | undefined;
1660+
[Telemetry.DebugpyPromptToInstall]: never | undefined;
1661+
[Telemetry.DebugpySuccessfullyInstalled]: never | undefined;
16621662
[Telemetry.OpenNotebook]: { scope: 'command' | 'file' };
16631663
[Telemetry.OpenNotebookAll]: never | undefined;
16641664
[Telemetry.OpenedInteractiveWindow]: never | undefined;

0 commit comments

Comments
 (0)