various minor fixes + client python refactor

Author: rmorshea

.gitignore

@@ -11,6 +11,8 @@
 .jupyter
 
 # --- Python ---
+.venv
+venv
 MANIFEST
 build
 dist

examples/chart.js

@@ -1,4 +1,4 @@
-jupyter
+jupyterlab
 pre-commit
 notebook
 twine

requirements/dev.txt

@@ -1,2 +1,3 @@
 node_modules
 web_modules
+etc_modules

src/idom/client/.gitignore

@@ -9,29 +9,33 @@
 
 CLIENT_DIR = Path(__file__).parent
 
+CORE_MODULES = CLIENT_DIR / "core_modules"
+NODE_MODULES = CLIENT_DIR / "node_modules"
+WEB_MODULES = CLIENT_DIR / "web_modules"
+ETC_MODULES = CLIENT_DIR / "etc_modules"
 
-def import_path(name: str) -> Optional[str]:
-    path = CLIENT_DIR / "web_modules"
-    for name_part in name.split("/"):
-        if not path.is_dir():
-            return None
-        path /= name_part
-    full_path = path.with_suffix(".js")
-    if not full_path.is_file():
-        return None
-    return _web_module(name)
+
+def import_path(prefix: str, name: str) -> Optional[str]:
+    if not module_exists(prefix, name):
+        raise ValueError(f"Module '{_module_js_path(prefix, name)}' does not exist.")
+    return _module_js_path(prefix, name)
 
 
 def define_module(name: str, source: str) -> str:
-    path = CLIENT_DIR
-    for n in ["etc_modules"] + name.split("/"):
-        if not path.exists():
-            path.mkdir()
-        path /= n
-    module = path.with_suffix(".js")
-    with module.open("w+") as f:
+    path = _create_module_os_path(ETC_MODULES, name)
+    with path.open("w+") as f:
         f.write(source)
-    return _etc_module(name)
+    return _module_js_path("etc_modules", name)
+
+
+def delete_module(prefix: str, name: str) -> None:
+    if not module_exists(prefix, name):
+        raise ValueError(f"Module '{_module_js_path(prefix, name)}' does not exist.")
+    return None
+
+
+def module_exists(prefix: Union[str, Path], name: str) -> bool:
+    return _find_module_os_path(prefix, name) is not None
 
 
 def install(*dependencies: str) -> None:
@@ -59,12 +63,7 @@ def install(*dependencies: str) -> None:
 
 
 def restore() -> None:
-    for path in ["web_modules", "node_modules"]:
-        full_path = CLIENT_DIR.joinpath(*path.split("/"))
-        if full_path.is_file():
-            full_path.unlink()
-        elif full_path.is_dir():
-            shutil.rmtree(full_path)
+    _delete_os_paths(WEB_MODULES, NODE_MODULES, ETC_MODULES)
     install()
 
 
@@ -78,8 +77,8 @@ def _package_json():
         "devDependencies": {"snowpack": "^1.6.0"},
         "snowpack": {
             "installOptions": {
-                "dest": str(CLIENT_DIR / "web_modules"),
-                "include": str(CLIENT_DIR / "modules" / "**" / "*.js"),
+                "dest": str(WEB_MODULES),
+                "include": str(CORE_MODULES / "**" / "*.js"),
             },
             "webDependencies": [],
         },
@@ -96,9 +95,40 @@ def _run_subprocess(args: List[str], cwd: Union[str, Path]):
         raise
 
 
-def _web_module(name: str) -> str:
-    return f"../web_modules/{name}.js"
+def _module_js_path(prefix: str, name: str) -> str:
+    return f"../{prefix}/{name}.js"
+
+
+def _find_module_os_path(prefix: Union[str, Path], name: str) -> Optional[Path]:
+    if isinstance(prefix, str):
+        path = CLIENT_DIR / prefix
+    else:
+        path = prefix
+    for name_part in name.split("/"):
+        if not path.is_dir():
+            return None
+        path /= name_part
+    full_path = path.with_suffix(".js")
+    if not full_path.is_file():
+        return None
+    return full_path
+
+
+def _create_module_os_path(prefix: Union[str, Path], name: str) -> Path:
+    if isinstance(prefix, str):
+        path = CLIENT_DIR / prefix
+    else:
+        path = prefix
+    for n in name.split("/"):
+        if not path.exists():
+            path.mkdir()
+        path /= n
+    return path.with_suffix(".js")
 
 
-def _etc_module(name: str) -> str:
-    return f"../etc_modules/{name}.js"
+def _delete_os_paths(*paths: Path) -> None:
+    for p in paths:
+        if p.is_file():
+            p.unlink()
+        elif p.is_dir():
+            shutil.rmtree(p)

