Skip to content

Add variable presentation #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

Add variable presentation #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9666e7a
Add variable presentation setting
paulacamargo25 Aug 6, 2024
8a29056
Add translations
paulacamargo25 Aug 6, 2024
1be51d3
Add variablePresentation in launch and debug config
paulacamargo25 Aug 6, 2024
56ba8ee
Fix typo error
paulacamargo25 Aug 6, 2024
56e2c2a
Add tests
paulacamargo25 Aug 6, 2024
da29fb5
fix lint
paulacamargo25 Aug 6, 2024
f048709
fix equals
paulacamargo25 Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 188 additions & 18 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,64 @@
"scope": "resource",
"type": "boolean"
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/

"debugpy.debugVariablePresentation": {
"default": {},
"description": "%debugpy.debugVariablePresentation.description%",
"scope": "resource",
"type": "object",
"properties": {
"all": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.all.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"class": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.class.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"function": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.function.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"protected": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.protected.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"special": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.special.description%",
"enum": [
"inline",
"group",
"hide"
]
}
}
},
"debugpy.showPythonInlineValues": {
"default": false,
"description": "%debugpy.showPythonInlineValues.description%",
Expand Down Expand Up @@ -171,6 +229,11 @@
],
"type": "object"
},
"consoleName": {
"default": "Python Debug Console",
"description": "Display name of the debug console or terminal",
"type": "string"
},
"debugAdapterPath": {
"description": "Path (fully qualified) to the python debug adapter executable.",
"type": "string"
Expand Down Expand Up @@ -275,10 +338,61 @@
"description": "Whether to enable Sub Process debugging",
"type": "boolean"
},
"consoleName": {
"default": "Python Debug Console",
"description": "Display name of the debug console or terminal",
"type": "string"
"variablePresentation": {
"default": {},
"description": "%debugpy.debugVariablePresentation.description%",
"properties": {
"all": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.all.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"class": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.class.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"function": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.function.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"protected": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.protected.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"special": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.special.description%",
"enum": [
"inline",
"group",
"hide"
]
}
}
}
}
},
Expand Down Expand Up @@ -342,6 +456,11 @@
},
"type": "object"
},
"autoStartBrowser": {
"default": false,
"description": "Open external browser to launch the application",
"type": "boolean"
},
"console": {
"default": "integratedTerminal",
"description": "Where to launch the debug target: internal console, integrated terminal, or external terminal.",
Expand All @@ -351,6 +470,11 @@
"internalConsole"
]
},
"consoleName": {
"default": "Python Debug Console",
"description": "Display name of the debug console or terminal",
"type": "string"
},
"cwd": {
"default": "${workspaceFolder}",
"description": "Absolute path to the working directory of the program being debugged. Default is the root directory of the file (leave empty).",
Expand All @@ -360,11 +484,6 @@
"description": "Path (fully qualified) to the Python debug adapter executable.",
"type": "string"
},
"autoStartBrowser": {
"default": false,
"description": "Open external browser to launch the application",
"type": "boolean"
},
"django": {
"default": false,
"description": "Django debugging.",
Expand All @@ -388,6 +507,11 @@
"description": "Enable debugging of gevent monkey-patched code.",
"type": "boolean"
},
"guiEventLoop": {
"default": "matplotlib",
"description": "The GUI event loop that's going to run. Possible values: \"matplotlib\", \"wx\", \"qt\", \"none\", or a custom function that'll be imported and run.",
"type": "string"
},
"jinja": {
"default": null,
"description": "Jinja template debugging (e.g. Flask).",
Expand Down Expand Up @@ -500,15 +624,61 @@
"description": "Running debug program under elevated permissions (on Unix).",
"type": "boolean"
},
"guiEventLoop": {
"default": "matplotlib",
"description": "The GUI event loop that's going to run. Possible values: \"matplotlib\", \"wx\", \"qt\", \"none\", or a custom function that'll be imported and run.",
"type": "string"
},
"consoleName": {
"default": "Python Debug Console",
"description": "Display name of the debug console or terminal",
"type": "string"
"variablePresentation": {
"default": {},
"description": "%debugpy.debugVariablePresentation.description%",
"properties": {
"all": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.all.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"class": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.class.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"function": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.function.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"protected": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.protected.description%",
"enum": [
"inline",
"group",
"hide"
]
},
"special": {
"type": "string",
"default": "group",
"description" : "%debugpy.debugVariablePresentation.special.description%",
"enum": [
"inline",
"group",
"hide"
]
}
}
}
}
}
Expand Down
6 changes: 6 additions & 0 deletions package.nls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,11 @@
"debugpy.command.reportIssue.title": "Report Issue...",
"debugpy.command.viewOutput.title": "Show Output",
"debugpy.debugJustMyCode.description": "When debugging only step through user-written code. Disable this to allow stepping into library code.",
"debugpy.debugVariablePresentation.description": "Allow the user to specify the preferred presentation of variables.",
"debugpy.debugVariablePresentation.all.description": "Set preferred presentation of variables for all instances.",
"debugpy.debugVariablePresentation.class.description": "Set Class presentation of variables.",
"debugpy.debugVariablePresentation.function.description": "Set Function preferred presentation of variables.",
"debugpy.debugVariablePresentation.protected.description": "Set Protected preferred presentation of variables.",
"debugpy.debugVariablePresentation.special.description": "Set Special preferred presentation of variables.",
"debugpy.showPythonInlineValues.description": "Whether to display inline values in the editor while debugging."
}
6 changes: 6 additions & 0 deletions src/extension/debugger/configuration/resolvers/attach.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
true,
);
}
if (debugConfiguration.variablePresentation === undefined) {
debugConfiguration.variablePresentation = getConfiguration('debugpy', workspaceFolder).get<object>(
'debugVariablePresentation',
{},
);
}
debugConfiguration.showReturnValue = debugConfiguration.showReturnValue !== false;
// Pass workspace folder so we can get this when we get debug events firing.
debugConfiguration.workspaceFolder = workspaceFolder ? workspaceFolder.fsPath : undefined;
Expand Down
6 changes: 6 additions & 0 deletions src/extension/debugger/configuration/resolvers/launch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,12 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
true,
);
}
if (debugConfiguration.variablePresentation === undefined) {
debugConfiguration.variablePresentation = getConfiguration('debugpy', workspaceFolder).get<object>(
'debugVariablePresentation',
{},
);
}
// Pass workspace folder so we can get this when we get debug events firing.
debugConfiguration.workspaceFolder = workspaceFolder ? workspaceFolder.fsPath : undefined;
const debugOptions = debugConfiguration.debugOptions!;
Expand Down
63 changes: 63 additions & 0 deletions src/test/unittest/configuration/resolvers/attach.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
return debugpySettings.object;
}

