@pyscript/core 0.4.11 → 0.4.13

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pyscript/core",
-    "version": "0.4.11",
+    "version": "0.4.13",
     "type": "module",
     "description": "PyScript",
     "module": "./index.js",
@@ -42,17 +42,17 @@
     "dependencies": {
         "@ungap/with-resolvers": "^0.1.0",
         "basic-devtools": "^0.1.6",
-        "polyscript": "^0.11.3",
+        "polyscript": "^0.12.2",
         "sticky-module": "^0.1.1",
         "to-json-callback": "^0.1.1",
         "type-checked-collections": "^0.1.7"
     },
     "devDependencies": {
         "@codemirror/commands": "^6.3.3",
-        "@codemirror/lang-python": "^6.1.4",
+        "@codemirror/lang-python": "^6.1.5",
         "@codemirror/language": "^6.10.1",
         "@codemirror/state": "^6.4.1",
-        "@codemirror/view": "^6.26.0",
+        "@codemirror/view": "^6.26.1",
         "@playwright/test": "^1.42.1",
         "@rollup/plugin-commonjs": "^25.0.7",
         "@rollup/plugin-node-resolve": "^15.2.3",
@@ -62,7 +62,7 @@
         "chokidar": "^3.6.0",
         "codemirror": "^6.0.1",
         "eslint": "^8.57.0",
-        "rollup": "^4.13.1",
+        "rollup": "^4.14.0",
         "rollup-plugin-postcss": "^4.0.2",
         "rollup-plugin-string": "^3.0.0",
         "static-handler": "^0.4.3",

package/src/plugins/py-terminal.js

@@ -1,11 +1,10 @@
 // PyScript py-terminal plugin
 import { TYPES, hooks } from "../core.js";
 import { notify } from "./error.js";
-import { defineProperty } from "polyscript/exports";
+import { customObserver, defineProperty } from "polyscript/exports";
 
-const SELECTOR = [...TYPES.keys()]
-    .map((type) => `script[type="${type}"][terminal],${type}-script[terminal]`)
-    .join(",");
+// will contain all valid selectors
+const SELECTORS = [];
 
 // show the error on main and
 // stops the module from keep executing
@@ -14,8 +13,6 @@ const notifyAndThrow = (message) => {
     throw new Error(message);
 };
 
-const notParsedYet = (script) => !bootstrapped.has(script);
-
 const onceOnMain = ({ attributes: { worker } }) => !worker;
 
 const bootstrapped = new WeakSet();
@@ -25,63 +22,76 @@ let addStyle = true;
 // this callback will be serialized as string and it never needs
 // to be invoked multiple times. Each xworker here is bootstrapped
 // only once thanks to the `sync.is_pyterminal()` check.
-const workerReady = ({ interpreter, io, run }, { sync }) => {
+const workerReady = ({ interpreter, io, run, type }, { sync }) => {
     if (!sync.is_pyterminal()) return;
 
     // in workers it's always safe to grab the polyscript currentScript
-    run("from polyscript.currentScript import terminal as __terminal__");
+    // the ugly `_` dance is due MicroPython not able to import via:
+    // `from polyscript.currentScript import terminal as __terminal__`
+    run(
+        "from polyscript import currentScript as _; __terminal__ = _.terminal; del _",
+    );
 
-    // This part is inevitably duplicated as external scope
-    // can't be reached by workers out of the box.
-    // The detail is that here we use sync though, not readline.
-    const decoder = new TextDecoder();
     let data = "";
+    const { pyterminal_read, pyterminal_write } = sync;
+    const decoder = new TextDecoder();
     const generic = {
         isatty: true,
         write(buffer) {
             data = decoder.decode(buffer);
-            sync.pyterminal_write(data);
+            pyterminal_write(data);
             return buffer.length;
         },
     };
-    interpreter.setStdout(generic);
-    interpreter.setStderr(generic);
-    interpreter.setStdin({
-        isatty: true,
-        stdin: () => sync.pyterminal_read(data),
-    });
 
+    // This part works already in both Pyodide and MicroPython
     io.stderr = (error) => {
-        sync.pyterminal_write(`${error.message || error}\n`);
+        pyterminal_write(String(error.message || error));
     };
-};
 
-const pyTerminal = async () => {
-    const terminals = document.querySelectorAll(SELECTOR);
-
-    const unknown = [].filter.call(terminals, notParsedYet);
-
-    // no results will look further for runtime nodes
-    if (!unknown.length) return;
-    // early flag elements as known to avoid concurrent
-    // MutationObserver invokes of this async handler
-    else unknown.forEach(bootstrapped.add, bootstrapped);
-
-    // we currently support only one terminal as in "classic"
-    if ([].filter.call(terminals, onceOnMain).length > 1)
-        notifyAndThrow("You can use at most 1 main terminal");
-
-    // import styles lazily
-    if (addStyle) {
-        addStyle = false;
-        document.head.append(
-            Object.assign(document.createElement("link"), {
-                rel: "stylesheet",
-                href: new URL("./xterm.css", import.meta.url),
-            }),
-        );
+    // MicroPython has no code or code.interact()
+    // This part patches it in a way that simulates
+    // the code.interact() module in Pyodide.
+    if (type === "mpy") {
+        io.stdout = generic.write;
+        // tiny shim of the code module with only interact
+        // to bootstrap a REPL like environment
+        interpreter.registerJsModule("code", {
+            interact() {
+                const encoder = new TextEncoder();
+                const acc = [];
+                let input = "";
+                let length = 1;
+                io.stdout = ([c]) => {
+                    // avoid duplicating the output produced by the input
+                    if (length++ > input.length) acc.push(c);
+                };
+                interpreter.replInit();
+                (function repl() {
+                    const out = decoder.decode(new Uint8Array(acc.splice(0)));
+                    pyterminal_write(out);
+                    // print in current line only the last line produced by the REPL
+                    data = out.split("\n").at(-1);
+                    input = encoder.encode(`${pyterminal_read(data)}\r`);
+                    length = 0;
+                    for (const c of input)
+                        interpreter.replProcessChar(c);
+                    repl();
+                }());
+            },
+        });
     }
+    else {
+        interpreter.setStdout(generic);
+        interpreter.setStderr(generic);
+        interpreter.setStdin({
+            isatty: true,
+            stdin: () => pyterminal_read(data),
+        });
+    }
+};
 
+const pyTerminal = async (element) => {
     // lazy load these only when a valid terminal is found
     const [{ Terminal }, { Readline }, { FitAddon }] = await Promise.all([
         import(/* webpackIgnore: true */ "../3rd-party/xterm.js"),
@@ -89,118 +99,135 @@ const pyTerminal = async () => {
         import(/* webpackIgnore: true */ "../3rd-party/xterm_addon-fit.js"),
     ]);
 
-    for (const element of unknown) {
-        // hopefully to be removed in the near future!
-        if (element.matches('script[type="mpy"],mpy-script'))
-            notifyAndThrow("Unsupported terminal.");
-
-        const readline = new Readline();
-
-        // common main thread initialization for both worker
-        // or main case, bootstrapping the terminal on its target
-        const init = (options) => {
-            let target = element;
-            const selector = element.getAttribute("target");
-            if (selector) {
-                target =
-                    document.getElementById(selector) ||
-                    document.querySelector(selector);
-                if (!target) throw new Error(`Unknown target ${selector}`);
-            } else {
-                target = document.createElement("py-terminal");
-                target.style.display = "block";
-                element.after(target);
-            }
-            const terminal = new Terminal({
-                theme: {
-                    background: "#191A19",
-                    foreground: "#F5F2E7",
-                },
-                ...options,
-            });
-            const fitAddon = new FitAddon();
-            terminal.loadAddon(fitAddon);
-            terminal.loadAddon(readline);
-            terminal.open(target);
-            fitAddon.fit();
-            terminal.focus();
-            defineProperty(element, "terminal", { value: terminal });
-            return terminal;
-        };
-
-        // branch logic for the worker
-        if (element.hasAttribute("worker")) {
-            // add a hook on the main thread to setup all sync helpers
-            // also bootstrapping the XTerm target on main *BUT* ...
-            hooks.main.onWorker.add(function worker(_, xworker) {
-                // ... as multiple workers will add multiple callbacks
-                // be sure no xworker is ever initialized twice!
-                if (bootstrapped.has(xworker)) return;
-                bootstrapped.add(xworker);
-
-                // still cleanup this callback for future scripts/workers
-                hooks.main.onWorker.delete(worker);
-
-                init({
-                    disableStdin: false,
-                    cursorBlink: true,
-                    cursorStyle: "block",
-                });
-
-                xworker.sync.is_pyterminal = () => true;
-                xworker.sync.pyterminal_read = readline.read.bind(readline);
-                xworker.sync.pyterminal_write = readline.write.bind(readline);
+    const readline = new Readline();
+
+    // common main thread initialization for both worker
+    // or main case, bootstrapping the terminal on its target
+    const init = (options) => {
+        let target = element;
+        const selector = element.getAttribute("target");
+        if (selector) {
+            target =
+                document.getElementById(selector) ||
+                document.querySelector(selector);
+            if (!target) throw new Error(`Unknown target ${selector}`);
+        } else {
+            target = document.createElement("py-terminal");
+            target.style.display = "block";
+            element.after(target);
+        }
+        const terminal = new Terminal({
+            theme: {
+                background: "#191A19",
+                foreground: "#F5F2E7",
+            },
+            ...options,
+        });
+        const fitAddon = new FitAddon();
+        terminal.loadAddon(fitAddon);
+        terminal.loadAddon(readline);
+        terminal.open(target);
+        fitAddon.fit();
+        terminal.focus();
+        defineProperty(element, "terminal", { value: terminal });
+        return terminal;
+    };
+
+    // branch logic for the worker
+    if (element.hasAttribute("worker")) {
+        // add a hook on the main thread to setup all sync helpers
+        // also bootstrapping the XTerm target on main *BUT* ...
+        hooks.main.onWorker.add(function worker(_, xworker) {
+            // ... as multiple workers will add multiple callbacks
+            // be sure no xworker is ever initialized twice!
+            if (bootstrapped.has(xworker)) return;
+            bootstrapped.add(xworker);
+
+            // still cleanup this callback for future scripts/workers
+            hooks.main.onWorker.delete(worker);
+
+            init({
+                disableStdin: false,
+                cursorBlink: true,
+                cursorStyle: "block",
             });
 
-            // setup remote thread JS/Python code for whenever the
-            // worker is ready to become a terminal
-            hooks.worker.onReady.add(workerReady);
-        } else {
-            // in the main case, just bootstrap XTerm without
-            // allowing any input as that's not possible / awkward
-            hooks.main.onReady.add(function main({ interpreter, io, run }) {
-                console.warn("py-terminal is read only on main thread");
-                hooks.main.onReady.delete(main);
-
-                // on main, it's easy to trash and clean the current terminal
-                globalThis.__py_terminal__ = init({
-                    disableStdin: true,
-                    cursorBlink: false,
-                    cursorStyle: "underline",
-                });
-                run("from js import __py_terminal__ as __terminal__");
-                delete globalThis.__py_terminal__;
-
-                // This part is inevitably duplicated as external scope
-                // can't be reached by workers out of the box.
-                // The detail is that here we use readline here, not sync.
-                const decoder = new TextDecoder();
-                let data = "";
-                const generic = {
-                    isatty: true,
-                    write(buffer) {
-                        data = decoder.decode(buffer);
-                        readline.write(data);
-                        return buffer.length;
-                    },
-                };
-                interpreter.setStdout(generic);
-                interpreter.setStderr(generic);
-                interpreter.setStdin({
-                    isatty: true,
-                    stdin: () => readline.read(data),
-                });
-
-                io.stderr = (error) => {
-                    readline.write(`${error.message || error}\n`);
+            xworker.sync.is_pyterminal = () => true;
+            xworker.sync.pyterminal_read = readline.read.bind(readline);
+            xworker.sync.pyterminal_write = readline.write.bind(readline);
+        });
+
+        // setup remote thread JS/Python code for whenever the
+        // worker is ready to become a terminal
+        hooks.worker.onReady.add(workerReady);
+    } else {
+        // in the main case, just bootstrap XTerm without
+        // allowing any input as that's not possible / awkward
+        hooks.main.onReady.add(function main({ interpreter, io, run, type }) {
+            console.warn("py-terminal is read only on main thread");
+            hooks.main.onReady.delete(main);
+
+            // on main, it's easy to trash and clean the current terminal
+            globalThis.__py_terminal__ = init({
+                disableStdin: true,
+                cursorBlink: false,
+                cursorStyle: "underline",
+            });
+            run("from js import __py_terminal__ as __terminal__");
+            delete globalThis.__py_terminal__;
+
+            io.stderr = (error) => {
+                readline.write(String(error.message || error));
+            };
+
+            if (type === "mpy") {
+                interpreter.setStdin = Object;  // as no-op
+                interpreter.setStderr = Object; // as no-op
+                interpreter.setStdout = ({ write }) => {
+                    io.stdout = write;
                 };
+            }
+
+            let data = "";
+            const decoder = new TextDecoder();
+            const generic = {
+                isatty: true,
+                write(buffer) {
+                    data = decoder.decode(buffer);
+                    readline.write(data);
+                    return buffer.length;
+                },
+            };
+            interpreter.setStdout(generic);
+            interpreter.setStderr(generic);
+            interpreter.setStdin({
+                isatty: true,
+                stdin: () => readline.read(data),
             });
-        }
+        });
     }
 };
 
-const mo = new MutationObserver(pyTerminal);
-mo.observe(document, { childList: true, subtree: true });
+for (const key of TYPES.keys()) {
+    const selector = `script[type="${key}"][terminal],${key}-script[terminal]`;
+    SELECTORS.push(selector);
+    customObserver.set(selector, async (element) => {
+        // we currently support only one terminal on main as in "classic"
+        const terminals = document.querySelectorAll(SELECTORS.join(","));
+        if ([].filter.call(terminals, onceOnMain).length > 1)
+            notifyAndThrow("You can use at most 1 main terminal");
+
+        // import styles lazily
+        if (addStyle) {
+            addStyle = false;
+            document.head.append(
+                Object.assign(document.createElement("link"), {
+                    rel: "stylesheet",
+                    href: new URL("./xterm.css", import.meta.url),
+                }),
+            );
+        }
 
-// try to check the current document ASAP
-export default pyTerminal();
+        await pyTerminal(element);
+    });
+}

package/types/plugins/py-terminal.d.ts

@@ -1,2 +1 @@
-declare const _default: Promise<void>;
-export default _default;
+export {};