@pyscript/core 0.2.5 → 0.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pyscript/core",
-    "version": "0.2.5",
+    "version": "0.2.6",
     "type": "module",
     "description": "PyScript",
     "module": "./index.js",
@@ -33,7 +33,8 @@
     "dependencies": {
         "@ungap/with-resolvers": "^0.1.0",
         "basic-devtools": "^0.1.6",
-        "polyscript": "^0.4.8"
+        "polyscript": "^0.4.11",
+        "type-checked-collections": "^0.1.7"
     },
     "devDependencies": {
         "@rollup/plugin-node-resolve": "^15.2.1",

package/src/all-done.js

@@ -1,62 +1,17 @@
 import TYPES from "./types.js";
-import hooks from "./hooks.js";
-
-const DONE = "py:all-done";
-
-const {
-    onAfterRun,
-    onAfterRunAsync,
-    codeAfterRunWorker,
-    codeAfterRunWorkerAsync,
-} = hooks;
 
 const waitForIt = [];
-const codes = [];
-
-const codeFor = (element) => {
-    const isAsync = element.hasAttribute("async");
-    const { promise, resolve } = Promise.withResolvers();
-    const type = `${DONE}:${waitForIt.push(promise)}`;
 
-    // resolve each promise once notified
-    addEventListener(type, resolve, { once: true });
-
-    if (element.hasAttribute("worker")) {
-        const code = `
-            from pyscript import window as _w
-            _w.dispatchEvent(_w.Event.new("${type}"))
-        `;
-        if (isAsync) codeAfterRunWorkerAsync.add(code);
-        else codeAfterRunWorker.add(code);
-        return code;
+for (const [TYPE] of TYPES) {
+    const selectors = [`script[type="${TYPE}"]`, `${TYPE}-script`];
+    for (const element of document.querySelectorAll(selectors.join(","))) {
+        const { promise, resolve } = Promise.withResolvers();
+        waitForIt.push(promise);
+        element.addEventListener(`${TYPE}:done`, resolve, { once: true });
     }
-
-    // dispatch only once the ready element is the same
-    const code = (_, el) => {
-        if (el === element) dispatchEvent(new Event(type));
-    };
-
-    if (isAsync) onAfterRunAsync.add(code);
-    else onAfterRun.add(code);
-    return code;
-};
-
-const selector = [];
-for (const [TYPE] of TYPES)
-    selector.push(`script[type="${TYPE}"]`, `${TYPE}-script`);
-
-// loop over all known scripts and elements
-for (const element of document.querySelectorAll(selector.join(",")))
-    codes.push(codeFor(element));
+}
 
 // wait for all the things then cleanup
 Promise.all(waitForIt).then(() => {
-    // cleanup unnecessary hooks
-    for (const code of codes) {
-        onAfterRun.delete(code);
-        onAfterRunAsync.delete(code);
-        codeAfterRunWorker.delete(code);
-        codeAfterRunWorkerAsync.delete(code);
-    }
-    dispatchEvent(new Event(DONE));
+    dispatchEvent(new Event("py:all-done"));
 });

package/src/core.js

@@ -90,6 +90,11 @@ const exportedConfig = {};
 export { exportedConfig as config, hooks };
 
 for (const [TYPE, interpreter] of TYPES) {
+    const dispatchDone = (element, isAsync, result) => {
+        if (isAsync) result.then(() => dispatch(element, TYPE, "done"));
+        else dispatch(element, TYPE, "done");
+    };
+
     const { config, plugins, error } = configs.get(TYPE);
 
     // create a unique identifier when/if needed
@@ -137,6 +142,8 @@ for (const [TYPE, interpreter] of TYPES) {
             ...workerHooks,
             onWorkerReady(_, xworker) {
                 assign(xworker.sync, sync);
+                for (const callback of hooks.onWorkerReady)
+                    callback(_, xworker);
             },
             onBeforeRun(wrap, element) {
                 currentElement = element;
@@ -209,9 +216,13 @@ for (const [TYPE, interpreter] of TYPES) {
                     defineProperty(element, "target", { value: show });
 
                     // notify before the code runs
-                    dispatch(element, TYPE);
-                    wrap[`run${isAsync ? "Async" : ""}`](
-                        await fetchSource(element, wrap.io, true),
+                    dispatch(element, TYPE, "ready");
+                    dispatchDone(
+                        element,
+                        isAsync,
+                        wrap[`run${isAsync ? "Async" : ""}`](
+                            await fetchSource(element, wrap.io, true),
+                        ),
                     );
                 } else {
                     // resolve PyScriptElement to allow connectedCallback
@@ -244,18 +255,21 @@ for (const [TYPE, interpreter] of TYPES) {
         async connectedCallback() {
             if (!this.executed) {
                 this.executed = true;
+                const isAsync = this.hasAttribute("async");
                 const { io, run, runAsync } = await this._wrap.promise;
-                const runner = this.hasAttribute("async") ? runAsync : run;
                 this.srcCode = await fetchSource(
                     this,
                     io,
                     !this.childElementCount,
                 );
                 this.replaceChildren();
-                // notify before the code runs
-                dispatch(this, TYPE);
-                runner(this.srcCode);
                 this.style.display = "block";
+                dispatch(this, TYPE, "ready");
+                dispatchDone(
+                    this,
+                    isAsync,
+                    (isAsync ? runAsync : run)(this.srcCode),
+                );
             }
         }
     }

package/src/hooks.js

@@ -1,21 +1,28 @@
+import { typedSet } from "type-checked-collections";
+
+const SetFunction = typedSet({ typeof: "function" });
+const SetString = typedSet({ typeof: "string" });
+
 export default {
     /** @type {Set<function>} */
-    onBeforeRun: new Set(),
+    onInterpreterReady: new SetFunction(),
     /** @type {Set<function>} */
-    onBeforeRunAsync: new Set(),
+    onBeforeRun: new SetFunction(),
     /** @type {Set<function>} */
-    onAfterRun: new Set(),
+    onBeforeRunAsync: new SetFunction(),
     /** @type {Set<function>} */
-    onAfterRunAsync: new Set(),
+    onAfterRun: new SetFunction(),
     /** @type {Set<function>} */
-    onInterpreterReady: new Set(),
+    onAfterRunAsync: new SetFunction(),
 
+    /** @type {Set<function>} */
+    onWorkerReady: new SetFunction(),
     /** @type {Set<string>} */
-    codeBeforeRunWorker: new Set(),
+    codeBeforeRunWorker: new SetString(),
     /** @type {Set<string>} */
-    codeBeforeRunWorkerAsync: new Set(),
+    codeBeforeRunWorkerAsync: new SetString(),
     /** @type {Set<string>} */
-    codeAfterRunWorker: new Set(),
+    codeAfterRunWorker: new SetString(),
     /** @type {Set<string>} */
-    codeAfterRunWorkerAsync: new Set(),
+    codeAfterRunWorkerAsync: new SetString(),
 };

package/src/stdlib/pyscript/display.py

@@ -3,7 +3,7 @@ import html
 import io
 import re
 
-from pyscript.magic_js import document, window, current_target
+from pyscript.magic_js import current_target, document, window
 
 _MIME_METHODS = {
     "__repr__": "text/plain",
@@ -154,8 +154,10 @@ def display(*values, target=None, append=True):
     # if element is a <script type="py">, it has a 'target' attribute which
     # points to the visual element holding the displayed values. In that case,
     # use that.
-    if element.tagName == 'SCRIPT' and hasattr(element, 'target'):
+    if element.tagName == "SCRIPT" and hasattr(element, "target"):
         element = element.target
 
     for v in values:
+        if not append:
+            element.replaceChildren()
         _write(element, v, append=append)

package/src/stdlib/pyscript.js

@@ -2,7 +2,7 @@
 export default {
   "pyscript": {
     "__init__.py": "# Some notes about the naming conventions and the relationship between various\n# similar-but-different names.\n#\n# import pyscript\n#     this package contains the main user-facing API offered by pyscript. All\n#     the names which are supposed be used by end users should be made\n#     available in pyscript/__init__.py (i.e., this file)\n#\n# import _pyscript\n#     this is an internal module implemented in JS. It is used internally by\n#     the pyscript package, end users should not use it directly. For its\n#     implementation, grep for `interpreter.registerJsModule(\"_pyscript\",\n#     ...)` in core.js\n#\n# import js\n#     this is the JS globalThis, as exported by pyodide and/or micropython's\n#     FFIs. As such, it contains different things in the main thread or in a\n#     worker.\n#\n# import pyscript.magic_js\n#     this submodule abstracts away some of the differences between the main\n#     thread and the worker. In particular, it defines `window` and `document`\n#     in such a way that these names work in both cases: in the main thread,\n#     they are the \"real\" objects, in the worker they are proxies which work\n#     thanks to coincident.\n#\n# from pyscript import window, document\n#     these are just the window and document objects as defined by\n#     pyscript.magic_js. This is the blessed way to access them from pyscript,\n#     as it works transparently in both the main thread and worker cases.\n\nfrom pyscript.magic_js import RUNNING_IN_WORKER, window, document, sync\nfrom pyscript.display import HTML, display\n\ntry:\n    from pyscript.event_handling import when\nexcept:\n    from pyscript.util import NotSupported\n\n    when = NotSupported(\n        \"pyscript.when\",\n        \"pyscript.when currently not available with this interpreter\"\n    )\n",
-    "display.py": "import base64\nimport html\nimport io\nimport re\n\nfrom pyscript.magic_js import document, window, current_target\n\n_MIME_METHODS = {\n    \"__repr__\": \"text/plain\",\n    \"_repr_html_\": \"text/html\",\n    \"_repr_markdown_\": \"text/markdown\",\n    \"_repr_svg_\": \"image/svg+xml\",\n    \"_repr_pdf_\": \"application/pdf\",\n    \"_repr_jpeg_\": \"image/jpeg\",\n    \"_repr_png_\": \"image/png\",\n    \"_repr_latex\": \"text/latex\",\n    \"_repr_json_\": \"application/json\",\n    \"_repr_javascript_\": \"application/javascript\",\n    \"savefig\": \"image/png\",\n}\n\n\ndef _render_image(mime, value, meta):\n    # If the image value is using bytes we should convert it to base64\n    # otherwise it will return raw bytes and the browser will not be able to\n    # render it.\n    if isinstance(value, bytes):\n        value = base64.b64encode(value).decode(\"utf-8\")\n\n    # This is the pattern of base64 strings\n    base64_pattern = re.compile(\n        r\"^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$\"\n    )\n    # If value doesn't match the base64 pattern we should encode it to base64\n    if len(value) > 0 and not base64_pattern.match(value):\n        value = base64.b64encode(value.encode(\"utf-8\")).decode(\"utf-8\")\n\n    data = f\"data:{mime};charset=utf-8;base64,{value}\"\n    attrs = \" \".join(['{k}=\"{v}\"' for k, v in meta.items()])\n    return f'<img src=\"{data}\" {attrs}></img>'\n\n\ndef _identity(value, meta):\n    return value\n\n\n_MIME_RENDERERS = {\n    \"text/plain\": html.escape,\n    \"text/html\": _identity,\n    \"image/png\": lambda value, meta: _render_image(\"image/png\", value, meta),\n    \"image/jpeg\": lambda value, meta: _render_image(\"image/jpeg\", value, meta),\n    \"image/svg+xml\": _identity,\n    \"application/json\": _identity,\n    \"application/javascript\": lambda value, meta: f\"<script>{value}<\\\\/script>\",\n}\n\n\nclass HTML:\n    \"\"\"\n    Wrap a string so that display() can render it as plain HTML\n    \"\"\"\n\n    def __init__(self, html):\n        self._html = html\n\n    def _repr_html_(self):\n        return self._html\n\n\ndef _eval_formatter(obj, print_method):\n    \"\"\"\n    Evaluates a formatter method.\n    \"\"\"\n    if print_method == \"__repr__\":\n        return repr(obj)\n    elif hasattr(obj, print_method):\n        if print_method == \"savefig\":\n            buf = io.BytesIO()\n            obj.savefig(buf, format=\"png\")\n            buf.seek(0)\n            return base64.b64encode(buf.read()).decode(\"utf-8\")\n        return getattr(obj, print_method)()\n    elif print_method == \"_repr_mimebundle_\":\n        return {}, {}\n    return None\n\n\ndef _format_mime(obj):\n    \"\"\"\n    Formats object using _repr_x_ methods.\n    \"\"\"\n    if isinstance(obj, str):\n        return html.escape(obj), \"text/plain\"\n\n    mimebundle = _eval_formatter(obj, \"_repr_mimebundle_\")\n    if isinstance(mimebundle, tuple):\n        format_dict, _ = mimebundle\n    else:\n        format_dict = mimebundle\n\n    output, not_available = None, []\n    for method, mime_type in reversed(_MIME_METHODS.items()):\n        if mime_type in format_dict:\n            output = format_dict[mime_type]\n        else:\n            output = _eval_formatter(obj, method)\n\n        if output is None:\n            continue\n        elif mime_type not in _MIME_RENDERERS:\n            not_available.append(mime_type)\n            continue\n        break\n    if output is None:\n        if not_available:\n            window.console.warn(\n                f\"Rendered object requested unavailable MIME renderers: {not_available}\"\n            )\n        output = repr(output)\n        mime_type = \"text/plain\"\n    elif isinstance(output, tuple):\n        output, meta = output\n    else:\n        meta = {}\n    return _MIME_RENDERERS[mime_type](output, meta), mime_type\n\n\ndef _write(element, value, append=False):\n    html, mime_type = _format_mime(value)\n    if html == \"\\\\n\":\n        return\n\n    if append:\n        out_element = document.createElement(\"div\")\n        element.append(out_element)\n    else:\n        out_element = element.lastElementChild\n        if out_element is None:\n            out_element = element\n\n    if mime_type in (\"application/javascript\", \"text/html\"):\n        script_element = document.createRange().createContextualFragment(html)\n        out_element.append(script_element)\n    else:\n        out_element.innerHTML = html\n\n\ndef display(*values, target=None, append=True):\n    if target is None:\n        target = current_target()\n\n    element = document.getElementById(target)\n\n    # if element is a <script type=\"py\">, it has a 'target' attribute which\n    # points to the visual element holding the displayed values. In that case,\n    # use that.\n    if element.tagName == 'SCRIPT' and hasattr(element, 'target'):\n        element = element.target\n\n    for v in values:\n        _write(element, v, append=append)\n",
+    "display.py": "import base64\nimport html\nimport io\nimport re\n\nfrom pyscript.magic_js import current_target, document, window\n\n_MIME_METHODS = {\n    \"__repr__\": \"text/plain\",\n    \"_repr_html_\": \"text/html\",\n    \"_repr_markdown_\": \"text/markdown\",\n    \"_repr_svg_\": \"image/svg+xml\",\n    \"_repr_pdf_\": \"application/pdf\",\n    \"_repr_jpeg_\": \"image/jpeg\",\n    \"_repr_png_\": \"image/png\",\n    \"_repr_latex\": \"text/latex\",\n    \"_repr_json_\": \"application/json\",\n    \"_repr_javascript_\": \"application/javascript\",\n    \"savefig\": \"image/png\",\n}\n\n\ndef _render_image(mime, value, meta):\n    # If the image value is using bytes we should convert it to base64\n    # otherwise it will return raw bytes and the browser will not be able to\n    # render it.\n    if isinstance(value, bytes):\n        value = base64.b64encode(value).decode(\"utf-8\")\n\n    # This is the pattern of base64 strings\n    base64_pattern = re.compile(\n        r\"^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$\"\n    )\n    # If value doesn't match the base64 pattern we should encode it to base64\n    if len(value) > 0 and not base64_pattern.match(value):\n        value = base64.b64encode(value.encode(\"utf-8\")).decode(\"utf-8\")\n\n    data = f\"data:{mime};charset=utf-8;base64,{value}\"\n    attrs = \" \".join(['{k}=\"{v}\"' for k, v in meta.items()])\n    return f'<img src=\"{data}\" {attrs}></img>'\n\n\ndef _identity(value, meta):\n    return value\n\n\n_MIME_RENDERERS = {\n    \"text/plain\": html.escape,\n    \"text/html\": _identity,\n    \"image/png\": lambda value, meta: _render_image(\"image/png\", value, meta),\n    \"image/jpeg\": lambda value, meta: _render_image(\"image/jpeg\", value, meta),\n    \"image/svg+xml\": _identity,\n    \"application/json\": _identity,\n    \"application/javascript\": lambda value, meta: f\"<script>{value}<\\\\/script>\",\n}\n\n\nclass HTML:\n    \"\"\"\n    Wrap a string so that display() can render it as plain HTML\n    \"\"\"\n\n    def __init__(self, html):\n        self._html = html\n\n    def _repr_html_(self):\n        return self._html\n\n\ndef _eval_formatter(obj, print_method):\n    \"\"\"\n    Evaluates a formatter method.\n    \"\"\"\n    if print_method == \"__repr__\":\n        return repr(obj)\n    elif hasattr(obj, print_method):\n        if print_method == \"savefig\":\n            buf = io.BytesIO()\n            obj.savefig(buf, format=\"png\")\n            buf.seek(0)\n            return base64.b64encode(buf.read()).decode(\"utf-8\")\n        return getattr(obj, print_method)()\n    elif print_method == \"_repr_mimebundle_\":\n        return {}, {}\n    return None\n\n\ndef _format_mime(obj):\n    \"\"\"\n    Formats object using _repr_x_ methods.\n    \"\"\"\n    if isinstance(obj, str):\n        return html.escape(obj), \"text/plain\"\n\n    mimebundle = _eval_formatter(obj, \"_repr_mimebundle_\")\n    if isinstance(mimebundle, tuple):\n        format_dict, _ = mimebundle\n    else:\n        format_dict = mimebundle\n\n    output, not_available = None, []\n    for method, mime_type in reversed(_MIME_METHODS.items()):\n        if mime_type in format_dict:\n            output = format_dict[mime_type]\n        else:\n            output = _eval_formatter(obj, method)\n\n        if output is None:\n            continue\n        elif mime_type not in _MIME_RENDERERS:\n            not_available.append(mime_type)\n            continue\n        break\n    if output is None:\n        if not_available:\n            window.console.warn(\n                f\"Rendered object requested unavailable MIME renderers: {not_available}\"\n            )\n        output = repr(output)\n        mime_type = \"text/plain\"\n    elif isinstance(output, tuple):\n        output, meta = output\n    else:\n        meta = {}\n    return _MIME_RENDERERS[mime_type](output, meta), mime_type\n\n\ndef _write(element, value, append=False):\n    html, mime_type = _format_mime(value)\n    if html == \"\\\\n\":\n        return\n\n    if append:\n        out_element = document.createElement(\"div\")\n        element.append(out_element)\n    else:\n        out_element = element.lastElementChild\n        if out_element is None:\n            out_element = element\n\n    if mime_type in (\"application/javascript\", \"text/html\"):\n        script_element = document.createRange().createContextualFragment(html)\n        out_element.append(script_element)\n    else:\n        out_element.innerHTML = html\n\n\ndef display(*values, target=None, append=True):\n    if target is None:\n        target = current_target()\n\n    element = document.getElementById(target)\n\n    # if element is a <script type=\"py\">, it has a 'target' attribute which\n    # points to the visual element holding the displayed values. In that case,\n    # use that.\n    if element.tagName == \"SCRIPT\" and hasattr(element, \"target\"):\n        element = element.target\n\n    for v in values:\n        if not append:\n            element.replaceChildren()\n        _write(element, v, append=append)\n",
     "event_handling.py": "import inspect\n\nfrom pyodide.ffi.wrappers import add_event_listener\nfrom pyscript.magic_js import document\n\n\ndef when(event_type=None, selector=None):\n    \"\"\"\n    Decorates a function and passes py-* events to the decorated function\n    The events might or not be an argument of the decorated function\n    \"\"\"\n\n    def decorator(func):\n        if isinstance(selector, str):\n            elements = document.querySelectorAll(selector)\n        else:\n            # TODO: This is a hack that will be removed when pyscript becomes a package\n            #       and we can better manage the imports without circular dependencies\n            from pyweb import pydom\n\n            if isinstance(selector, pydom.Element):\n                elements = [selector._js]\n            elif isinstance(selector, pydom.ElementCollection):\n                elements = [el._js for el in selector]\n            else:\n                raise ValueError(\n                    f\"Invalid selector: {selector}. Selector must\"\n                    \" be a string, a pydom.Element or a pydom.ElementCollection.\"\n                )\n\n        sig = inspect.signature(func)\n        # Function doesn't receive events\n        if not sig.parameters:\n\n            def wrapper(*args, **kwargs):\n                func()\n\n            for el in elements:\n                add_event_listener(el, event_type, wrapper)\n        else:\n            for el in elements:\n                add_event_listener(el, event_type, func)\n        return func\n\n    return decorator\n",
     "magic_js.py": "from pyscript.util import NotSupported\nimport js as globalThis\n\nRUNNING_IN_WORKER = not hasattr(globalThis, \"document\")\n\nif RUNNING_IN_WORKER:\n    import polyscript\n\n    PyWorker = NotSupported(\n        'pyscript.PyWorker',\n        'pyscript.PyWorker works only when running in the main thread')\n    window = polyscript.xworker.window\n    document = window.document\n    sync = polyscript.xworker.sync\n\n    # in workers the display does not have a default ID\n    # but there is a sync utility from xworker\n    def current_target():\n        return polyscript.target\n\nelse:\n    import _pyscript\n    from _pyscript import PyWorker\n    window = globalThis\n    document = globalThis.document\n    sync = NotSupported(\n        'pyscript.sync',\n        'pyscript.sync works only when running in a worker')\n\n    # in MAIN the current element target exist, just use it\n    def current_target():\n        return _pyscript.target\n",
     "util.py": "class NotSupported:\n    \"\"\"\n    Small helper that raises exceptions if you try to get/set any attribute on\n    it.\n    \"\"\"\n\n    def __init__(self, name, error):\n        object.__setattr__(self, \"name\", name)\n        object.__setattr__(self, \"error\", error)\n\n    def __repr__(self):\n        return f\"<NotSupported {self.name} [{self.error}]>\"\n\n    def __getattr__(self, attr):\n        raise AttributeError(self.error)\n\n    def __setattr__(self, attr, value):\n        raise AttributeError(self.error)\n\n    def __call__(self, *args):\n        raise TypeError(self.error)\n"

package/types/hooks.d.ts

@@ -1,9 +1,10 @@
 declare namespace _default {
+    let onInterpreterReady: Set<Function>;
     let onBeforeRun: Set<Function>;
     let onBeforeRunAsync: Set<Function>;
     let onAfterRun: Set<Function>;
     let onAfterRunAsync: Set<Function>;
-    let onInterpreterReady: Set<Function>;
+    let onWorkerReady: Set<Function>;
     let codeBeforeRunWorker: Set<string>;
     let codeBeforeRunWorkerAsync: Set<string>;
     let codeAfterRunWorker: Set<string>;