Merge pull request #131 from paulober/develop

Patch v3.2.5

Author: paulober

CHANGELOG.md

@@ -9,6 +9,14 @@ All notable changes to the "MicroPico" extension will be documented in this file
 
 ---
 
+## [3.2.5] - 2023-09-04
+
+# Changed
+- Updated stubs to v1.20.0-441 unstable
+- Minimum VS Code version is now v1.81.1
+- Updated dependencies
+- Added official Python extension as dependency
+
 ## [3.2.4] - 2023-08-16
 
 # Changed

README.md

@@ -4,7 +4,7 @@
 
 "MicroPico" is a Visual Studio Code extension designed to simplify and accelerate the development of MicroPython projects for the Raspberry Pi Pico and Pico W boards. This tool streamlines the coding process, providing code highlighting, auto-completion, code snippets, and project management features, all tailored for the seamless development experience with MicroPython on Raspberry Pi Pico and Pico W microcontrollers.
 
-> __Auto-completion based on Raspberry Pi Pico W MicroPython firmware: [rp2-pico-w-20230426-v1.20.0.uf2](https://micropython.org/resources/firmware/rp2-pico-w-20230426-v1.20.0.uf2)__
+> __Auto-completion based on Raspberry Pi Pico W MicroPython firmware: [RPI_PICO_W-20230904-unstable-v1.20.0-441-gbf35eefc6.uf2](https://micropython.org/resources/firmware/RPI_PICO_W-20230904-unstable-v1.20.0-441-gbf35eefc6.uf2)__
 
 Works with:
 | Platform | x64 | arm64 | armhf |

package-lock.json

@@ -2,7 +2,7 @@
   "name": "pico-w-go",
   "displayName": "MicroPico",
   "description": "Auto-completion, remote workspace and a REPL console integration for the Raspberry Pi Pico (W) with MicroPython firmware.",
-  "version": "3.2.4",
+  "version": "3.2.5",
   "publisher": "paulober",
   "license": "MPL-2.0",
   "homepage": "https://github.com/paulober/MicroPico/blob/main/README.md",
@@ -20,7 +20,7 @@
   },
   "markdown": "github",
   "engines": {
-    "vscode": "^1.76.0",
+    "vscode": "^1.81.1",
     "node": ">=16.17.1"
   },
   "keywords": [
@@ -62,6 +62,9 @@
     "arm64",
     "arm"
   ],
+  "extensionDependencies": [
+		"ms-python.python"
+	],
   "minimumNodeVersion": 16,
   "contributes": {
     "commands": [
@@ -508,28 +511,29 @@
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-terser": "^0.4.3",
-    "@rollup/plugin-typescript": "^11.1.2",
+    "@rollup/plugin-typescript": "^11.1.3",
     "@types/fs-extra": "^11.0.1",
     "@types/lodash": "^4.14.197",
     "@types/mocha": "^10.0.1",
     "@types/node": "^16.x",
-    "@types/uuid": "^9.0.2",
-    "@types/vscode": "^1.76.0",
-    "@typescript-eslint/eslint-plugin": "^6.4.0",
-    "@typescript-eslint/parser": "^6.4.0",
+    "@types/uuid": "^9.0.3",
+    "@types/vscode": "^1.81.0",
+    "@typescript-eslint/eslint-plugin": "^6.5.0",
+    "@typescript-eslint/parser": "^6.5.0",
     "@vscode/test-electron": "^2.3.4",
-    "eslint": "^8.47.0",
+    "eslint": "^8.48.0",
     "eslint-config-prettier": "^9.0.0",
     "glob": "^9.3.4",
     "mocha": "^10.2.0",
-    "rollup": "^3.28.0",
-    "rollup-plugin-copy": "^3.4.0",
-    "typescript": "^5.1.6"
+    "rollup": "^3.28.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
     "@paulober/pyboard-serial-com": "^1.5.3",
+    "@vscode/python-extension": "^1.0.4",
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "rimraf": "^5.0.1",

package.json

@@ -21,7 +21,10 @@ export default {
     plugins: [
         copy({
             targets: [
-                { src: 'node_modules/@paulober/pyboard-serial-com/scripts', dest: 'dist/' },
+                {
+                    src: 'node_modules/@paulober/pyboard-serial-com/scripts',
+                    dest: 'dist/'
+                },
             ],
         }),
         nodeResolve({

rollup.config.mjs

@@ -49,12 +49,17 @@ export default class Activator {
     context: vscode.ExtensionContext
   ): Promise<UI | undefined> {
     const settings = new Settings(context.workspaceState);
-    const pyCommand = settings.pythonExecutable ?? (await getPythonCommand());
-    settings.pythonExecutable = pyCommand;
+    const workspaceFolder = vscode.workspace.workspaceFolders?.[0];
+    const pyCommands =
+      (settings.pythonExecutable ? [settings.pythonExecutable] : undefined) ??
+      (await getPythonCommand(workspaceFolder?.uri)).path ??
+      [];
 
-    if (pyCommand === undefined) {
+    if (pyCommands.length === 0) {
       const choice = await vscode.window.showErrorMessage(
-        "Python3 is not installed or not in the system's PATH. Alernatively " +
+        "Python3 is not installed or not in the system's PATH. " +
+          "You can select a python installation thought the " +
+          "vscode Python Extension. Alernatively " +
           "you can set the pythonPath setting to the path of your " +
           "Python3 executable in the settings.",
         "Open Settings"
@@ -66,9 +71,9 @@ export default class Activator {
 
       return;
     }
+    settings.pythonExecutable = pyCommands[0];
 
-    const isInstalled = await installPyserial(pyCommand);
-
+    const isInstalled = await installPyserial(settings.pythonExecutable);
     if (!isInstalled) {
       this.logger.error("Failed to install pyserial pip package.");
       void vscode.window.showErrorMessage(
@@ -102,9 +107,8 @@ export default class Activator {
           "No COM device found. Please check your connection or ports and " +
             "try again. Alternatively you can set the manualComDevice " +
             "setting to the path of your COM device in the settings but " +
-            "make sure to deactivate autoConnect. For Linux users: make " +
-            "sure your user is in dialout group: " +
-            "sudo usermod -a -G dialout $USER",
+            "make sure to deactivate autoConnect. For Linux users: check you " +
+            "sufficient permission to access the device file of the Pico.",
           "Open Settings"
         )
         .then((choice: "Open Settings" | undefined) => {
@@ -121,7 +125,7 @@ export default class Activator {
       this.comDevice ?? "default",
       this.pyboardOnError.bind(this),
       this.pyboardOnExit.bind(this),
-      pyCommand
+      settings.pythonExecutable
     );
 
     this.setupAutoConnect(settings);

src/activator.mts

@@ -1,42 +1,43 @@
+import {
+  PythonExtension,
+  type ResolvedEnvironment,
+} from "@vscode/python-extension";
 import { exec } from "child_process";
 import { readFile, stat, writeFile } from "fs/promises";
-import { platform } from "os";
+import type { Uri } from "vscode";
+import { resolveVariables } from "./settings.mjs";
 
-const pythonCommands = {
-  win32: "python.exe",
-  darwin: "python3",
-  linux: "python3",
-};
-
-export async function getPythonCommand(): Promise<string | undefined> {
-  const system = platform();
-  let currentPlatform: keyof typeof pythonCommands;
+export interface IInterpreterDetails {
+  path?: string[];
+  resource?: Uri;
+}
 
-  if (system in pythonCommands) {
-    currentPlatform = system as keyof typeof pythonCommands;
-  } else {
-    console.error(`Unsupported platform: ${system}`);
+function checkVersion(environment: ResolvedEnvironment): boolean {
+  const version = environment.version;
 
-    return undefined;
+  if (version?.major === 3 && version?.minor >= 9) {
+    return true;
   }
 
-  const pythonCommand: string | undefined = pythonCommands[currentPlatform];
+  return false;
+}
 
-  return new Promise(resolve => {
-    exec(
-      `${pythonCommand} --version`,
-      { timeout: 2500 },
-      (error, stdout, stderr) => {
-        if (error) {
-          console.error(`Error executing ${pythonCommand}: ${error.message}`);
-          resolve(undefined);
-        } else {
-          console.debug(`Python version: ${stdout || stderr}`);
-          resolve(pythonCommand);
-        }
-      }
-    );
-  });
+export async function getPythonCommand(
+  resource?: Uri
+): Promise<IInterpreterDetails> {
+  const pyApi: PythonExtension = await PythonExtension.api();
+
+  const environment = await pyApi.environments.resolveEnvironment(
+    pyApi.environments.getActiveEnvironmentPath(resource)
+  );
+  if (environment?.executable.uri && checkVersion(environment)) {
+    return {
+      path: resolveVariables([environment.executable.uri.fsPath], resource),
+      resource,
+    };
+  }
+
+  return { path: undefined, resource };
 }
 
 export async function pathExists(path: string): Promise<boolean> {

src/osHelper.mts

@@ -1,5 +1,5 @@
-import type { Memento, WorkspaceConfiguration } from "vscode";
-import { window, workspace } from "vscode";
+import type { Memento, Uri, WorkspaceConfiguration } from "vscode";
+import { window, workspace as vsWorkspace } from "vscode";
 import { PyboardRunner } from "@paulober/pyboard-serial-com";
 import { extName, getProjectPath } from "./api.mjs";
 import { join, relative } from "path";
@@ -27,7 +27,7 @@ export default class Settings {
   public pythonExecutable?: string;
 
   constructor(context: Memento) {
-    this.config = workspace.getConfiguration(extName);
+    this.config = vsWorkspace.getConfiguration(extName);
 
     this.context = context;
     this.pythonExecutable = this.getString(SettingsKey.pythonPath);
@@ -198,3 +198,33 @@ export default class Settings {
     return this.getArray(SettingsKey.pyIgnore) || [];
   }
 }
+
+/**
+ * Resolve vscode variables like ${workspaceFolder} in the given value.
+ *
+ * @param value Input
+ * @param workspace The current workspace
+ * @returns The resolved value
+ */
+export function resolveVariables(value: string[], workspace?: Uri): string[] {
+  const substitutions = new Map<string, string>();
+  const home = process.env.HOME || process.env.USERPROFILE;
+  if (home) {
+    substitutions.set("${userHome}", home);
+  }
+  if (workspace) {
+    substitutions.set("${workspaceFolder}", workspace.fsPath);
+  }
+  substitutions.set("${cwd}", process.cwd());
+  (vsWorkspace.workspaceFolders ?? []).forEach(w => {
+    substitutions.set("${workspaceFolder:" + w.name + "}", w.uri.fsPath);
+  });
+
+  return value.map(s => {
+    for (const [key, value] of substitutions) {
+      s = s.replace(key, value);
+    }
+
+    return s;
+  });
+}

src/settings.mts

@@ -7,6 +7,10 @@ const DEL = (count: number): string => `\x1b[${count}D\x1b[1P`;
 // Ctrl+D; Ctrl+E
 const IGNORED_CHARS = ["\x04", "\x05"];
 
+/**
+ * A pseudo terminal (aka vREPL) so the serial connection can be used by
+ * other parts of the extension while the user isn't executing a command in the REPL.
+ */
 export class Terminal implements Pseudoterminal {
   private openingMessageCallback: () => Promise<string>;
 

src/terminal.mts

@@ -0,0 +1 @@
+from uplatform import *