src/idom/client/__init__.py

@@ -12,15 +12,20 @@ function lazyComponent(model) {
         return { default: cmpt };
       },
       (error) => {
-        function Catch() {
-          return html`
-            <pre>
-              <code>${error.stack}</code>
-            </pre
-            >
-          `;
+        if (!error.stack) {
+          throw error;
+        } else {
+          return {
+            default: function Catch() {
+              return html`
+              <pre>
+                <code>${error.stack}</code>
+              </pre
+              >
+            `;
+            }
+          };
         }
-        return { default: Catch };
       }
     );
   });

src/idom/client/core_modules/lazy-component.js

@@ -5,15 +5,14 @@ import htm from "../web_modules/htm.js";
 const html = htm.bind(React.createElement);
 
 const data = [
-  {quarter: 1, earnings: 13000},
-  {quarter: 2, earnings: 16500},
-  {quarter: 3, earnings: 14250},
-  {quarter: 4, earnings: 19000}
+  { quarter: 1, earnings: 13000 },
+  { quarter: 2, earnings: 16500 },
+  { quarter: 3, earnings: 14250 },
+  { quarter: 4, earnings: 19000 }
 ];
 
-class Chart extends React.Component {
-  render() {
-    return html`
+function Chart() {
+  return html`
       <${VictoryChart} domainPadding=20>
         <${VictoryAxis}
           tickValues=${[1, 2, 3, 4]}
@@ -30,7 +29,6 @@ class Chart extends React.Component {
         />
       </${VictoryChart}>
     `
-  }
 }
 
-export default {Chart: Chart}
+export default { Chart: Chart }

src/idom/client/etc_modules/chart.js

@@ -22,7 +22,7 @@
   },
   "snowpack": {
     "installOptions": {
-      "include": "modules/**/*.js",
+      "include": "core_modules/**/*.js",
       "clean": true
     }
   }

src/idom/client/package.json

@@ -1,7 +1,16 @@
-from .common import Import, hotswap
+from .common import Import, import_module, hotswap
 from .display import display
 from .inputs import Input
 from .images import Image
 from .html import html
 
-__all__ = ["display", "node", "Image", "hotswap", "html", "Input", "Import"]
+__all__ = [
+    "display",
+    "node",
+    "Image",
+    "import_module",
+    "hotswap",
+    "html",
+    "Input",
+    "Import",
+]

src/idom/widgets/__init__.py

@@ -1,3 +1,4 @@
+import inspect
 from typing import Any, Callable, Tuple, Optional, Union
 
 from idom import client
@@ -6,10 +7,12 @@
 from idom.tools import Var
 
 
-def module(name: str, source: Any, raw: bool = False) -> "Import":
+def import_module(name: str, source: Any, raw: bool = False) -> "Import":
     if not raw:
         with open(str(source), "r") as f:
             source = f.read()
+    else:
+        source = inspect.cleandoc(source)
     return Import(client.define_module(name, source))
 
 
@@ -43,13 +46,13 @@ def __init__(
         fallback: Optional[str] = None,
         install: Union[str, bool] = False,
     ) -> None:
-        if install is not False:
-            if not client.import_path(package):
+        if install:
+            if not client.module_exists("web_modules", package):
                 if isinstance(install, str):
                     client.install(f"{install} {package}")
                 else:
                     client.install(f"{package} {package}")
-            new_import_path = client.import_path(package)
+            new_import_path = client.import_path("web_modules", package)
             if new_import_path is None:
                 raise ValueError(f"Unexpectedly failed to find install of {package}")
             package = new_import_path