Add inlie provider

Author: paulacamargo25

src/extension/common/vscodeapi.ts

@@ -128,3 +128,7 @@ export function startDebugging(
 ) {
     debug.startDebugging(folder, nameOrConfiguration, parentSession);
 }
+
+export function customRequest(command: string, args?: any): any {
+    return debug.activeDebugSession?.customRequest(command, args);
+}

src/extension/debugger/inlineValue/pythonInlineValueProvider.ts

@@ -1,68 +1,93 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-import { commands, debug, InlineValue, InlineValueContext, InlineValueEvaluatableExpression, InlineValuesProvider, InlineValueText, InlineValueVariableLookup,
-    Range, TextDocument } from "vscode";
-import { executeCommand } from "../../common/vscodeapi";
-
+import {
+    debug,
+    InlineValue,
+    InlineValueContext,
+    InlineValuesProvider,
+    Range,
+    TextDocument,
+    InlineValueVariableLookup,
+} from 'vscode';
+import { customRequest } from '../../common/vscodeapi';
 
 export class PythonInlineValueProvider implements InlineValuesProvider {
+    public async provideInlineValues(
+        document: TextDocument,
+        viewPort: Range,
+        context: InlineValueContext,
+    ): Promise<InlineValue[]> {
+        let scopesRequest = await customRequest('scopes', { frameId: context.frameId });
+        let variablesRequest = await customRequest('variables', {
+            variablesReference: scopesRequest.scopes[0].variablesReference,
+        });
 
-    public async provideInlineValues(document: TextDocument, viewPort: Range, context: InlineValueContext): Promise<InlineValue[]> {
-        console.log("inline provider");
-        let a = JSON.stringify(context);
-        const allValues: InlineValue[] = [];
-
-			for (let l = 0; l <= context.stoppedLocation.end.line; l++) {
-				const line = document.lineAt(l);
-                var re = /\b[a-zA-Z_][a-zA-Z0-9_]*\b/g;
-				do {
-					var m = re.exec(line.text);
-					if (m) {
-						const varName = m[0];
-						const rng = new Range(l, m.index, l, m.index + varName.length);
+        //https://docs.python.org/3/reference/lexical_analysis.html#keywords
+        const pythonKeywords = [
+            'False',
+            'await',
+            'else',
+            'import ',
+            'pass',
+            'None',
+            'break',
+            'except',
+            'in',
+            'raise',
+            'True',
+            'class',
+            'finally',
+            'is',
+            'return',
+            'and',
+            'continue',
+            'for',
+            'lambda',
+            'try',
+            'as',
+            'def',
+            'from',
+            'nonlocal',
+            'while',
+            'assert',
+            'del',
+            'global',
+            'not',
+            'with',
+            'async',
+            'elif',
+            'if',
+            'or',
+            'yield',
+        ];
 
-						//allValues.push(new vscode.InlineValueText(r, `${varName}: some value`));
-						allValues.push(new InlineValueVariableLookup(rng, varName));
-						//allValues.push(new vscode.InlineValueEvaluatableExpression(r, varName));
-					}
-				} while (m);
-			}
+        const pythonVariables: any[] = variablesRequest.variables
+            .filter((variable: any) => variable.type)
+            .map((variable: any) => variable.name);
 
-			return allValues;
-        // let variables = await resolveInlineVariables({
-        //     uri: document.uri.toString(),
-        //     viewPort: viewPort,
-        //     stoppedLocation: context.stoppedLocation,
-        // });
+        //VariableRegex for matching variables names in a python file, excluding strings
+        let variableRegex = /(?<!['"\w])\b[a-zA-Z_][a-zA-Z0-9_]*\b(?![^"\n]*"(?:(?:[^"\n]*"){2})*[^"\n]*$)/g;
+        const allValues: InlineValue[] = [];
+        for (let l = viewPort.start.line; l <= viewPort.end.line; l++) {
+            const line = document.lineAt(l);
+            // Skip comments
+            if (line.text.trimStart().startsWith('#')) {
+                continue;
+            }
 
-        return [];
+            for (let match = variableRegex.exec(line.text); match; match = variableRegex.exec(line.text)) {
+                let varName = match[0];
+                // Skip python keywords
+                if (pythonKeywords.includes(varName)) {
+                    continue;
+                }
+                if (pythonVariables.includes(varName)) {
+                    const rng = new Range(l, match.index, l, match.index + varName.length);
+                    allValues.push(new InlineValueVariableLookup(rng, varName, false));
+                }
+            }
+        }
+        return allValues;
     }
 }
-
-// tslint:disable-next-line:interface-name
-export interface InlineParams {
-    uri: string;
-    viewPort?: Range;
-    stoppedLocation: Range;
-}
-
-// tslint:disable-next-line:interface-name
-export enum InlineKind {
-    VariableLookup = 0,
-    Evaluation = 1,
-}
-
-// tslint:disable-next-line:interface-name
-export interface InlineVariable {
-    range: Range;
-    name: string;
-    kind: InlineKind;
-    expression: string;
-    declaringClass: string;
-}
-
-export async function resolveInlineVariables(inlineParams: InlineParams): Promise<InlineVariable[]> {
-    debug.startDebugging;
-    return <InlineVariable[]> await executeCommand("vscode.debug.resolveInlineVariables", JSON.stringify(inlineParams));
-}

src/extension/extensionInit.ts

@@ -137,7 +137,7 @@ export async function registerDebugger(context: IExtensionContext): Promise<IExt
     context.subscriptions.push(
         debug.registerDebugAdapterDescriptorFactory(DebuggerTypeName, debugAdapterDescriptorFactory),
     );
-    
+
     context.subscriptions.push(
         debug.onDidStartDebugSession((debugSession) => {
             const shouldTerminalFocusOnStart = getConfiguration('python', debugSession.workspaceFolder?.uri)?.terminal
@@ -208,7 +208,9 @@ export async function registerDebugger(context: IExtensionContext): Promise<IExt
         }),
     );
 
-    context.subscriptions.push(languages.registerInlineValuesProvider({language: 'python'}, new PythonInlineValueProvider()));
+    context.subscriptions.push(
+        languages.registerInlineValuesProvider({ language: 'python' }, new PythonInlineValueProvider()),
+    );
 
     return buildApi();
 }