@pyscript/core 0.2.10 → 0.3.1

package/src/plugins/py-terminal.js

@@ -0,0 +1,158 @@
+// PyScript py-terminal plugin
+import { TYPES, hooks } from "../core.js";
+
+const CDN = "https://cdn.jsdelivr.net/npm/xterm";
+const XTERM = "5.3.0";
+const XTERM_READLINE = "1.1.1";
+const SELECTOR = [...TYPES.keys()]
+    .map((type) => `script[type="${type}"][terminal],${type}-script[terminal]`)
+    .join(",");
+
+const pyTerminal = async () => {
+    const terminals = document.querySelectorAll(SELECTOR);
+
+    // no results will look further for runtime nodes
+    if (!terminals.length) return;
+
+    // we currently support only one terminal as in "classic"
+    if (terminals.length > 1)
+        console.warn("Unable to satisfy multiple terminals");
+
+    // if we arrived this far, let's drop the MutationObserver
+    mo.disconnect();
+
+    const [element] = terminals;
+    // hopefully to be removed in the near future!
+    if (element.matches('script[type="mpy"],mpy-script'))
+        throw new Error("Unsupported terminal");
+
+    // import styles once and lazily (only on valid terminal)
+    if (!document.querySelector(`link[href^="${CDN}"]`)) {
+        document.head.append(
+            Object.assign(document.createElement("link"), {
+                rel: "stylesheet",
+                href: `${CDN}@${XTERM}/css/xterm.min.css`,
+            }),
+        );
+    }
+
+    // lazy load these only when a valid terminal is found
+    const [{ Terminal }, { Readline }] = await Promise.all([
+        import(/* webpackIgnore: true */ `${CDN}@${XTERM}/+esm`),
+        import(
+            /* webpackIgnore: true */ `${CDN}-readline@${XTERM_READLINE}/+esm`
+        ),
+    ]);
+
+    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(`${element.type}-terminal`);
+            target.style.display = "block";
+            element.after(target);
+        }
+        const terminal = new Terminal({
+            theme: {
+                background: "#191A19",
+                foreground: "#F5F2E7",
+            },
+            ...options,
+        });
+        terminal.loadAddon(readline);
+        terminal.open(target);
+        terminal.focus();
+    };
+
+    // branch logic for the worker
+    if (element.hasAttribute("worker")) {
+        // when the remote thread onReady triggers:
+        // setup the interpreter stdout and stderr
+        const workerReady = ({ interpreter }, { sync }) => {
+            sync.pyterminal_drop_hooks();
+            const decoder = new TextDecoder();
+            const generic = {
+                isatty: true,
+                write(buffer) {
+                    sync.pyterminal_write(decoder.decode(buffer));
+                    return buffer.length;
+                },
+            };
+            interpreter.setStdout(generic);
+            interpreter.setStderr(generic);
+        };
+
+        // run in python code able to replace builtins.input
+        // using the xworker.sync non blocking prompt
+        const codeBefore = `
+            import builtins
+            from pyscript import sync as _sync
+
+            builtins.input = lambda prompt: _sync.pyterminal_read(prompt)
+        `;
+
+        // at the end of the code, make the terminal interactive
+        const codeAfter = `
+            import code as _code
+            _code.interact()
+        `;
+
+        // add a hook on the main thread to setup all sync helpers
+        // also bootstrapping the XTerm target on main
+        hooks.main.onWorker.add(function worker(_, xworker) {
+            hooks.main.onWorker.delete(worker);
+            init({
+                disableStdin: false,
+                cursorBlink: true,
+                cursorStyle: "block",
+            });
+            xworker.sync.pyterminal_read = readline.read.bind(readline);
+            xworker.sync.pyterminal_write = readline.write.bind(readline);
+            // allow a worker to drop main thread hooks ASAP
+            xworker.sync.pyterminal_drop_hooks = () => {
+                hooks.worker.onReady.delete(workerReady);
+                hooks.worker.codeBeforeRun.delete(codeBefore);
+                hooks.worker.codeAfterRun.delete(codeAfter);
+            };
+        });
+
+        // setup remote thread JS/Python code for whenever the
+        // worker is ready to become a terminal
+        hooks.worker.onReady.add(workerReady);
+        hooks.worker.codeBeforeRun.add(codeBefore);
+        hooks.worker.codeAfterRun.add(codeAfter);
+    } else {
+        // in the main case, just bootstrap XTerm without
+        // allowing any input as that's not possible / awkward
+        hooks.main.onReady.add(function main({ io }) {
+            console.warn("py-terminal is read only on main thread");
+            hooks.main.onReady.delete(main);
+            init({
+                disableStdin: true,
+                cursorBlink: false,
+                cursorStyle: "underline",
+            });
+            io.stdout = (value) => {
+                readline.write(`${value}\n`);
+            };
+            io.stderr = (error) => {
+                readline.write(`${error.message || error}\n`);
+            };
+        });
+    }
+};
+
+const mo = new MutationObserver(pyTerminal);
+mo.observe(document, { childList: true, subtree: true });
+
+// try to check the current document ASAP
+export default pyTerminal();

