Add setting showPythonInlineValues #407

paulacamargo25 · 2024-07-24T19:58:20Z

Add setting for showing the inline values.
Closed: #410

package.json

connor4312

Is there a request to disable/enable debug inline values on a per-language basis versus the base debug.inlineValues? If so this is something we should probably have in VS Code itself rather than an extension-specific setting

paulacamargo25 · 2024-07-24T20:47:21Z

Is there a request to disable/enable debug inline values on a per-language basis versus the base debug.inlineValues? If so this is something we should probably have in VS Code itself rather than an extension-specific setting

We are using this setting as experimental, there are some variables in the python inline values that we need to review and investigate more for the next iteration. So we decided to add this setting to have this value set to false by default.

connor4312 · 2024-07-24T20:52:28Z

It looks like debug.inlineValues functions in the current stable version of the Python extension, would a default value of false disable them for everyone?

paulacamargo25 · 2024-07-24T21:01:37Z

It looks like debug.inlineValues functions in the current stable version of the Python extension, would a default value of false disable them for everyone?

Yes, it will disable all the inline values

luabud · 2024-07-24T21:02:05Z

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."


Suggested change

"debugpy.showPythonInlineValues": "Enable this to see inline values in the editor while debugging."

"debugpy.showPythonInlineValues": "Whether to display inline values in the editor while debugging."

connor4312 · 2024-07-24T21:10:39Z

Yes, it will disable all the inline values

Is that intended? That seems like a regression for folks who were using them up until this point

karthiknadig · 2024-07-24T23:17:05Z

@connor4312 This setting is similar to debug.inlineValues but it should not affect general one. The debugpy.showPythonInlineValues is added so we can explore the value filtering, via experimentation, till we get to a point where we can remove it. I agree that a more general purpose language specific version o debug.inlineValue is a core feature.

karthiknadig · 2024-07-24T23:17:51Z

package.json

