Merge pull request #731 from thewtex/jupyterlite-tracebacks

Jupyterlite tracebacks

Author: thewtex

docs/Makefile

@@ -14,6 +14,10 @@ help:
 
 .PHONY: help Makefile
 
+clean:
+	rm -rf _build
+	rm -rf jupyterlite/_output
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

docs/development.md

@@ -1,6 +1,6 @@
 # Development
 
-Note: [Node.js](https://nodejs.org/en/download/) is required for development.
+## Package
 
 Setup your system for development:
 
@@ -14,4 +14,39 @@ pytest --nbmake examples/*.ipynb
 
 If Python code is changed, restart the kernel to see the changes.
 
-**Warning**: This project is under active development. Its API and behavior may change at any time. We mean it.
+**Warning**: This project is under active development. Its API and behavior may change at any time. We mean it 🙃.
+
+## Documentation
+
+Setup your system for documentation development on Unix-like systems:
+
+```bash
+git clone https://github.com/InsightSoftwareConsortium/itkwidgets.git
+cd itkwidgets/docs
+pip install -r requirements.txt
+```
+
+Build and serve the documentation:
+
+```bash
+make html
+python -m http.server -d _build/html 8787
+```
+
+Then visit *http://localhost:8787/* to see the rendered documentation.
+
+### JupyterLite
+
+The documentation includes an embedded JupyterLite deployment. To update the
+JupyterLite deployment, it is recommended to call `make clean` before starting
+a new build to avoid build caching issues. Also, serve the rendered
+documentation on a different port to avoid browser caching issues.
+
+Notebooks served in the JupyterLite deployment can be found at
+*docs/jupyterlite/files*.
+
+Support package wheels, including the `itkwidgets` wheel are referenced in
+*docs/jupyter/jupyterlite_config.json*. To update the URLs there, copy the
+download link address for a wheel found at https://pypi.org in a package's *Download
+files* page. Additional wheel files, if not on PyPI, can be added directly at
+*docs/jupyterlite/files/*.

docs/jupyterlite/files/Hello3DWorld.ipynb

@@ -8,7 +8,7 @@
    "outputs": [],
    "source": [
     "import piplite\n",
-    "await piplite.install('itkwidgets==1.0a24')"
+    "await piplite.install('itkwidgets==1.0a46.dev18+g0bcf158.d20240111')"
    ]
   },
   {

docs/jupyterlite/jupyterlite_config.json

@@ -1,11 +1,11 @@
 {
     "PipliteAddon": {
         "piplite_urls": [
-            "https://files.pythonhosted.org/packages/4c/ee/56f970ca26375176d3e4885f58471a12d5a6794bcefe8ad0ccb8d7158ca3/itkwasm-1.0b82-py3-none-any.whl",
-            "https://files.pythonhosted.org/packages/6c/55/c3fc7e2b9671d15f0c0becdcb9fad6c330172988744ad6eaa17b71bace88/imjoy_rpc-0.5.16-py3-none-any.whl",
+            "https://files.pythonhosted.org/packages/0e/9b/2987677aa4dfadd8ad2636f2e90c3b1e527cddb8b0789fa6151f47f832fa/itkwasm-1.0b145-py3-none-any.whl",
+            "https://files.pythonhosted.org/packages/80/48/1232756c08ecdc3305fecfec40ef13ac7ea2dd94a6203806595a696cc110/imjoy_rpc-0.5.46-py3-none-any.whl"
             "https://files.pythonhosted.org/packages/69/d9/5a6c8af2f4b4f49a809ae316ae4c12937d7dfda4e5b2f9e4167df5f15c0e/imjoy_utils-0.1.2-py3-none-any.whl",
-            "https://files.pythonhosted.org/packages/c9/dc/3504845528418aff0b71f4b622bb0e8e12adec2d8f2c1ba21d695b9ac6e6/itkwidgets-1.0a24-py3-none-any.whl",
-            "https://files.pythonhosted.org/packages/d0/8a/458d5f8b90786be8013b5bfe85aa3ff8d49ee41380d0fdeafaa5f20c95fa/ngff_zarr-0.2.0-py3-none-any.whl"
+            "https://files.pythonhosted.org/packages/ba/9f/ec8509396a847a34dfba58e7cf5e96750242eda8f7f45cdfe5c04013f204/itkwidgets-1.0a46-py3-none-any.whl",
+            "https://files.pythonhosted.org/packages/b4/ba/2f2cec7283edd5666f9ac912eacc03ab62df3ae3c83b3718db5cd040dd7a/ngff_zarr-0.6.0-py3-none-any.whl"
         ]
     }
 }

itkwidgets/standalone_server.py

@@ -28,7 +28,10 @@
 from ngff_zarr import detect_cli_io_backend, cli_input_to_ngff_image, ConversionBackend
 from pathlib import Path
 from urllib.parse import parse_qs, urlencode, urlparse
-from urllib3 import PoolManager, exceptions
+from .integrations.environment import ENVIRONMENT, Env
+# not available in pyodide by default
+if ENVIRONMENT is not Env.JUPYTERLITE:
+    from urllib3 import PoolManager, exceptions
 
 logging.getLogger("urllib3").setLevel(logging.ERROR)
 logging.getLogger("websocket-client").setLevel(logging.ERROR)

itkwidgets/viewer.py

@@ -22,7 +22,6 @@
     build_init_data,
     defer_for_data_render,
 )
-from .cell_watcher import CellWatcher
 from .imjoy import register_itkwasm_imjoy_codecs
 from .integrations import _detect_render_type, _get_viewer_image, _get_viewer_point_set
 from .integrations.environment import ENVIRONMENT, Env
@@ -38,7 +37,8 @@
 _viewer_count = 1
 _codecs_registered = False
 _cell_watcher = None
-if ENVIRONMENT is not Env.HYPHA:
+if not ENVIRONMENT in (Env.HYPHA, Env.JUPYTERLITE):
+    from .cell_watcher import CellWatcher
     _cell_watcher = CellWatcher() # Instantiate the singleton class right away
 
 
@@ -319,7 +319,8 @@ def fetch_value(func: Callable) -> Callable:
         @functools.wraps(func)
         def _fetch_value(self, *args, **kwargs):
             result = func(self, *args, **kwargs)
-            if isawaitable(result):
+            global _cell_watcher
+            if isawaitable(result) and _cell_watcher:
                 future = asyncio.ensure_future(result)
                 self.call_getter(future)
                 return future