package/src/plugins-helper.js

@@ -0,0 +1,26 @@
+import { defineProperty } from "polyscript/exports";
+
+// helper for all script[type="py"] out there
+const before = (script) => {
+    defineProperty(document, "currentScript", {
+        configurable: true,
+        get: () => script,
+    });
+};
+
+const after = () => {
+    delete document.currentScript;
+};
+
+// common life-cycle handlers for any node
+export default async (main, wrap, element, hook) => {
+    const isAsync = hook.endsWith("Async");
+    const isBefore = hook.startsWith("onBefore");
+    // make it possible to reach the current target node via Python
+    // or clean up for other scripts executing around this one
+    (isBefore ? before : after)(element);
+    for (const fn of main(hook)) {
+        if (isAsync) await fn(wrap, element);
+        else fn(wrap, element);
+    }
+};

package/src/plugins.js

@@ -1,4 +1,5 @@
 // ⚠️ This file is an artifact: DO NOT MODIFY
 export default {
     error: () => import(/* webpackIgnore: true */ "./plugins/error.js"),
+    ["py-terminal"]: () => import(/* webpackIgnore: true */ "./plugins/py-terminal.js"),
 };

package/src/stdlib.js

@@ -10,16 +10,22 @@ import pyscript from "./stdlib/pyscript.js";
 
 const { entries } = Object;
 
