Add setting showPythonInlineValues by paulacamargo25 · Pull Request #407 · microsoft/vscode-python-debugger

Paula (paulacamargo25) · 2024-07-24T19:58:20Z

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

Connor Peet (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

Paula (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.

Connor Peet (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?

Paula (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

Luciana Abud (luabud) · 2024-07-24T21:02:05Z

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

Connor Peet (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

Karthik Nadig (karthiknadig) · 2024-07-24T23:17:05Z

Connor Peet (@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.

Karthik Nadig (karthiknadig) · 2024-07-24T23:17:51Z

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


Suggested change

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

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

Karthik Nadig (karthiknadig) · 2024-07-24T23:18:17Z

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

Connor Peet (connor4312) · 2024-07-25T05:06:53Z

Karthik Nadig (@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.

Karthik Nadig (karthiknadig) · 2024-07-25T18:09:43Z

Thanks Connor Peet (@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.

Connor Peet (connor4312)

lgtm 👍

Connor Peet (connor4312) · 2024-07-25T20:40:57Z

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

Paula (paulacamargo25) self-assigned this Jul 24, 2024

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

Paula (paulacamargo25) added this to the July 2024 milestone Jul 24, 2024

Paula (paulacamargo25) added 2 commits July 24, 2024 13:00

Add setting showPythonInlineValues

98ed8c3

Fix lint

be2a2ff

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

Paula (paulacamargo25) added 2 commits July 24, 2024 13:27

fix tests

8956500

fix package.json

492bd2f

Paula (paulacamargo25) requested review from Karthik Nadig (karthiknadig) and Luciana Abud (luabud) July 24, 2024 20:29

Karthik Nadig (karthiknadig) requested changes Jul 24, 2024

View reviewed changes

Comment thread package.json Outdated

Connor Peet (connor4312) reviewed Jul 24, 2024

View reviewed changes

Add experimental tag

cfe25bd

Paula (paulacamargo25) requested a review from Karthik Nadig (karthiknadig) July 24, 2024 20:47

Luciana Abud (luabud) reviewed Jul 24, 2024

View reviewed changes

fix text

9f58e07

Paula (paulacamargo25) requested a review from Luciana Abud (luabud) July 24, 2024 22:18

Karthik Nadig (karthiknadig) requested changes Jul 24, 2024

View reviewed changes

update translations

75967e6

Paula (paulacamargo25) requested review from Connor Peet (connor4312) and Karthik Nadig (karthiknadig) July 25, 2024 01:05

Paula (paulacamargo25) added 2 commits July 25, 2024 13:15

dont register provider if value is false

c46aec9

fix lint

2b16d99

Connor Peet (connor4312) reviewed Jul 25, 2024

View reviewed changes

Paula (paulacamargo25) requested a review from Connor Peet (connor4312) July 25, 2024 21:52

Karthik Nadig (karthiknadig) approved these changes Jul 25, 2024

View reviewed changes

Paula (paulacamargo25) merged commit 36ec556 into microsoft:main 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."

Uh oh!

Conversation

Paula (paulacamargo25) commented Jul 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Connor Peet (connor4312) left a comment

Choose a reason for hiding this comment

Uh oh!

Paula (paulacamargo25) commented Jul 24, 2024

Uh oh!

Connor Peet (connor4312) commented Jul 24, 2024

Uh oh!

Paula (paulacamargo25) commented Jul 24, 2024

Uh oh!

Luciana Abud (luabud) Jul 24, 2024

Choose a reason for hiding this comment

Uh oh!

Connor Peet (connor4312) commented Jul 24, 2024

Uh oh!

Karthik Nadig (karthiknadig) commented Jul 24, 2024

Uh oh!

Karthik Nadig (karthiknadig) Jul 24, 2024

Choose a reason for hiding this comment

Uh oh!

Karthik Nadig (karthiknadig) Jul 24, 2024

Choose a reason for hiding this comment

Uh oh!

Connor Peet (connor4312) commented Jul 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Karthik Nadig (karthiknadig) commented Jul 25, 2024

Uh oh!

Connor Peet (connor4312) left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Connor Peet (connor4312) Jul 25, 2024

Choose a reason for hiding this comment

Uh oh!

Paula (paulacamargo25) Jul 25, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Paula (paulacamargo25) commented Jul 24, 2024 •

edited

Loading

Connor Peet (connor4312) commented Jul 25, 2024 •

edited

Loading

Connor Peet (connor4312) left a comment •

edited

Loading