function createVariablePresentationMoqConfiguration(variablePresentation: object) {
const debugpySettings = TypeMoq.Mock.ofType<WorkspaceConfiguration>();
debugpySettings
.setup((p) => p.get<object>('debugVariablePresentation', TypeMoq.It.isAny()))
.returns(() => variablePresentation);
return debugpySettings.object;
}

function setupActiveEditor(fileName: string | undefined, languageId: string) {
if (fileName) {
const textEditor = TypeMoq.Mock.ofType<TextEditor>();
Expand Down Expand Up @@ -566,6 +574,61 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
});
});

const testsForVariablePresentation = [
{
variablePresentation: {},
variablePresentationSetting: {
class: 'inline',
},
expectedResult: {},
},
{
variablePresentation: {
class: 'inline',
},
variablePresentationSetting: {
class: 'hide',
},
expectedResult: {
class: 'inline',
},
},
{
variablePresentation: undefined,
variablePresentationSetting: {
class: 'inline',
},
expectedResult: {
class: 'inline',
},
},
];
testsForVariablePresentation.forEach(async (testParams) => {
test('Ensure variablePresentation property is correctly derived from global settings', async () => {
const activeFile = 'xyz.py';
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
setupActiveEditor(activeFile, PYTHON_LANGUAGE);
const defaultWorkspace = path.join('usr', 'desktop');
setupWorkspaces([defaultWorkspace]);

const debugOptions = debugOptionsAvailable
.slice()
.concat(DebugOptions.Jinja, DebugOptions.Sudo) as DebugOptions[];

getConfigurationStub
.withArgs('debugpy', sinon.match.any)
.returns(createVariablePresentationMoqConfiguration(testParams.variablePresentationSetting));
const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...attach,
debugOptions,
variablePresentation: testParams.variablePresentation,
});
expect(debugConfig)
.to.have.property('variablePresentation')
.that.deep.equals(testParams.expectedResult); // Corrected to use deep.equals
});
});

test('Send consoleName value to debugpy as consoleTitle', async () => {
const activeFile = 'xyz.py';
const consoleName = 'My Console Name';
Expand Down
Loading
Loading