-const python = ["from pathlib import Path as _Path"];
+const python = [
+    "import os as _os",
+    "from pathlib import Path as _Path",
+    "_path = None",
+];
 
 const write = (base, literal) => {
     for (const [key, value] of entries(literal)) {
-        const path = `_Path("${base}/${key}")`;
+        python.push(`_path = _Path("${base}/${key}")`);
         if (typeof value === "string") {
             const code = JSON.stringify(value);
-            python.push(`${path}.write_text(${code})`);
+            python.push(`_path.write_text(${code})`);
         } else {
-            python.push(`${path}.mkdir(parents=True, exist_ok=True)`);
+            // @see https://github.com/pyscript/pyscript/pull/1813#issuecomment-1781502909
+            python.push(`if not _os.path.exists("${base}/${key}"):`);
+            python.push("    _path.mkdir(parents=True, exist_ok=True)");
             write(`${base}/${key}`, value);
         }
     }
@@ -28,6 +34,8 @@ const write = (base, literal) => {
 write(".", pyscript);
 
 python.push("del _Path");
+python.push("del _path");
+python.push("del _os");
 python.push("\n");
 
 export default python.join("\n");

package/types/core.d.ts

@@ -1,4 +1,6 @@
+import TYPES from "./types.js";
 declare const exportedPyWorker: any;
 declare const exportedHooks: any;
 declare const exportedConfig: any;
-export { exportedPyWorker as PyWorker, exportedHooks as hooks, exportedConfig as config };
+declare const exportedWhenDefined: any;
+export { TYPES, exportedPyWorker as PyWorker, exportedHooks as hooks, exportedConfig as config, exportedWhenDefined as whenDefined };

package/types/hooks.d.ts

@@ -1,13 +1,38 @@
-declare namespace _default {
-    let onInterpreterReady: Set<Function>;
-    let onBeforeRun: Set<Function>;
-    let onBeforeRunAsync: Set<Function>;
-    let onAfterRun: Set<Function>;
-    let onAfterRunAsync: Set<Function>;
-    let onWorkerReady: Set<Function>;
-    let codeBeforeRunWorker: Set<string>;
-    let codeBeforeRunWorkerAsync: Set<string>;
-    let codeAfterRunWorker: Set<string>;
-    let codeAfterRunWorkerAsync: Set<string>;
+export function main(name: any): any;
+export function worker(name: any): any;
+export function codeFor(branch: any): {};
+export function createFunction(self: any, name: any): any;
+export namespace hooks {
+    namespace main {
+        let onWorker: Set<Function>;
+        let onReady: Set<Function>;
+        let onBeforeRun: Set<Function>;
+        let onBeforeRunAsync: Set<Function>;
+        let onAfterRun: Set<Function>;
+        let onAfterRunAsync: Set<Function>;
+        let codeBeforeRun: Set<string>;
+        let codeBeforeRunAsync: Set<string>;
+        let codeAfterRun: Set<string>;
+        let codeAfterRunAsync: Set<string>;
+    }
+    namespace worker {
+        let onReady_1: Set<Function>;
+        export { onReady_1 as onReady };
+        let onBeforeRun_1: Set<Function>;
+        export { onBeforeRun_1 as onBeforeRun };
+        let onBeforeRunAsync_1: Set<Function>;
+        export { onBeforeRunAsync_1 as onBeforeRunAsync };
+        let onAfterRun_1: Set<Function>;
+        export { onAfterRun_1 as onAfterRun };
+        let onAfterRunAsync_1: Set<Function>;
+        export { onAfterRunAsync_1 as onAfterRunAsync };
+        let codeBeforeRun_1: Set<string>;
+        export { codeBeforeRun_1 as codeBeforeRun };
+        let codeBeforeRunAsync_1: Set<string>;
+        export { codeBeforeRunAsync_1 as codeBeforeRunAsync };
+        let codeAfterRun_1: Set<string>;
+        export { codeAfterRun_1 as codeAfterRun };
+        let codeAfterRunAsync_1: Set<string>;
+        export { codeAfterRunAsync_1 as codeAfterRunAsync };
+    }
 }
-export default _default;

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

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

package/types/plugins-helper.d.ts

@@ -0,0 +1,2 @@
+declare function _default(main: any, wrap: any, element: any, hook: any): Promise<void>;
+export default _default;

package/types/plugins.d.ts

@@ -1,4 +1,5 @@
-declare namespace _default {
-    function error(): Promise<typeof import("./plugins/error.js")>;
-}
+declare const _default: {
+    error: () => Promise<typeof import("./plugins/error.js")>;
+    "py-terminal": () => Promise<typeof import("./plugins/py-terminal.js")>;
+};
 export default _default;

package/dist/error-0_IesYFM.js

@@ -1,2 +0,0 @@
-import{hooks as e}from"./core.js";function r(e){const r=document.createElement("div");r.className="py-error",r.textContent=e,r.style.cssText="\n    border: 1px solid red;\n    background: #ffdddd;\n    color: black;\n    font-family: courier, monospace;\n    white-space: pre;\n    overflow-x: auto;\n    padding: 8px;\n    margin-top: 8px;\n  ",document.body.append(r)}e.onInterpreterReady.add((function o(n){e.onInterpreterReady.delete(o);const{stderr:t}=n.io;n.io.stderr=(e,...o)=>(r(e.message||e),t(e,...o)),addEventListener("error",(({message:e})=>{e.startsWith("Uncaught PythonError")&&r(e)}))}));export{r as notify};
-//# sourceMappingURL=error-0_IesYFM.js.map

package/dist/error-0_IesYFM.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-0_IesYFM.js","sources":["../src/plugins/error.js"],"sourcesContent":["// PyScript Error Plugin\nimport { hooks } from \"../core.js\";\n\nhooks.onInterpreterReady.add(function override(pyScript) {\n    // be sure this override happens only once\n    hooks.onInterpreterReady.delete(override);\n\n    // trap generic `stderr` to propagate to it regardless\n    const { stderr } = pyScript.io;\n\n    // override it with our own logic\n    pyScript.io.stderr = (error, ...rest) => {\n        notify(error.message || error);\n        // let other plugins or stderr hook, if any, do the rest\n        return stderr(error, ...rest);\n    };\n\n    // be sure uncaught Python errors are also visible\n    addEventListener(\"error\", ({ message }) => {\n        if (message.startsWith(\"Uncaught PythonError\")) notify(message);\n    });\n});\n\n// Error hook utilities\n\n// Custom function to show notifications\n\n/**\n * Add a banner to the top of the page, notifying the user of an error\n * @param {string} message\n */\nexport function notify(message) {\n    const div = document.createElement(\"div\");\n    div.className = \"py-error\";\n    div.textContent = message;\n    div.style.cssText = `\n    border: 1px solid red;\n    background: #ffdddd;\n    color: black;\n    font-family: courier, monospace;\n    white-space: pre;\n    overflow-x: auto;\n    padding: 8px;\n    margin-top: 8px;\n  `;\n    document.body.append(div);\n}\n"],"names":["notify","message","div","document","createElement","className","textContent","style","cssText","body","append","hooks","onInterpreterReady","add","override","pyScript","delete","stderr","io","error","rest","addEventListener","startsWith"],"mappings":"kCA+BO,SAASA,EAAOC,GACnB,MAAMC,EAAMC,SAASC,cAAc,OACnCF,EAAIG,UAAY,WAChBH,EAAII,YAAcL,EAClBC,EAAIK,MAAMC,QAAU,6MAUpBL,SAASM,KAAKC,OAAOR,EACzB,CA3CAS,EAAMC,mBAAmBC,KAAI,SAASC,EAASC,GAE3CJ,EAAMC,mBAAmBI,OAAOF,GAGhC,MAAMG,OAAEA,GAAWF,EAASG,GAG5BH,EAASG,GAAGD,OAAS,CAACE,KAAUC,KAC5BpB,EAAOmB,EAAMlB,SAAWkB,GAEjBF,EAAOE,KAAUC,IAI5BC,iBAAiB,SAAS,EAAGpB,cACrBA,EAAQqB,WAAW,yBAAyBtB,EAAOC,EAAQ,GAEvE"}