Add setting showPythonInlineValues

microsoft · Jul 24, 2024 · 1276df4 · 1276df4
1 parent 83c5cb5
commit 1276df4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -131,7 +131,14 @@
                     "description": "%debugpy.debugJustMyCode%",
                     "scope": "resource",
                     "type": "boolean"
+                },
+                "debugpy.showPythonInlineValues": {
+                    "default": false,
+                    "description": "%debugpy.showPythonInlineValues%",
+                    "scope": "resource",
+                    "type": "boolean"
                 }
+
             },
             "title": "Python Debugger",
             "type": "object"

diff --git a/package.nls.json b/package.nls.json
@@ -4,5 +4,6 @@
     "debugpy.command.debugUsingLaunchConfig.title": "Python Debugger: Debug using launch.json",
     "debugpy.command.reportIssue.title": "Report Issue...",
     "debugpy.command.viewOutput.title": "Show Output",
-    "debugpy.debugJustMyCode": "When debugging only step through user-written code. Disable this to allow stepping into library code."
+    "debugpy.debugJustMyCode": "When debugging only step through user-written code. Disable this to allow stepping into library code.",
+    "debugpy.showPythonInlineValues": "Enable this to see inline values in the editor while debugging."
 }
diff --git a/src/extension/debugger/inlineValue/pythonInlineValueProvider.ts b/src/extension/debugger/inlineValue/pythonInlineValueProvider.ts
@@ -10,7 +10,7 @@ import {
     InlineValueVariableLookup,
     InlineValueEvaluatableExpression,
 } from 'vscode';
-import { customRequest } from '../../common/vscodeapi';
+import { customRequest, getConfiguration } from '../../common/vscodeapi';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
 
@@ -20,6 +20,13 @@ export class PythonInlineValueProvider implements InlineValuesProvider {
         viewPort: Range,
         context: InlineValueContext,
     ): Promise<InlineValue[]> {
+        const showInlineValues = getConfiguration('debugpy').get<boolean>(
+            'showPythonInlineValues',
+            false,
+        );
+        if (!showInlineValues) {
+            return [];
+        }
         let scopesRequest = await customRequest('scopes', { frameId: context.frameId });
         let variablesRequest = await customRequest('variables', {
             variablesReference: scopesRequest.scopes[0].variablesReference,