+                },
+                "debugpy.showPythonInlineValues": {
+                    "default": false,
+                    "description": "%debugpy.showPythonInlineValues%",


Suggested change

"description": "%debugpy.showPythonInlineValues%",

"description": "%debugpy.showPythonInlineValues.description%",

karthiknadig · 2024-07-24T23:18:17Z

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": "Whether to display inline values in the editor while debugging."


Suggested change

"debugpy.showPythonInlineValues": "Whether to display inline values in the editor while debugging."

"debugpy.showPythonInlineValues.description": "Whether to display inline values in the editor while debugging."

connor4312 · 2024-07-25T05:06:53Z

@karthiknadig I have not tested the changes in this PR, but in VS Code if there is an inline value provider registered for a language then that will be used instead of the default handling that VS Code does, and is doing for Python stable. If I'm understanding it right, the implementation in this PR of just returning an empty array from the provider won't fall back to the old behavior, but will instead turn off inline values for everyone, including those who might have been using them previously.

https://github.com/microsoft/vscode/blob/06643dd85264bc88ab30acc007baad0db33b8c71/src/vs/workbench/contrib/debug/browser/debugEditorContribution.ts#L676

I think the better implementation is not registering an inline value provider at all if the setting is turned off so as not to regress functionality.

karthiknadig · 2024-07-25T18:09:43Z

Thanks @connor4312 for the explanation. I agree that this should skip registration, if the setting is set to disable. If the setting was changed when the extension is already activated, we can just use the on settings change event and dispose the provider. registerInLineProvider API returns a disposable that we can use to register/unregister dynamically.

connor4312

lgtm 👍

connor4312 · 2024-07-25T20:40:57Z

src/extension/extensionInit.ts

+
+    context.subscriptions.push(
+        workspace.onDidChangeConfiguration((event: ConfigurationChangeEvent) => {
+            if (event.affectsConfiguration('debugpy')) {


An aside but I have a ConfigValue helper that I've copied between multiple projects that makes this easier :)

Thanks for the suggestion Connor, I'll review it and add it as a dev week item.

paulacamargo25 self-assigned this Jul 24, 2024

paulacamargo25 added the feature-request Request for new features or functionality label Jul 24, 2024

paulacamargo25 added this to the July 2024 milestone Jul 24, 2024

paulacamargo25 added 2 commits July 24, 2024 13:00

Add setting showPythonInlineValues

98ed8c3

Fix lint

be2a2ff

paulacamargo25 force-pushed the add-setting-to-enable-inline-values branch from 1276df4 to be2a2ff Compare July 24, 2024 20:01

paulacamargo25 added 2 commits July 24, 2024 13:27

fix tests

8956500

fix package.json

492bd2f

paulacamargo25 requested review from luabud and karthiknadig July 24, 2024 20:29

karthiknadig requested changes Jul 24, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

connor4312 reviewed Jul 24, 2024

View reviewed changes

Add experimental tag

cfe25bd

paulacamargo25 requested a review from karthiknadig July 24, 2024 20:47

luabud reviewed Jul 24, 2024

View reviewed changes

fix text

9f58e07

paulacamargo25 requested a review from luabud July 24, 2024 22:18

karthiknadig requested changes Jul 24, 2024

View reviewed changes

update translations

75967e6

paulacamargo25 requested review from karthiknadig and connor4312 July 25, 2024 01:05

paulacamargo25 added 2 commits July 25, 2024 13:15

dont register provider if value is false

c46aec9

fix lint

2b16d99

connor4312 reviewed Jul 25, 2024

View reviewed changes

paulacamargo25 requested a review from connor4312 July 25, 2024 21:52

karthiknadig approved these changes Jul 25, 2024

View reviewed changes

paulacamargo25 merged commit 36ec556 into microsoft:main Jul 25, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add setting showPythonInlineValues #407

Add setting showPythonInlineValues #407

paulacamargo25 commented Jul 24, 2024 •

edited

Loading

connor4312 left a comment

paulacamargo25 commented Jul 24, 2024

connor4312 commented Jul 24, 2024

paulacamargo25 commented Jul 24, 2024

luabud Jul 24, 2024

connor4312 commented Jul 24, 2024

karthiknadig commented Jul 24, 2024

karthiknadig Jul 24, 2024

karthiknadig Jul 24, 2024

connor4312 commented Jul 25, 2024 •

edited

Loading

karthiknadig commented Jul 25, 2024

connor4312 left a comment •

edited

Loading

connor4312 Jul 25, 2024

paulacamargo25 Jul 25, 2024

	"debugpy.showPythonInlineValues": "Enable this to see inline values in the editor while debugging."
	"debugpy.showPythonInlineValues": "Whether to display inline values in the editor while debugging."

	"description": "%debugpy.showPythonInlineValues%",
	"description": "%debugpy.showPythonInlineValues.description%",

	"debugpy.showPythonInlineValues": "Whether to display inline values in the editor while debugging."
	"debugpy.showPythonInlineValues.description": "Whether to display inline values in the editor while debugging."

Add setting showPythonInlineValues #407

Add setting showPythonInlineValues #407

Conversation

paulacamargo25 commented Jul 24, 2024 • edited Loading

connor4312 left a comment

Choose a reason for hiding this comment

paulacamargo25 commented Jul 24, 2024

connor4312 commented Jul 24, 2024

paulacamargo25 commented Jul 24, 2024

luabud Jul 24, 2024

Choose a reason for hiding this comment

connor4312 commented Jul 24, 2024

karthiknadig commented Jul 24, 2024

karthiknadig Jul 24, 2024

Choose a reason for hiding this comment

karthiknadig Jul 24, 2024

Choose a reason for hiding this comment

connor4312 commented Jul 25, 2024 • edited Loading

karthiknadig commented Jul 25, 2024

connor4312 left a comment • edited Loading

Choose a reason for hiding this comment

connor4312 Jul 25, 2024

Choose a reason for hiding this comment

paulacamargo25 Jul 25, 2024

Choose a reason for hiding this comment

paulacamargo25 commented Jul 24, 2024 •

edited

Loading

connor4312 commented Jul 25, 2024 •

edited

Loading

connor4312 left a comment •

edited

Loading