init python support

extension/src/VisualizationBackend/PyVisualizationSupport.ts

@@ -0,0 +1,151 @@
+import {
+	DataExtractionResult,
+	DataExtractorId,
+	GraphNode,
+	GraphVisualizationData,
+} from "@hediet/debug-visualizer-data-extraction";
+import { DebugSessionProxy } from "../proxies/DebugSessionProxy";
+import {
+	DebugSessionVisualizationSupport,
+	VisualizationBackend,
+	GetVisualizationDataArgs,
+	VisualizationBackendBase,
+} from "./VisualizationBackend";
+import { Config } from "../Config";
+import { parseEvaluationResultFromGenericDebugAdapter } from "./parseEvaluationResultFromGenericDebugAdapter";
+import { FormattedMessage } from "../webviewContract";
+import { hotClass, registerUpdateReconciler } from "@hediet/node-reload";
+import { DebuggerViewProxy } from "../proxies/DebuggerViewProxy";
+
+registerUpdateReconciler(module);
+
+@hotClass(module)
+export class PyEvaluationEngine
+	implements DebugSessionVisualizationSupport {
+	constructor(
+		private readonly debuggerView: DebuggerViewProxy,
+		private readonly config: Config
+	) { }
+
+	createBackend(
+		session: DebugSessionProxy
+	): VisualizationBackend | undefined {
+
+		const supportedDebugAdapters = [
+			"python",
+		];
+
+		if (supportedDebugAdapters.indexOf(session.session.type) !== -1) {
+			return new PyVisualizationBackend(
+				session,
+				this.debuggerView,
+				this.config
+			);
+		}
+		return undefined;
+	}
+}
+
+export class PyVisualizationBackend extends VisualizationBackendBase {
+	public readonly expressionLanguageId = "python";
+
+	constructor(
+		debugSession: DebugSessionProxy,
+		debuggerView: DebuggerViewProxy,
+		private readonly config: Config
+	) {
+		super(debugSession, debuggerView);
+	}
+
+	protected getContext(): "watch" | "repl" {
+		// we will use "repl" as default so that results are not truncated.
+		return "repl";
+	}
+
+	public async getVisualizationData({
+		expression,
+		preferredExtractorId,
+	}: GetVisualizationDataArgs): Promise<
+		| { kind: "data"; result: DataExtractionResult }
+		| { kind: "error"; message: FormattedMessage }
+	> {
+		const frameId = this.debuggerView.getActiveStackFrameId(
+			this.debugSession
+		);
+
+		const finalExpression = this.getFinalExpression({
+			expression,
+			preferredExtractorId,
+		});
+		let reply: { result: string; variablesReference: number };
+		try {
+			// inject vscodedebugvisualizer for python
+			await this.debugSession.evaluate({
+				expression: 'from vscodedebugvisualizer import visualize\ntry:\n  import debugvisualizer\nexcept ImportError:\n  pass',
+				frameId,
+				context: this.getContext(),
+			});
+
+			reply = await this.debugSession.evaluate({
+				expression: finalExpression,
+				frameId,
+				context: this.getContext(),
+			});
+
+			let result = reply.result;
+			// remove the initial escape by the the debug session e.g. `''{"kind": {"text": true}, "text": "{"asdf1\'"}''`
+			result = result.replaceAll(/\\'/g, "'");
+			result = result.replaceAll(/\\'/g, "'");
+			result = result.replaceAll(/\\\\/g, "\\")
+			result.substr(1, result.length - 2);
+
+			return parseEvaluationResultFromGenericDebugAdapter(
+				result,
+				{
+					debugAdapterType: this.debugSession.session
+						.configuration.type,
+				}
+			);
+		} catch (error) {
+			let errorTyped = error as Error;
+			if (errorTyped.message.includes("ModuleNotFoundError: No module named 'vscodedebugvisualizer'")) {
+				return {
+					kind: "error",
+					message: {
+						kind: "list",
+						items: ["Pleas make sure vscodedebugvisualizer is installed: `pip install vscodedebugvisualizer`"],
+					},
+				};
+			}
+			return {
+				kind: "error",
+				message: {
+					kind: "list",
+					items: [
+						"An error occurred while evaluating the expression:",
+						errorTyped.message,
+						`Used debug adapter: ${this.debugSession.session.configuration.type}`,
+						{
+							kind: "inlineList",
+							items: [
+								"Evaluated expression is",
+								{ kind: "code", content: finalExpression },
+							],
+						},
+					],
+				},
+			};
+		}
+	}
+
+	protected getFinalExpression(args: {
+		expression: string;
+		preferredExtractorId: DataExtractorId | undefined;
+	}): string {
+		// wrap expression with visualize function
+		let pythonInject = "";
+		pythonInject += "visualize(" + args.expression + ")";
+		return pythonInject;
+	}
+
+}