Minor tidy-ups to help with upcoming refactoring.

ntoll · ntoll · commit 0ba4ca8278ff · 2022-10-13T11:36:33.000+01:00
diff --git a/customtags.js b/customtags.js
@@ -0,0 +1,54 @@
+"use strict";
+/******************************************************************************
+An example of how to do a custom "third party" plugin for PyScript.
+
+Authors:
+- Nicholas H.Tollervey (ntollervey@anaconda.org)
+
+Copyright (c) 2022 Anaconda Inc. 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+******************************************************************************/
+
+class PyREPLTag extends Plugin {
+    /*
+    Adds a REPL to the DOM. The REPL session is only initialised when the
+    runtime is ready. The content of the REPL is inserted in the following
+    arrangement of tags:
+
+    <pre class="pyscriptREPL"><code>
+    </code></pre>
+
+    No styling is provided by this plugin (the browser defaults for this
+    arrangement of tags will make it look like a TTY session). Bespoke CSS
+    should use the pyscriptREPL class to attach styling.
+    */
+    start(config) {
+        // Define the py-repl element.
+        class PyREPL extends HTMLElement {
+            connectedCallback() {
+                /*
+                Create a shadow DOM with the expected child elements and event
+                handlers defined in it.
+                */
+                const shadow = this.attachShadow({ mode: "open" });
+                const pre = document.createElement("pre");
+                pre.setAttribute("class", "pyscriptREPL");
+                const code = document.createElement("code");
+                pre.appendChild(code);
+                shadow.appendChild(pre);
+            }
+        }
+        customElements.define("py-repl", PyREPL);
+    }
+}
diff --git a/pyscript.js b/pyscript.js
@@ -29,7 +29,7 @@ limitations under the License.
 /******************************************************************************
 Base classes and constants.
 ******************************************************************************/
-class Plugin {
+class PyScriptPlugin {
     /*
     Defines a "plugin" in PyScript.
     */
@@ -91,7 +91,7 @@ class Runtime {
         Dispatch the py-runtime-ready event (for when the runtime has
         eventually started and is ready to evaluate code).
         */
-        const pyRuntimeReady = new CustomEvent("py-runtime-ready");
+        const pyRuntimeReady = new CustomEvent("py-runtime-ready", this);
         document.dispatchEvent(pyRuntimeReady);
     }
 
@@ -124,14 +124,15 @@ class Runtime {
 
 
 // The innerHTML of the default splash screen to show while PyScript is
-// starting up. Currently a simple SVG animation above the word "PyScript".
+// starting up. Currently the page is greyed out and the words
+// "Loading PyScript...".
 const defaultSplash= '<div style="position:fixed;width:100%;height:100%;top:0;left:0;right:0;bottom:0;background-color:rgba(0,0,0,0.5);z-index:99999;"><div style="position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);-ms-transform:translate(-50%,-50%);color:white;font-family:monospace;font-size:10px;">Loading PyScript...</div></div>';
 
 
 /******************************************************************************
 Built-in plugins and runtimes.
 ******************************************************************************/
-class PyScriptTag extends Plugin {
+class PyScriptTag extends PyScriptPlugin {
     start(config) {
         // Define the PyScript element.
         class PyScript extends HTMLElement {
@@ -268,13 +269,11 @@ class PyodideRuntime extends Runtime {
 The core PyScript app definition.
 ******************************************************************************/
 const main = function() {
-    // Used to measure start-up times.
-    const start = new Date();
     // Really simple logging. Emoji 🐍 highlights PyScript app logs. ;-)
     const logger = function() {
         return Function.prototype.bind.call(console.log, console, "🐍 ", ...arguments);
     }();
-    logger("Starting PyScript. 👋", start);
+    logger("Starting PyScript. 👋");
 
     // Default configuration settings for PyScript. These may be overridden by
     // the app.loadConfig function.
@@ -301,8 +300,6 @@ const main = function() {
         "cpython": CPythonRuntime,
         "pyodide": PyodideRuntime
     }
-    // Default to smallest/fastest runtime.
-    runtimes["default"] = runtimes["micropython"]
 
     // Eventually references an instance of the Runtime class, representing the
     // started runtime.
@@ -377,28 +374,25 @@ const main = function() {
 
             TL;DR - a new script tag with the correct src is added to the head.
             */
-            const runtimeName = config.runtime ? config.runtime : "default";
-            if(!runtimes.hasOwnProperty(runtimeName)) {
-                throw `💥 Unknown runtime: "${runtimeName}" (known runtimes: ${Object.keys(runtimes)})`;
+            if(!runtimes.hasOwnProperty(config.runtime)) {
+                throw `💥 Unknown runtime: "${config.runtime}" (known runtimes: ${Object.keys(runtimes)})`;
             }
             const runtimeElement = document.createElement("script");
-            runtimeElement.src = runtimes[runtimeName.toLowerCase()].url;
+            runtimeElement.src = runtimes[config.runtime.toLowerCase()].url;
             runtimeElement.onload = function(e) {
-                let duration = new Date() - start;
-                logger(`Runtime "${runtimeName}" loaded (${duration}ms). 👍`);
-                const pyRuntimeLoaded = new CustomEvent("py-runtime-loaded", {detail: runtimeName});
+                logger(`Runtime "${config.runtime}" loaded. 👍`);
+                const pyRuntimeLoaded = new CustomEvent("py-runtime-loaded", {detail: config.runtime});
                 document.dispatchEvent(pyRuntimeLoaded);
             };
             var head = document.getElementsByTagName('head')[0];
-            logger(`Loading runtime "${runtimeName}". 🚀`)
+            logger(`Loading runtime "${config.runtime}". 🚀`)
             head.appendChild(runtimeElement);
         },
         startRuntime: function() {
             /*
             Congigure and start the Python runtime.
             */
-            const runtimeName = config.runtime ? config.runtime : "default";
-            runtime = new runtimes[runtimeName.toLowerCase()]();
+            runtime = new runtimes[config.runtime.toLowerCase()]();
             runtime.start(config);
         },
         runtimeStarted: function() {
@@ -407,8 +401,7 @@ const main = function() {
             through each registered plugin's onRuntimeReady method, and begin
             evaluating any code in the pendingScripts queue.
             */
-            let duration = new Date() - start;
-            logger(`Runtime started (${duration}ms). 🎬`);
+            logger(`Runtime started. 🎬`);
             runtimeReady = true;
             plugins.forEach(function(plugin) {
                 plugin.onRuntimeReady(config, runtime);
