")
-
- assert model == {
- "tagName": "div",
- "attributes": {"height": "10px", "width": "10px"},
- "children": [{"tagName": "p", "children": ["hello world!"]}],
- }
-
-With Jupyter and IPython support:
-
-.. code-block:: python
-
- %%dialect html
- from idom import html
- assert html(f"") == {"tagName": "div"}
-
-That you can install with ``pip``:
-
-.. code-block::
-
- pip install idom[dialect]
-
-
-Usage
-.....
-
-1. Import ``idom`` in your application's ``entrypoint.py``
-
-2. Import ``your_module.py`` with a ``# dialect=html`` header comment.
-
-3. Inside ``your_module.py`` import ``html`` from ``idom``
-
-4. Run ``python entrypoint.py`` from your console.
-
-So here's the files you should have set up:
-
-.. code-block:: text
-
- project
- |- entrypoint.py
- |- your_module.py
-
-The contents of ``entrypoint.py`` should contain:
-
-.. code-block::
-
- import idom # this needs to be first!
- import your_module
-
-While ``your_module.py`` should contain the following:
-
-.. code-block::
-
- # dialect=html
- from idom import html
- assert html(f"") == {"tagName": "div"}
-
-And that's it!
-
-
-How It Works
-............
-
-Once ``idom`` has been imported at your application's entrypoint, any following modules
-imported with a ``# dialect=html`` header comment get transpiled just before they're
-executed. This is accomplished by using Pyalect_ to hook a transpiler into Pythons
-import system. The :class:`~idom.dialect.HtmlDialectTranspiler` implements Pyalect_'s
-:class:`~pyalect.dialect.Transpiler` interface using some tooling from htm.py_.
-
-
-.. Links
-.. =====
-
-.. _Pyalect: https://pyalect.readthedocs.io/en/latest/
-.. _htm.py: https://github.com/jviide/htm.py
diff --git a/docs/source/javascript-components.rst b/docs/source/javascript-components.rst
index ba6154379..e9debc6e6 100644
--- a/docs/source/javascript-components.rst
+++ b/docs/source/javascript-components.rst
@@ -4,12 +4,10 @@ Javascript Components
While IDOM is a great tool for displaying HTML and responding to browser events with
pure Python, there are other projects which already allow you to do this inside
`Jupyter Notebooks `__
-or in
-`webpages `__.
+or in standard
+`web apps `__.
The real power of IDOM comes from its ability to seamlessly leverage the existing
-ecosystem of
-`React components `__.
-This can be accomplished in different ways for different reasons:
+Javascript ecosystem. This can be accomplished in different ways for different reasons:
.. list-table::
:header-rows: 1
@@ -17,30 +15,49 @@ This can be accomplished in different ways for different reasons:
* - Integration Method
- Use Case
+ * - :ref:`Dynamically Loaded Components`
+ - You want to **quickly experiment** with IDOM and the Javascript ecosystem.
+
* - :ref:`Custom Javascript Components`
- You want to create polished software that can be **easily shared** with others.
- * - :ref:`Dynamically Install Javascript` (requires NPM_)
- - You want to **quickly experiment** with IDOM and the Javascript ecosystem.
+
+Dynamically Loaded Components
+-----------------------------
+
+.. note::
+
+ This method is not recommended in production systems - see
+ :ref:`Distributing Javascript Components` for more info.
+
+IDOM makes it easy to draft your code when you're in the early stages of development by
+using a CDN_ to dynamically load Javascript packages on the fly. In this example we'll
+be using the ubiquitous React-based UI framework `Material UI`_.
+
+.. example:: material_ui_button_no_action
+
+So now that we can display a Material UI Button we probably want to make it do
+something. Thankfully there's nothing new to learn here, you can pass event handlers to
+the button just as you did when :ref:`getting started`. Thus, all we need to do is add
+an ``onClick`` handler to the component:
+
+.. example:: material_ui_button_on_click
Custom Javascript Components
----------------------------
-For projects that will be shared with others we recommend bundling your Javascript with
-`rollup `__ or `webpack `__
-into a
-`web module `__.
-IDOM also provides a
-`template repository `__
+For projects that will be shared with others, we recommend bundling your Javascript with
+Rollup_ or Webpack_ into a `web module`_. IDOM also provides a `template repository`_
that can be used as a blueprint to build a library of React components.
-The core benefit of loading Javascript in this way is that users of your code won't need
-to have NPM_ installed. Rather, they can use ``pip`` to install your Python package
-without any other build steps because the bundled Javascript you distributed with it
-will be symlinked into the IDOM client at runtime.
+To work as intended, the Javascript bundle must provide named exports for the following
+functions as well as any components that will be rendered.
-To work as intended, the Javascript bundle must export the following named functions:
+.. note::
+
+ The exported components do not have to be React-based since you'll have full control
+ over the rendering mechanism.
.. code-block:: typescript
@@ -63,25 +80,17 @@ These functions can be thought of as being analogous to those from React.
.. |reactDOM.unmountComponentAtNode| replace:: ``reactDOM.unmountComponentAtNode``
.. _reactDOM.unmountComponentAtNode: https://reactjs.org/docs/react-api.html#createelement
-And will be called in the following manner:
+And will be called in the following manner, where ``component`` is a named export of
+your module:
.. code-block::
// on every render
- renderElement(createElement(type, props), container);
+ renderElement(createElement(component, props), container);
// on unmount
unmountElement(container);
-Once you've done this, you can distribute the bundled javascript in your Python package
-and integrate it into IDOM by defining :class:`~idom.client.module.Module` objects that
-load them from source:
-
-.. code-block::
-
- import idom
- my_js_package = idom.Module("my-js-package", source_file="/path/to/my/bundle.js")
-
-The simplest way to try this out yourself though, is to hook in simple a hand-crafted
+The simplest way to try this out yourself though, is to hook in a simple hand-crafted
Javascript module that has the requisite interface. In the example to follow we'll
create a very basic SVG line chart. The catch though is that we are limited to using
Javascript that can run directly in the browser. This means we can't use fancy syntax
@@ -91,58 +100,307 @@ like `JSX `__ and instead will us
.. example:: super_simple_chart
-.. Links
-.. =====
+Distributing Javascript Components
+----------------------------------
-.. _Material UI: https://material-ui.com/
-.. _NPM: https://www.npmjs.com
-.. _install NPM: https://www.npmjs.com/get-npm
+There are two ways that you can distribute your :ref:`Custom Javascript Components`:
+- Using a CDN_
+- In a Python package via PyPI_
+These options are not mutually exclusive though, and it may be beneficial to support
+both options. For example, if you upload your Javascript components to NPM_ and also
+bundle your Javascript inside a Python package, in principle your users can determine
+which work best for them. Regardless though, either you or, if you give then the choice,
+your users, will have to consider the tradeoffs of either approach.
-Dynamically Install Javascript
-------------------------------
+- :ref:`Distributing Javascript via CDN_` - Most useful in production-grade applications
+ where its assumed the user has a network connection. In this scenario a CDN's `edge
+ network `__ can be used to bring the
+ Javascript source closer to the user in order to reduce page load times.
-.. warning::
+- :ref:`Distributing Javascript via PyPI_` - This method is ideal for local usage since
+ the user can server all the Javascript components they depend on from their computer
+ without requiring a network connection.
- - Before continuing `install NPM`_.
- - Not guaranteed to work in all client implementations
- (see :attr:`~idom.config.IDOM_CLIENT_MODULES_MUST_HAVE_MOUNT`)
-IDOM makes it easy to draft your code when you're in the early stages of development by
-using NPM_ to directly install Javascript packages on the fly. In this example we'll be
-using the ubiquitous React-based UI framework `Material UI`_ which can be installed
-using the ``idom`` CLI:
+Distributing Javascript via CDN_
+................................
+
+Under this approach, to simplify these instructions, we're going to ignore the problem
+of distributing the Javascript since that must be handled by your CDN. For open source
+or personal projects, a CDN like https://unpkg.com/ makes things easy by automatically
+preparing any package that's been uploaded to NPM_. If you need to roll with your own
+private CDN, this will likely be more complicated.
-.. code-block:: bash
+In either case though, on the Python side, things are quite simple. You need only pass
+the URL where your package can be found to :func:`~idom.web.module.module_from_file`
+where you can then load any of its exports:
- idom install @material-ui/core
+.. code-block::
+
+ import idom
-Or at runtime with :func:`idom.client.module.install` (this is useful if you're working
-in a REPL or Jupyter Notebook):
+ your_module = ido.web.module_from_file("https://some.cdn/your-module")
+ YourComponent = idom.web.export(your_module, "YourComponent")
+
+
+Distributing Javascript via PyPI_
+.................................
+
+This can be most easily accomplished by using the `template repository`_ that's been
+purpose-built for this. However, to get a better sense for its inner workings, we'll
+briefly look at what's required. At a high level, we must consider how to...
+
+1. bundle your Javascript into an `ECMAScript Module`)
+2. include that Javascript bundle in a Python package
+3. use it as a component in your applciation using IDOM
+
+In the descriptions to follow we'll be assuming that:
+
+- NPM_ is the Javascript package manager
+- The components are implemented with React_
+- Rollup_ bundles the Javascript module
+- Setuptools_ builds the Python package
+
+To start, let's take a look at the file structure we'll be building:
+
+.. code-block:: text
+
+ your-project
+ |-- js
+ | |-- src
+ | | \-- index.js
+ | |-- package.json
+ | \-- rollup.config.js
+ |-- your_python_package
+ | |-- __init__.py
+ | \-- widget.py
+ |-- Manifest.in
+ |-- pyproject.toml
+ \-- setup.py
+
+``index.js`` should contain the relevant exports (see
+:ref:`Custom JavaScript Components` for more info):
+
+.. code-block:: javascript
+
+ import * as react from "react";
+ import * as reactDOM from "react-dom";
+
+ // exports required to interface with IDOM
+ export const createElement = (component, props) =>
+ react.createElement(component, props);
+ export const renderElement = reactDOM.render;
+ export const unmountElement = reactDOM.unmountComponentAtNode;
+
+ // exports for your components
+ export YourFirstComponent(props) {...};
+ export YourSecondComponent(props) {...};
+ export YourThirdComponent(props) {...};
+
+
+Your ``package.json`` should include the following:
+
+.. code-block:: python
+
+ {
+ "name": "YOUR-PACKAGE-NAME",
+ "scripts": {
+ "build": "rollup --config",
+ ...
+ },
+ "devDependencies": {
+ "rollup": "^2.35.1",
+ "rollup-plugin-commonjs": "^10.1.0",
+ "rollup-plugin-node-resolve": "^5.2.0",
+ "rollup-plugin-replace": "^2.2.0",
+ ...
+ },
+ "dependencies": {
+ "react": "^17.0.1",
+ "react-dom": "^17.0.1",
+ ...
+ },
+ ...
+ }
+
+Getting a bit more in the weeds now, your ``rollup.config.js`` file should be designed
+such that it drops an ES Module at ``your-project/your_python_package/bundle.js`` since
+we'll be writing ``widget.py`` under that assumption.
+
+.. note::
+
+ Don't forget to ignore this ``bundle.js`` file when committing code (with a
+ ``.gitignore`` if you're using Git) since it can always rebuild from the raw
+ Javascript source in ``your-project/js``.
+
+.. code-block:: javascript
+
+ import resolve from "rollup-plugin-node-resolve";
+ import commonjs from "rollup-plugin-commonjs";
+ import replace from "rollup-plugin-replace";
+
+ export default {
+ input: "src/index.js",
+ output: {
+ file: "../your_python_package/bundle.js",
+ format: "esm",
+ },
+ plugins: [
+ resolve(),
+ commonjs(),
+ replace({
+ "process.env.NODE_ENV": JSON.stringify("production"),
+ }),
+ ]
+ };
+
+Your ``widget.py`` file should then load the neighboring bundle file using
+:func:`~idom.web.module.module_from_file`. Then components from that bundle can be
+loaded with :func:`~idom.web.module.export`.
.. code-block::
+ from pathlib import Path
+
import idom
- material_ui = idom.install("@material-ui/core")
- # or install multiple modules at once
- material_ui, *other_modules = idom.install(["@material-ui/core", ...])
+
+ _BUNDLE_PATH = Path(__file__).parent / "bundle.js"
+ _WEB_MODULE = idom.web.module_from_file(
+ # Note that this is the same name from package.json - this must be globally
+ # unique since it must share a namespace with all other javascript packages.
+ name="YOUR-PACKAGE-NAME",
+ file=_BUNDLE_PATH,
+ # What to temporarilly display while the module is being loaded
+ fallback="Loading...",
+ )
+
+ # Your module must provide a named export for YourFirstComponent
+ YourFirstComponent = idom.web.export(_WEB_MODULE, "YourFirstComponent")
+
+ # It's possible to export multiple components at once
+ YourSecondComponent, YourThirdComponent = idom.web.export(
+ _WEB_MODULE, ["YourSecondComponent", "YourThirdComponent"]
+ )
.. note::
- Any standard javascript dependency specifier is allowed here.
+ When :data:`idom.config.IDOM_DEBUG_MODE` is active, named exports will be validated.
-Once the package has been successfully installed, you can import and display the component:
+The remaining files that we need to create are concerned with creating a Python package.
+We won't cover all the details here, so refer to the Setuptools_ documentation for
+more information. With that said, the first file to fill out is `pyproject.toml` since
+we need to declare what our build tool is (in this case Setuptools):
-.. example:: material_ui_button_no_action
+.. code-block:: toml
+ [build-system]
+ requires = ["setuptools>=40.8.0", "wheel"]
+ build-backend = "setuptools.build_meta"
-Passing Props To Javascript Components
---------------------------------------
+Then, we can creat the ``setup.py`` file which uses Setuptools. This will differ
+substantially from a normal ``setup.py`` file since, as part of the build process we'll
+need to use NPM to bundle our Javascript. This requires customizing some of the build
+commands in Setuptools like ``build``, ``sdist``, and ``develop``:
-So now that we can install and display a Material UI Button we probably want to make it
-do something. Thankfully there's nothing new to learn here, you can pass event handlers
-to the button just as you did when :ref:`getting started`. Thus, all we need to do is
-add an ``onClick`` handler to the component:
+.. code-block:: python
-.. example:: material_ui_button_on_click
+ import subprocess
+ from pathlib import Path
+
+ from setuptools import setup, find_packages
+ from distutils.command.build import build
+ from distutils.command.sdist import sdist
+ from setuptools.command.develop import develop
+
+ PACKAGE_SPEC = {} # gets passed to setup() at the end
+
+
+ # -----------------------------------------------------------------------------
+ # General Package Info
+ # -----------------------------------------------------------------------------
+
+
+ PACKAGE_NAME = "your_python_package"
+
+ PACKAGE_SPEC.update(
+ name=PACKAGE_NAME,
+ version="0.0.1",
+ packages=find_packages(exclude=["tests*"]),
+ classifiers=["Framework :: IDOM", ...],
+ keywords=["IDOM", "components", ...],
+ # install IDOM with this package
+ install_requires=["idom"],
+ # required in order to include static files like bundle.js using MANIFEST.in
+ include_package_data=True,
+ # we need access to the file system, so cannot be run from a zip file
+ zip_safe=False,
+ )
+
+
+ # ----------------------------------------------------------------------------
+ # Build Javascript
+ # ----------------------------------------------------------------------------
+
+
+ # basic paths used to gather files
+ PROJECT_ROOT = Path(__file__).parent
+ PACKAGE_DIR = PROJECT_ROOT / PACKAGE_NAME
+ JS_DIR = PROJECT_ROOT / "js"
+
+
+ def build_javascript_first(cls):
+ class Command(cls):
+ def run(self):
+ for cmd_str in ["npm install", "npm run build"]:
+ subprocess.run(cmd_str.split(), cwd=str(JS_DIR), check=True)
+ super().run()
+
+ return Command
+
+
+ package["cmdclass"] = {
+ "sdist": build_javascript_first(sdist),
+ "build": build_javascript_first(build),
+ "develop": build_javascript_first(develop),
+ }
+
+
+ # -----------------------------------------------------------------------------
+ # Run It
+ # -----------------------------------------------------------------------------
+
+
+ if __name__ == "__main__":
+ setup(**package)
+
+
+Finally, since we're using ``include_package_data`` you'll need a MANIFEST.in_ file that
+includes ``bundle.js``:
+
+.. code-block:: text
+
+ include your_python_package/bundle.js
+
+And that's it! While this might seem like a lot of work, you're always free to start
+creating your custom components using the provided `template repository`_ so you can get
+up and running as quickly as possible.
+
+
+.. Links
+.. =====
+
+.. _Material UI: https://material-ui.com/
+.. _NPM: https://www.npmjs.com
+.. _install NPM: https://www.npmjs.com/get-npm
+.. _CDN: https://en.wikipedia.org/wiki/Content_delivery_network
+.. _PyPI: https://pypi.org/
+.. _template repository: https://github.com/idom-team/idom-react-component-cookiecutter
+.. _web module: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+.. _Rollup: https://rollupjs.org/guide/en/
+.. _Webpack: https://webpack.js.org/
+.. _Setuptools: https://setuptools.readthedocs.io/en/latest/userguide/index.html
+.. _ECMAScript Module: https://tc39.es/ecma262/#sec-modules
+.. _React: https://reactjs.org
+.. _MANIFEST.in: https://packaging.python.org/guides/using-manifest-in/
diff --git a/noxfile.py b/noxfile.py
index 8742367fc..fb880cf24 100644
--- a/noxfile.py
+++ b/noxfile.py
@@ -60,7 +60,10 @@ def docs(session: Session) -> None:
"scripts/live_docs.py",
"--open-browser",
# for some reason this matches absolute paths
- "--ignore=**/docs/source/auto/*",
+ "--ignore=**/auto/*",
+ "--ignore=**/_static/custom.js",
+ "--ignore=**/node_modules/*",
+ "--ignore=**/package-lock.json",
"-a",
"-E",
"-b",
@@ -122,7 +125,7 @@ def test_suite(session: Session) -> None:
posargs += ["--cov=src/idom", "--cov-report", "term"]
install_idom_dev(session, extras="all")
- session.run("pytest", "tests", *posargs)
+ session.run("pytest", *posargs)
@nox.session
@@ -205,7 +208,3 @@ def install_idom_dev(session: Session, extras: str = "stable") -> None:
session.install("-e", f".[{extras}]")
else:
session.posargs.remove("--no-install")
- if "--no-restore" not in session.posargs:
- session.run("idom", "restore")
- else:
- session.posargs.remove("--no-restore")
diff --git a/requirements/check-types.txt b/requirements/check-types.txt
index b036bcd49..2ae26d60a 100644
--- a/requirements/check-types.txt
+++ b/requirements/check-types.txt
@@ -3,3 +3,4 @@ types-click
types-tornado
types-pkg-resources
types-flask
+types-requests
diff --git a/requirements/pkg-deps.txt b/requirements/pkg-deps.txt
index 75db38e0e..0ef2d1c96 100644
--- a/requirements/pkg-deps.txt
+++ b/requirements/pkg-deps.txt
@@ -1,10 +1,6 @@
typing-extensions >=3.7.4
mypy-extensions >=0.4.3
anyio >=3.0
-async_exit_stack >=1.0.1; python_version<"3.7"
jsonpatch >=1.26
-typer >=0.3.2
-click-spinner >=0.1.10
fastjsonschema >=2.14.5
-rich >=9.13.0
-appdirs >=1.4.4
+requests >=2.0
diff --git a/requirements/pkg-extras.txt b/requirements/pkg-extras.txt
index c1fbd225c..6205adf00 100644
--- a/requirements/pkg-extras.txt
+++ b/requirements/pkg-extras.txt
@@ -19,8 +19,3 @@ selenium
# extra=matplotlib
matplotlib
-
-# extra=dialect
-htm
-pyalect
-tagged
diff --git a/requirements/test-env.txt b/requirements/test-env.txt
index 586c60948..6fd1686da 100644
--- a/requirements/test-env.txt
+++ b/requirements/test-env.txt
@@ -5,3 +5,4 @@ pytest-mock
pytest-timeout
selenium
ipython
+responses
diff --git a/scripts/live_docs.py b/scripts/live_docs.py
index 65cac6974..0f42a1ca6 100644
--- a/scripts/live_docs.py
+++ b/scripts/live_docs.py
@@ -11,6 +11,7 @@
from docs.main import IDOM_MODEL_SERVER_URL_PREFIX, make_app, make_component
from idom.server.sanic import PerClientStateServer
+from idom.testing import clear_idom_web_modules_dir
# these environment variable are used in custom Sphinx extensions
@@ -24,6 +25,7 @@ def wrap_builder(old_builder):
# This is the bit that we're injecting to get the example components to reload too
def new_builder():
[s.stop() for s in _running_idom_servers]
+ clear_idom_web_modules_dir()
server = PerClientStateServer(
make_component(),
diff --git a/scripts/one_example.py b/scripts/one_example.py
index ac51693c6..f5ae42f28 100644
--- a/scripts/one_example.py
+++ b/scripts/one_example.py
@@ -5,7 +5,7 @@
from threading import Thread
import idom
-from idom.widgets.utils import hotswap
+from idom.widgets import hotswap
here = Path(__file__).parent
diff --git a/setup.cfg b/setup.cfg
index 5ac552c3a..5d1bb1235 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -8,12 +8,12 @@ warn_redundant_casts = True
warn_unused_ignores = True
[flake8]
-ignore = E203, E266, E501, W503, F811, N802
+ignore = E203, E266, E501, W503, F811, N802, N806
max-line-length = 88
max-complexity = 18
select = B,C,E,F,W,T4,B9,N,ROH
exclude =
- src/idom/client/app/node_modules/*
+ **/node_modules/*
.eggs/*
.tox/*
diff --git a/setup.py b/setup.py
index 469b1acc7..c8cddf9e8 100644
--- a/setup.py
+++ b/setup.py
@@ -63,16 +63,6 @@ def list2cmdline(cmd_list):
}
-# -----------------------------------------------------------------------------
-# CLI Entrypoints
-# -----------------------------------------------------------------------------
-
-
-package["entry_points"] = {
- "console_scripts": ["idom = idom.__main__:main"],
-}
-
-
# -----------------------------------------------------------------------------
# Requirements
# -----------------------------------------------------------------------------
@@ -129,7 +119,7 @@ class Command(cls):
def run(self):
log.info("Installing Javascript...")
try:
- js_dir = str(package_dir / "client" / "app")
+ js_dir = str(package_dir / "client")
npm = shutil.which("npm") # this is required on windows
if npm is None:
raise RuntimeError("NPM is not installed.")
diff --git a/src/idom/__init__.py b/src/idom/__init__.py
index 21fed6f1a..71efeaf1e 100644
--- a/src/idom/__init__.py
+++ b/src/idom/__init__.py
@@ -10,8 +10,7 @@
__author__ = "idom-team"
-from . import config, log
-from .client.module import Import, Module, install
+from . import config, html, log, web
from .core import hooks
from .core.component import Component, component
from .core.events import Events, event
@@ -19,23 +18,7 @@
from .core.vdom import VdomDict, vdom
from .server.prefab import run
from .utils import Ref, html_to_vdom
-from .widgets.html import html
-from .widgets.utils import hotswap, multiview
-
-
-# try to automatically setup the dialect's import hook
-try:
- import htm
- import pyalect
- import tagged
-except ImportError: # pragma: no cover
- pass
-else:
- from . import dialect
-
- del pyalect
- del tagged
- del htm
+from .widgets import hotswap, multiview
__all__ = [
@@ -51,8 +34,6 @@
"server",
"Ref",
"vdom",
- "Module",
- "Import",
"hotswap",
"multiview",
"html_to_vdom",
@@ -62,4 +43,5 @@
"install",
"log",
"config",
+ "web",
]
diff --git a/src/idom/__main__.py b/src/idom/__main__.py
deleted file mode 100644
index 2f05ddc22..000000000
--- a/src/idom/__main__.py
+++ /dev/null
@@ -1,5 +0,0 @@
-from .cli import main
-
-
-if __name__ == "__main__":
- main()
diff --git a/src/idom/_option.py b/src/idom/_option.py
index 2ee46c941..ef18e02c0 100644
--- a/src/idom/_option.py
+++ b/src/idom/_option.py
@@ -8,16 +8,12 @@
import os
from logging import getLogger
from typing import Any, Callable, Generic, TypeVar, cast
-from weakref import WeakSet
_O = TypeVar("_O")
logger = getLogger(__name__)
-ALL_OPTIONS: WeakSet[Option[Any]] = WeakSet()
-
-
class Option(Generic[_O]):
"""An option that can be set using an environment variable of the same name"""
@@ -35,7 +31,6 @@ def __init__(
if name in os.environ:
self._current = validator(os.environ[name])
logger.debug(f"{self._name}={self.current}")
- ALL_OPTIONS.add(self)
@property
def name(self) -> str:
diff --git a/src/idom/cli.py b/src/idom/cli.py
deleted file mode 100644
index 00701c788..000000000
--- a/src/idom/cli.py
+++ /dev/null
@@ -1,56 +0,0 @@
-from logging.config import dictConfig
-from typing import List
-
-import typer
-
-import idom
-from idom.client import manage as manage_client
-
-from .config import all_options
-from .log import logging_config_defaults
-
-
-main = typer.Typer()
-
-
-@main.callback(invoke_without_command=True, no_args_is_help=True)
-def root(
- version: bool = typer.Option(
- False,
- "--version",
- help="show the current version",
- show_default=False,
- is_eager=True,
- )
-) -> None:
- """Command line interface for IDOM"""
-
- # reset logging config after Typer() has wrapped stdout
- dictConfig(logging_config_defaults())
-
- if version:
- typer.echo(idom.__version__)
-
- return None
-
-
-@main.command()
-def install(packages: List[str]) -> None:
- """Install a Javascript package from NPM into the client"""
- manage_client.build(packages, clean_build=False)
- return None
-
-
-@main.command()
-def restore() -> None:
- """Return to a fresh install of the client"""
- manage_client.restore()
- return None
-
-
-@main.command()
-def options() -> None:
- """Show available global options and their current values"""
- for opt in list(sorted(all_options(), key=lambda opt: opt.name)):
- name = typer.style(opt.name, bold=True)
- typer.echo(f"{name} = {opt.current}")
diff --git a/src/idom/client/app/README.md b/src/idom/client/README.md
similarity index 100%
rename from src/idom/client/app/README.md
rename to src/idom/client/README.md
diff --git a/src/idom/client/_private.py b/src/idom/client/_private.py
deleted file mode 100644
index 8ea00f890..000000000
--- a/src/idom/client/_private.py
+++ /dev/null
@@ -1,104 +0,0 @@
-import json
-import logging
-import re
-import shutil
-from os.path import getmtime
-from pathlib import Path
-from typing import Dict, Set, Tuple, cast
-
-from idom.config import IDOM_CLIENT_BUILD_DIR
-
-
-logger = logging.getLogger(__name__)
-
-HERE = Path(__file__).parent
-APP_DIR = HERE / "app"
-BACKUP_BUILD_DIR = APP_DIR / "build"
-
-# the path relative to the build that contains import sources
-IDOM_CLIENT_IMPORT_SOURCE_INFIX = "_snowpack/pkg"
-
-
-def _run_build_dir_init_only_once() -> None: # pragma: no cover
- """Initialize the runtime build directory - this should only be called once"""
- if not IDOM_CLIENT_BUILD_DIR.current.exists():
- logger.debug("creating new runtime build directory")
- IDOM_CLIENT_BUILD_DIR.current.parent.mkdir(parents=True, exist_ok=True)
- # populate the runtime build directory if it doesn't exist
- shutil.copytree(BACKUP_BUILD_DIR, IDOM_CLIENT_BUILD_DIR.current, symlinks=True)
- elif getmtime(BACKUP_BUILD_DIR) > getmtime(IDOM_CLIENT_BUILD_DIR.current):
- logger.debug("updating runtime build directory because it is out of date")
- # delete the existing runtime build because it's out of date
- shutil.rmtree(IDOM_CLIENT_BUILD_DIR.current)
- # replace it with the newer backup build (presumable from a fresh install)
- shutil.copytree(BACKUP_BUILD_DIR, IDOM_CLIENT_BUILD_DIR.current, symlinks=True)
- else:
- logger.debug("runtime build directory is up to date")
-
-
-_run_build_dir_init_only_once() # this is only ever called once at runtime!
-
-
-def get_user_packages_file(app_dir: Path) -> Path:
- return app_dir / "packages" / "idom-app-react" / "src" / "user-packages.js"
-
-
-def restore_build_dir_from_backup() -> None:
- target = IDOM_CLIENT_BUILD_DIR.current
- if target.exists():
- shutil.rmtree(target)
- shutil.copytree(BACKUP_BUILD_DIR, target, symlinks=True)
-
-
-def replace_build_dir(source: Path) -> None:
- target = IDOM_CLIENT_BUILD_DIR.current
- if target.exists():
- shutil.rmtree(target)
- shutil.copytree(source, target, symlinks=True)
-
-
-def get_package_name(pkg: str) -> str:
- return split_package_name_and_version(pkg)[0]
-
-
-def split_package_name_and_version(pkg: str) -> Tuple[str, str]:
- at_count = pkg.count("@")
- if pkg.startswith("@"):
- if at_count == 1:
- return pkg, ""
- else:
- name, version = pkg[1:].split("@", 1)
- return ("@" + name), version
- elif at_count:
- name, version = pkg.split("@", 1)
- return name, version
- else:
- return pkg, ""
-
-
-def build_dependencies() -> Dict[str, str]:
- package_json = IDOM_CLIENT_BUILD_DIR.current / "package.json"
- return cast(Dict[str, str], json.loads(package_json.read_text())["dependencies"])
-
-
-_JS_MODULE_EXPORT_PATTERN = re.compile(
- r";?\s*export\s*{([0-9a-zA-Z_$\s,]*)}\s*;", re.MULTILINE
-)
-_JS_VAR = r"[a-zA-Z_$][0-9a-zA-Z_$]*"
-_JS_MODULE_EXPORT_NAME_PATTERN = re.compile(
- fr";?\s*export\s+({_JS_VAR})\s+{_JS_VAR}\s*;", re.MULTILINE
-)
-_JS_MODULE_EXPORT_FUNC_PATTERN = re.compile(
- fr";?\s*export\s+function\s+({_JS_VAR})\s*\(.*?", re.MULTILINE
-)
-
-
-def find_js_module_exports_in_source(content: str) -> Set[str]:
- names: Set[str] = set()
- for match in _JS_MODULE_EXPORT_PATTERN.findall(content):
- for export in match.split(","):
- export_parts = export.split(" as ", 1)
- names.add(export_parts[-1].strip())
- names.update(_JS_MODULE_EXPORT_FUNC_PATTERN.findall(content))
- names.update(_JS_MODULE_EXPORT_NAME_PATTERN.findall(content))
- return names
diff --git a/src/idom/client/app/.gitignore b/src/idom/client/app/.gitignore
deleted file mode 100644
index f2e88ad45..000000000
--- a/src/idom/client/app/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-node_modules
-web_modules
-build
diff --git a/src/idom/client/app/packages/idom-app-react/src/user-packages.js b/src/idom/client/app/packages/idom-app-react/src/user-packages.js
deleted file mode 100644
index ff8b4c563..000000000
--- a/src/idom/client/app/packages/idom-app-react/src/user-packages.js
+++ /dev/null
@@ -1 +0,0 @@
-export default {};
diff --git a/src/idom/client/app/idom-logo-square-small.svg b/src/idom/client/idom-logo-square-small.svg
similarity index 100%
rename from src/idom/client/app/idom-logo-square-small.svg
rename to src/idom/client/idom-logo-square-small.svg
diff --git a/src/idom/client/app/index.html b/src/idom/client/index.html
similarity index 100%
rename from src/idom/client/app/index.html
rename to src/idom/client/index.html
diff --git a/src/idom/client/manage.py b/src/idom/client/manage.py
deleted file mode 100644
index 573568e98..000000000
--- a/src/idom/client/manage.py
+++ /dev/null
@@ -1,219 +0,0 @@
-"""
-Client Manager
-==============
-"""
-
-import shutil
-import subprocess
-import sys
-from logging import getLogger
-from pathlib import Path
-from tempfile import TemporaryDirectory
-from typing import Dict, Iterable, List, Sequence, Set, Union
-
-from idom.config import IDOM_CLIENT_BUILD_DIR
-
-from . import _private
-
-
-logger = getLogger(__name__)
-
-
-def web_modules_dir() -> Path:
- """The directory containing all web modules
-
- .. warning::
-
- No assumptions should be made about the exact structure of this directory!
- """
- return IDOM_CLIENT_BUILD_DIR.current / "_snowpack" / "pkg"
-
-
-def web_module_path(package_name: str, must_exist: bool = False) -> Path:
- """Get the :class:`Path` to a web module's source"""
- path = web_modules_dir().joinpath(*(package_name + ".js").split("/"))
- if must_exist and not path.exists():
- raise ValueError(
- f"Web module {package_name!r} does not exist at path {str(path)!r}"
- )
- return path
-
-
-def web_module_exports(package_name: str) -> Set[str]:
- """Get a list of names this module exports"""
- web_module_path(package_name, must_exist=True)
- return _private.find_js_module_exports_in_source(
- web_module_path(package_name).read_text(encoding="utf-8")
- )
-
-
-def web_module_exists(package_name: str) -> bool:
- """Whether a web module with a given name exists"""
- return web_module_path(package_name).exists()
-
-
-def web_module_names() -> Set[str]:
- """Get the names of all installed web modules"""
- names = []
- web_mod_dir = web_modules_dir()
- for pth in web_mod_dir.glob("**/*.js"):
- rel_pth = pth.relative_to(web_mod_dir)
- if Path("common") in rel_pth.parents:
- continue
- module_path = str(rel_pth.as_posix())
- if module_path.endswith(".js"):
- module_path = module_path[:-3]
- names.append(module_path)
- return set(names)
-
-
-def add_web_module(
- package_name: str,
- source: Union[Path, str],
-) -> None:
- """Add a web module from source"""
- resolved_source = Path(source).resolve()
- if not resolved_source.exists():
- raise FileNotFoundError(f"Package source file does not exist: {str(source)!r}")
- target = web_module_path(package_name)
- if target.resolve() == resolved_source:
- return None # already added
- target.parent.mkdir(parents=True, exist_ok=True)
- # this will raise an error if already exists
- target.symlink_to(resolved_source)
-
-
-def remove_web_module(package_name: str, must_exist: bool = False) -> None:
- """Remove a web module"""
- web_module_path(package_name, must_exist).unlink()
-
-
-def restore() -> None:
- _private.restore_build_dir_from_backup()
-
-
-def build(
- packages: Sequence[str],
- clean_build: bool = True,
- skip_if_already_installed: bool = True,
-) -> None:
- """Build the client"""
- package_specifiers_to_install = list(packages)
- del packages # delete since we just renamed it
-
- packages_to_install = _parse_package_specs(package_specifiers_to_install)
- installed_packages = _private.build_dependencies()
-
- if clean_build:
- all_packages = packages_to_install
- else:
- if skip_if_already_installed:
- for pkg_name, pkg_ver in packages_to_install.items():
- if pkg_name not in installed_packages or (
- pkg_ver and installed_packages[pkg_name] != pkg_ver
- ):
- break
- else:
- logger.info(f"Already installed {package_specifiers_to_install}")
- logger.info("Build skipped ✅")
- return None
- all_packages = {**installed_packages, **packages_to_install}
-
- all_package_specifiers = [f"{p}@{v}" if v else p for p, v in all_packages.items()]
-
- with TemporaryDirectory() as tempdir:
- tempdir_path = Path(tempdir)
- temp_app_dir = tempdir_path / "app"
- temp_build_dir = temp_app_dir / "build"
- package_json_path = temp_app_dir / "package.json"
-
- # copy over the whole APP_DIR directory into the temp one
- shutil.copytree(_private.APP_DIR, temp_app_dir, symlinks=True)
-
- _write_user_packages_file(temp_app_dir, list(all_packages))
-
- logger.info("Installing dependencies...")
- _npm_install(all_package_specifiers, temp_app_dir)
- logger.info("Installed successfully ✅")
-
- logger.debug(f"package.json: {package_json_path.read_text()}")
-
- logger.info("Building client ...")
- _npm_run_build(temp_app_dir)
- logger.info("Client built successfully ✅")
-
- _private.replace_build_dir(temp_build_dir)
-
- not_discovered = set(all_packages).difference(web_module_names())
- if not_discovered:
- raise RuntimeError( # pragma: no cover
- f"Successfuly installed {list(all_packages)} but "
- f"failed to discover {list(not_discovered)} post-install."
- )
-
-
-if sys.platform == "win32" and sys.version_info[:2] == (3, 7): # pragma: no cover
-
- def build(
- packages: Sequence[str],
- clean_build: bool = True,
- skip_if_already_installed: bool = True,
- ) -> None:
- msg = (
- "This feature is not available due to a bug in Python<3.8 on Windows - for "
- "more information see: https://bugs.python.org/issue31226"
- )
- try:
- import pytest
- except ImportError:
- raise NotImplementedError(msg)
- else:
- pytest.xfail(msg)
-
-
-def _parse_package_specs(package_strings: Sequence[str]) -> Dict[str, str]:
- return {
- dep: ver
- for dep, ver in map(_private.split_package_name_and_version, package_strings)
- }
-
-
-def _npm_install(packages: List[str], cwd: Path) -> None:
- _run_subprocess(["npm", "install"] + packages, cwd)
-
-
-def _npm_run_build(cwd: Path) -> None:
- _run_subprocess(["npm", "run", "build"], cwd)
-
-
-def _run_subprocess(args: List[str], cwd: Path) -> None:
- cmd, *args = args
- which_cmd = shutil.which(cmd)
- if which_cmd is None:
- raise RuntimeError( # pragma: no cover
- f"Failed to run command - {cmd!r} is not installed."
- )
- try:
- subprocess.run(
- [which_cmd] + args,
- cwd=cwd,
- check=True,
- stdout=subprocess.PIPE,
- stderr=subprocess.PIPE,
- )
- except subprocess.CalledProcessError as error: # pragma: no cover
- raise subprocess.SubprocessError(error.stderr.decode()) from error
- return None
-
-
-def _write_user_packages_file(app_dir: Path, packages: Iterable[str]) -> None:
- _private.get_user_packages_file(app_dir).write_text(
- _USER_PACKAGES_FILE_TEMPLATE.format(
- imports=",".join(f'"{pkg}":import({pkg!r})' for pkg in packages)
- )
- )
-
-
-_USER_PACKAGES_FILE_TEMPLATE = """// THIS FILE WAS GENERATED BY IDOM - DO NOT MODIFY
-export default {{{imports}}};
-"""
diff --git a/src/idom/client/module.py b/src/idom/client/module.py
deleted file mode 100644
index 4a0e4acef..000000000
--- a/src/idom/client/module.py
+++ /dev/null
@@ -1,230 +0,0 @@
-"""
-Client Modules
-==============
-"""
-
-from __future__ import annotations
-
-from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, Tuple, Union, overload
-from urllib.parse import urlparse
-
-from idom.core.vdom import ImportSourceDict, VdomDict, make_vdom_constructor
-
-from . import _private, manage
-
-
-@overload
-def install(
- packages: str,
- ignore_installed: bool,
- fallback: Optional[str],
-) -> Module:
- ...
-
-
-@overload
-def install(
- packages: Union[List[str], Tuple[str]],
- ignore_installed: bool,
- fallback: Optional[str],
-) -> List[Module]:
- ...
-
-
-def install(
- packages: Union[str, List[str], Tuple[str]],
- ignore_installed: bool = False,
- fallback: Optional[str] = None,
-) -> Union[Module, List[Module]]:
- return_one = False
- if isinstance(packages, str):
- packages = [packages]
- return_one = True
-
- pkg_names = [_private.get_package_name(pkg) for pkg in packages]
-
- if ignore_installed or set(pkg_names).difference(manage.web_module_names()):
- manage.build(packages, clean_build=False)
-
- if return_one:
- return Module(pkg_names[0], fallback=fallback)
- else:
- return [Module(pkg, fallback=fallback) for pkg in pkg_names]
-
-
-NAME_SOURCE = "NAME"
-"""A named souce - usually a Javascript package name"""
-
-URL_SOURCE = "URL"
-"""A source loaded from a URL, usually from a CDN"""
-
-SOURCE_TYPES = {NAME_SOURCE, URL_SOURCE}
-"""The possible source types for a :class:`Module`"""
-
-
-class Module:
- """A Javascript module
-
- Parameters:
- source:
- The URL to an ECMAScript module which exports React components
- (*with* a ``.js`` file extension) or name of a module installed in the
- built-in client application (*without* a ``.js`` file extension).
- source_type:
- The type of the given ``source``. See :const:`SOURCE_TYPES` for the set of
- possible values.
- file:
- Only applicable if running on a client app which supports this feature.
- Dynamically install the code in the give file as a single-file module. The
- built-in client will inject this module adjacent to other installed modules
- which means they can be imported via a relative path like
- ``./some-other-installed-module.js``.
- fallack:
- What to display while the modules is being loaded.
-
- Attributes:
- installed:
- Whether or not this module has been installed into the built-in client app.
- url:
- The URL this module will be imported from.
- """
-
- __slots__ = "source", "source_type", "fallback", "exports"
-
- def __init__(
- self,
- source: str,
- source_type: Optional[str] = None,
- source_file: Optional[Union[str, Path]] = None,
- fallback: Optional[str] = None,
- check_exports: Optional[bool] = None,
- ) -> None:
- self.source = source
- self.fallback = fallback
- self.exports: Optional[Set[str]] = None
-
- if source_type is None:
- self.source_type = URL_SOURCE if _is_url(source) else NAME_SOURCE
- elif source_type in SOURCE_TYPES:
- self.source_type = source_type
- else:
- raise ValueError(f"Invalid source type {source_type!r}")
-
- if self.source_type == URL_SOURCE:
- if check_exports is True:
- raise ValueError(f"Can't check exports for source type {source_type!r}")
- elif source_file is not None:
- raise ValueError(f"File given, but source type is {source_type!r}")
- else:
- return None
- elif check_exports is None:
- check_exports = True
-
- if source_file is not None:
- manage.add_web_module(source, source_file)
- elif not manage.web_module_exists(source):
- raise ValueError(f"Module {source!r} does not exist")
-
- if check_exports:
- self.exports = manage.web_module_exports(source)
-
- def declare(
- self,
- name: str,
- has_children: bool = True,
- fallback: Optional[str] = None,
- ) -> Import:
- """Return an :class:`Import` for the given :class:`Module` and ``name``
-
- This roughly translates to the javascript statement
-
- .. code-block:: javascript
-
- import { name } from "module"
-
- Where ``name`` is the given name, and ``module`` is the :attr:`Module.url` of
- this :class:`Module` instance.
- """
- if self.exports is not None and name not in self.exports:
- raise ValueError(
- f"{self} does not export {name!r}, available options are {list(self.exports)}"
- )
-
- return Import(
- name,
- self.source,
- self.source_type,
- has_children,
- fallback or self.fallback,
- )
-
- def __getattr__(self, name: str) -> Import:
- if name[0].lower() == name[0]:
- # component names should be capitalized
- raise AttributeError(f"{self} has no attribute {name!r}")
- return self.declare(name)
-
- def __eq__(self, other: Any) -> bool:
- return (
- isinstance(other, Module)
- and self.source == other.source
- and self.source_type == other.source_type
- )
-
- def __repr__(self) -> str:
- return f"{type(self).__name__}({self.source})"
-
-
-class Import:
- """Import a react module
-
- Once imported, you can instantiate the library's components by calling them
- via attribute-access.
-
- Examples:
-
- .. code-block:: python
-
- victory = idom.Import("victory", "VictoryBar" install=True)
- style = {"parent": {"width": "500px"}}
- victory.VictoryBar({"style": style}, fallback="loading...")
- """
-
- __slots__ = "_constructor", "_import_source", "_name"
-
- def __init__(
- self,
- name: str,
- source: str,
- source_type: str,
- has_children: bool = True,
- fallback: Optional[str] = None,
- ) -> None:
- self._name = name
- self._constructor = make_vdom_constructor(name, has_children)
- self._import_source = ImportSourceDict(
- source=source,
- sourceType=source_type,
- fallback=fallback,
- )
-
- def __call__(
- self,
- *args: Any,
- **kwargs: Any,
- ) -> VdomDict:
- return self._constructor(import_source=self._import_source, *args, **kwargs)
-
- def __repr__(self) -> str:
- info: Dict[str, Any] = {"name": self._name, **self._import_source}
- strings = ", ".join(f"{k}={v!r}" for k, v in info.items())
- return f"{type(self).__name__}({strings})"
-
-
-def _is_url(string: str) -> bool:
- if string.startswith("/") or string.startswith("./") or string.startswith("../"):
- return True
- else:
- parsed = urlparse(string)
- return bool(parsed.scheme and parsed.netloc)
diff --git a/src/idom/client/app/package-lock.json b/src/idom/client/package-lock.json
similarity index 99%
rename from src/idom/client/app/package-lock.json
rename to src/idom/client/package-lock.json
index 045bbd4f7..a04120515 100644
--- a/src/idom/client/app/package-lock.json
+++ b/src/idom/client/package-lock.json
@@ -2663,7 +2663,7 @@
},
"packages/idom-app-react/packages/idom-client-react": {},
"packages/idom-client-react": {
- "version": "0.8.2",
+ "version": "0.8.3",
"license": "MIT",
"dependencies": {
"fast-json-patch": "^3.0.0-1",
@@ -2672,8 +2672,6 @@
"devDependencies": {
"jsdom": "16.3.0",
"prettier": "^2.2.1",
- "react": "^16.13.1",
- "react-dom": "^16.13.1",
"uvu": "^0.5.1"
},
"peerDependencies": {
@@ -3469,8 +3467,6 @@
"htm": "^3.0.3",
"jsdom": "16.3.0",
"prettier": "^2.2.1",
- "react": "^16.13.1",
- "react-dom": "^16.13.1",
"uvu": "^0.5.1"
}
},
diff --git a/src/idom/client/app/package.json b/src/idom/client/package.json
similarity index 100%
rename from src/idom/client/app/package.json
rename to src/idom/client/package.json
diff --git a/src/idom/client/app/packages/idom-app-react/package.json b/src/idom/client/packages/idom-app-react/package.json
similarity index 100%
rename from src/idom/client/app/packages/idom-app-react/package.json
rename to src/idom/client/packages/idom-app-react/package.json
diff --git a/src/idom/client/app/packages/idom-app-react/src/index.js b/src/idom/client/packages/idom-app-react/src/index.js
similarity index 78%
rename from src/idom/client/app/packages/idom-app-react/src/index.js
rename to src/idom/client/packages/idom-app-react/src/index.js
index 50a639f9f..0e24439ac 100644
--- a/src/idom/client/app/packages/idom-app-react/src/index.js
+++ b/src/idom/client/packages/idom-app-react/src/index.js
@@ -1,14 +1,5 @@
import { mountLayoutWithWebSocket } from "idom-client-react";
-// imported so static analysis knows to pick up files linked by user-packages.js
-import("./user-packages.js").then((module) => {
- for (const pkgName in module.default) {
- module.default[pkgName].then((pkg) => {
- console.log(`Loaded module '${pkgName}'`);
- });
- }
-});
-
export function mount(mountPoint) {
mountLayoutWithWebSocket(
mountPoint,
@@ -35,7 +26,7 @@ function getWebSocketEndpoint() {
}
function loadImportSource(source, sourceType) {
- return import(sourceType == "NAME" ? `./${source}.js` : source);
+ return import(sourceType == "NAME" ? `/modules/${source}` : source);
}
function shouldReconnect() {
diff --git a/src/idom/client/app/packages/idom-client-react/.gitignore b/src/idom/client/packages/idom-client-react/.gitignore
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/.gitignore
rename to src/idom/client/packages/idom-client-react/.gitignore
diff --git a/src/idom/client/app/packages/idom-client-react/README.md b/src/idom/client/packages/idom-client-react/README.md
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/README.md
rename to src/idom/client/packages/idom-client-react/README.md
diff --git a/src/idom/client/app/packages/idom-client-react/package-lock.json b/src/idom/client/packages/idom-client-react/package-lock.json
similarity index 98%
rename from src/idom/client/app/packages/idom-client-react/package-lock.json
rename to src/idom/client/packages/idom-client-react/package-lock.json
index e590bff4f..72b4b3999 100644
--- a/src/idom/client/app/packages/idom-client-react/package-lock.json
+++ b/src/idom/client/packages/idom-client-react/package-lock.json
@@ -1,22 +1,20 @@
{
"name": "idom-client-react",
- "version": "0.7.4",
+ "version": "0.8.3",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
- "version": "0.7.4",
+ "version": "0.8.3",
"license": "MIT",
"dependencies": {
"fast-json-patch": "^3.0.0-1",
- "htm": "^3.0.3"
+ "htm": "^3.0.3",
+ "preact": "^10.5.13"
},
"devDependencies": {
- "esm": "^3.2.25",
"jsdom": "16.3.0",
"prettier": "^2.2.1",
- "react": "^16.13.1",
- "react-dom": "^16.13.1",
"uvu": "^0.5.1"
},
"peerDependencies": {
@@ -297,15 +295,6 @@
"source-map": "~0.6.1"
}
},
- "node_modules/esm": {
- "version": "3.2.25",
- "resolved": "https://registry.npmjs.org/esm/-/esm-3.2.25.tgz",
- "integrity": "sha512-U1suiZ2oDVWv4zPO56S0NcR5QriEahGtdN2OR6FiOG4WJvcjBVFB0qI4+eKoWFH483PKGuLuu6V8Z4T5g63UVA==",
- "dev": true,
- "engines": {
- "node": ">=6"
- }
- },
"node_modules/esprima": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
@@ -505,7 +494,7 @@
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
"integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
- "dev": true
+ "peer": true
},
"node_modules/jsbn": {
"version": "0.1.1",
@@ -623,7 +612,7 @@
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
"integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
- "dev": true,
+ "peer": true,
"dependencies": {
"js-tokens": "^3.0.0 || ^4.0.0"
},
@@ -680,7 +669,7 @@
"version": "4.1.1",
"resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz",
"integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=",
- "dev": true,
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
@@ -714,6 +703,15 @@
"integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=",
"dev": true
},
+ "node_modules/preact": {
+ "version": "10.5.13",
+ "resolved": "https://registry.npmjs.org/preact/-/preact-10.5.13.tgz",
+ "integrity": "sha512-q/vlKIGNwzTLu+jCcvywgGrt+H/1P/oIRSD6mV4ln3hmlC+Aa34C7yfPI4+5bzW8pONyVXYS7SvXosy2dKKtWQ==",
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/preact"
+ }
+ },
"node_modules/prelude-ls": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz",
@@ -739,7 +737,7 @@
"version": "15.7.2",
"resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.7.2.tgz",
"integrity": "sha512-8QQikdH7//R2vurIJSutZ1smHYTcLpRWEOlHnzcWHmBYrOGUysKwSsrC89BCiFj3CbrfJ/nXFdJepOVrY1GCHQ==",
- "dev": true,
+ "peer": true,
"dependencies": {
"loose-envify": "^1.4.0",
"object-assign": "^4.1.1",
@@ -774,7 +772,7 @@
"version": "16.14.0",
"resolved": "https://registry.npmjs.org/react/-/react-16.14.0.tgz",
"integrity": "sha512-0X2CImDkJGApiAlcf0ODKIneSwBPhqJawOa5wCtKbu7ZECrmS26NvtSILynQ66cgkT/RJ4LidJOc3bUESwmU8g==",
- "dev": true,
+ "peer": true,
"dependencies": {
"loose-envify": "^1.1.0",
"object-assign": "^4.1.1",
@@ -788,7 +786,7 @@
"version": "16.14.0",
"resolved": "https://registry.npmjs.org/react-dom/-/react-dom-16.14.0.tgz",
"integrity": "sha512-1gCeQXDLoIqMgqD3IO2Ah9bnf0w9kzhwN5q4FGnHZ67hBm9yePzB5JJAIQCc8x3pFnNlwFq4RidZggNAAkzWWw==",
- "dev": true,
+ "peer": true,
"dependencies": {
"loose-envify": "^1.1.0",
"object-assign": "^4.1.1",
@@ -803,7 +801,7 @@
"version": "16.13.1",
"resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz",
"integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==",
- "dev": true
+ "peer": true
},
"node_modules/request": {
"version": "2.88.2",
@@ -950,7 +948,7 @@
"version": "0.19.1",
"resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.19.1.tgz",
"integrity": "sha512-n/zwRWRYSUj0/3g/otKDRPMh6qv2SYMWNq85IEa8iZyAv8od9zDYpGSnpBEjNgcMNq6Scbu5KfIPxNF72R/2EA==",
- "dev": true,
+ "peer": true,
"dependencies": {
"loose-envify": "^1.1.0",
"object-assign": "^4.1.1"
@@ -1447,12 +1445,6 @@
"source-map": "~0.6.1"
}
},
- "esm": {
- "version": "3.2.25",
- "resolved": "https://registry.npmjs.org/esm/-/esm-3.2.25.tgz",
- "integrity": "sha512-U1suiZ2oDVWv4zPO56S0NcR5QriEahGtdN2OR6FiOG4WJvcjBVFB0qI4+eKoWFH483PKGuLuu6V8Z4T5g63UVA==",
- "dev": true
- },
"esprima": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
@@ -1610,7 +1602,7 @@
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
"integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
- "dev": true
+ "peer": true
},
"jsbn": {
"version": "0.1.1",
@@ -1708,7 +1700,7 @@
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
"integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
- "dev": true,
+ "peer": true,
"requires": {
"js-tokens": "^3.0.0 || ^4.0.0"
}
@@ -1750,7 +1742,7 @@
"version": "4.1.1",
"resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz",
"integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=",
- "dev": true
+ "peer": true
},
"optionator": {
"version": "0.8.3",
@@ -1778,6 +1770,11 @@
"integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=",
"dev": true
},
+ "preact": {
+ "version": "10.5.13",
+ "resolved": "https://registry.npmjs.org/preact/-/preact-10.5.13.tgz",
+ "integrity": "sha512-q/vlKIGNwzTLu+jCcvywgGrt+H/1P/oIRSD6mV4ln3hmlC+Aa34C7yfPI4+5bzW8pONyVXYS7SvXosy2dKKtWQ=="
+ },
"prelude-ls": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz",
@@ -1794,7 +1791,7 @@
"version": "15.7.2",
"resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.7.2.tgz",
"integrity": "sha512-8QQikdH7//R2vurIJSutZ1smHYTcLpRWEOlHnzcWHmBYrOGUysKwSsrC89BCiFj3CbrfJ/nXFdJepOVrY1GCHQ==",
- "dev": true,
+ "peer": true,
"requires": {
"loose-envify": "^1.4.0",
"object-assign": "^4.1.1",
@@ -1823,7 +1820,7 @@
"version": "16.14.0",
"resolved": "https://registry.npmjs.org/react/-/react-16.14.0.tgz",
"integrity": "sha512-0X2CImDkJGApiAlcf0ODKIneSwBPhqJawOa5wCtKbu7ZECrmS26NvtSILynQ66cgkT/RJ4LidJOc3bUESwmU8g==",
- "dev": true,
+ "peer": true,
"requires": {
"loose-envify": "^1.1.0",
"object-assign": "^4.1.1",
@@ -1834,7 +1831,7 @@
"version": "16.14.0",
"resolved": "https://registry.npmjs.org/react-dom/-/react-dom-16.14.0.tgz",
"integrity": "sha512-1gCeQXDLoIqMgqD3IO2Ah9bnf0w9kzhwN5q4FGnHZ67hBm9yePzB5JJAIQCc8x3pFnNlwFq4RidZggNAAkzWWw==",
- "dev": true,
+ "peer": true,
"requires": {
"loose-envify": "^1.1.0",
"object-assign": "^4.1.1",
@@ -1846,7 +1843,7 @@
"version": "16.13.1",
"resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz",
"integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==",
- "dev": true
+ "peer": true
},
"request": {
"version": "2.88.2",
@@ -1954,7 +1951,7 @@
"version": "0.19.1",
"resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.19.1.tgz",
"integrity": "sha512-n/zwRWRYSUj0/3g/otKDRPMh6qv2SYMWNq85IEa8iZyAv8od9zDYpGSnpBEjNgcMNq6Scbu5KfIPxNF72R/2EA==",
- "dev": true,
+ "peer": true,
"requires": {
"loose-envify": "^1.1.0",
"object-assign": "^4.1.1"
diff --git a/src/idom/client/app/packages/idom-client-react/package.json b/src/idom/client/packages/idom-client-react/package.json
similarity index 89%
rename from src/idom/client/app/packages/idom-client-react/package.json
rename to src/idom/client/packages/idom-client-react/package.json
index 845889d36..42ffc6d46 100644
--- a/src/idom/client/app/packages/idom-client-react/package.json
+++ b/src/idom/client/packages/idom-client-react/package.json
@@ -1,7 +1,7 @@
{
"name": "idom-client-react",
"description": "A client for IDOM implemented in React",
- "version": "0.8.2",
+ "version": "0.8.3",
"author": "Ryan Morshead",
"license": "MIT",
"type": "module",
@@ -20,8 +20,6 @@
"devDependencies": {
"jsdom": "16.3.0",
"prettier": "^2.2.1",
- "react": "^16.13.1",
- "react-dom": "^16.13.1",
"uvu": "^0.5.1"
},
"dependencies": {
diff --git a/src/idom/client/app/packages/idom-client-react/src/component.js b/src/idom/client/packages/idom-client-react/src/component.js
similarity index 87%
rename from src/idom/client/app/packages/idom-client-react/src/component.js
rename to src/idom/client/packages/idom-client-react/src/component.js
index b7fec67b3..9217985d6 100644
--- a/src/idom/client/app/packages/idom-client-react/src/component.js
+++ b/src/idom/client/packages/idom-client-react/src/component.js
@@ -7,7 +7,7 @@ import serializeEvent from "./event-to-object";
import { applyPatchInplace, joinUrl } from "./utils";
const html = htm.bind(react.createElement);
-const LayoutConfigContext = react.createContext({
+export const LayoutConfigContext = react.createContext({
sendEvent: undefined,
loadImportSource: undefined,
});
@@ -28,7 +28,7 @@ export function Layout({ saveUpdateHook, sendEvent, loadImportSource }) {
}
}
-function Element({ model, key }) {
+export function Element({ model, key }) {
if (model.importSource) {
return html`<${ImportedElement} model=${model} />`;
} else {
@@ -36,6 +36,21 @@ function Element({ model, key }) {
}
}
+export function elementChildren(modelChildren) {
+ if (!modelChildren) {
+ return [];
+ } else {
+ return modelChildren.map((child) => {
+ switch (typeof child) {
+ case "object":
+ return html`<${Element} key=${child.key} model=${child} />`;
+ case "string":
+ return child;
+ }
+ });
+ }
+}
+
function StandardElement({ model }) {
const config = react.useContext(LayoutConfigContext);
const children = elementChildren(model.children);
@@ -58,7 +73,12 @@ function ImportedElement({ model }) {
react.useEffect(() => {
if (fallback) {
- reactDOM.unmountComponentAtNode(mountPoint.current);
+ importSource.then(() => {
+ reactDOM.unmountComponentAtNode(mountPoint.current);
+ if (mountPoint.current.children) {
+ mountPoint.current.removeChild(mountPoint.current.children[0]);
+ }
+ });
}
}, []);
@@ -87,7 +107,8 @@ function ImportedElement({ model }) {
if (!fallback) {
return html``;
} else if (typeof fallback == "string") {
- return html`
${fallback}
`;
+ // need the second div there so we can removeChild above
+ return html`
${fallback}
`;
} else {
return html`
<${StandardElement} model=${fallback} />
@@ -95,21 +116,6 @@ function ImportedElement({ model }) {
}
}
-function elementChildren(modelChildren) {
- if (!modelChildren) {
- return [];
- } else {
- return modelChildren.map((child) => {
- switch (typeof child) {
- case "object":
- return html`<${Element} key=${child.key} model=${child} />`;
- case "string":
- return child;
- }
- });
- }
-}
-
function elementAttributes(model, sendEvent) {
const attributes = Object.assign({}, model.attributes);
@@ -158,22 +164,13 @@ function loadFromImportSource(config, importSource) {
typeof module.unmountElement == "function"
) {
return {
- createElement: (type, props) =>
- module.createElement(module[type], props),
+ createElement: (type, props, children) =>
+ module.createElement(module[type], props, children, config),
renderElement: module.renderElement,
unmountElement: module.unmountElement,
};
} else {
- return {
- createElement: (type, props, children) =>
- react.createElement(
- module[type],
- props,
- ...elementChildren(children)
- ),
- renderElement: reactDOM.render,
- unmountElement: reactDOM.unmountComponentAtNode,
- };
+ console.error(`${module} does not expose the required interfaces`);
}
});
}
diff --git a/src/idom/client/app/packages/idom-client-react/src/event-to-object.js b/src/idom/client/packages/idom-client-react/src/event-to-object.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/src/event-to-object.js
rename to src/idom/client/packages/idom-client-react/src/event-to-object.js
diff --git a/src/idom/client/app/packages/idom-client-react/src/index.js b/src/idom/client/packages/idom-client-react/src/index.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/src/index.js
rename to src/idom/client/packages/idom-client-react/src/index.js
diff --git a/src/idom/client/app/packages/idom-client-react/src/mount.js b/src/idom/client/packages/idom-client-react/src/mount.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/src/mount.js
rename to src/idom/client/packages/idom-client-react/src/mount.js
diff --git a/src/idom/client/app/packages/idom-client-react/src/utils.js b/src/idom/client/packages/idom-client-react/src/utils.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/src/utils.js
rename to src/idom/client/packages/idom-client-react/src/utils.js
diff --git a/src/idom/client/app/packages/idom-client-react/tests/event-to-object.test.js b/src/idom/client/packages/idom-client-react/tests/event-to-object.test.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/tests/event-to-object.test.js
rename to src/idom/client/packages/idom-client-react/tests/event-to-object.test.js
diff --git a/src/idom/client/app/packages/idom-client-react/tests/tooling/dom.js b/src/idom/client/packages/idom-client-react/tests/tooling/dom.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/tests/tooling/dom.js
rename to src/idom/client/packages/idom-client-react/tests/tooling/dom.js
diff --git a/src/idom/client/app/packages/idom-client-react/tests/tooling/setup.js b/src/idom/client/packages/idom-client-react/tests/tooling/setup.js
similarity index 100%
rename from src/idom/client/app/packages/idom-client-react/tests/tooling/setup.js
rename to src/idom/client/packages/idom-client-react/tests/tooling/setup.js
diff --git a/src/idom/client/app/snowpack.config.js b/src/idom/client/snowpack.config.js
similarity index 100%
rename from src/idom/client/app/snowpack.config.js
rename to src/idom/client/snowpack.config.js
diff --git a/src/idom/config.py b/src/idom/config.py
index fa3e3cd85..c3ae8292e 100644
--- a/src/idom/config.py
+++ b/src/idom/config.py
@@ -6,23 +6,12 @@
variables or, for those which allow it, a programatic interface.
"""
-import shutil
from pathlib import Path
-from typing import Any, List
+from tempfile import TemporaryDirectory
-from appdirs import user_data_dir
-
-import idom
-
-from ._option import ALL_OPTIONS as _ALL_OPTIONS
from ._option import Option as _Option
-def all_options() -> List[_Option[Any]]:
- """Get a list of all options"""
- return list(_ALL_OPTIONS)
-
-
IDOM_DEBUG_MODE = _Option(
"IDOM_DEBUG_MODE",
default=False,
@@ -38,9 +27,12 @@ def all_options() -> List[_Option[Any]]:
is set to ``DEBUG``.
"""
-IDOM_CLIENT_BUILD_DIR = _Option(
- "IDOM_CLIENT_BUILD_DIR",
- default=Path(user_data_dir(idom.__name__, idom.__author__)) / "client",
+# Because these web modules will be linked dynamically at runtime this can be temporary
+_DEFAULT_WEB_MODULES_DIR = TemporaryDirectory()
+
+IDOM_WED_MODULES_DIR = _Option(
+ "IDOM_WED_MODULES_DIR",
+ default=Path(_DEFAULT_WEB_MODULES_DIR.name),
validator=Path,
)
"""The location IDOM will use to store its client application
@@ -50,11 +42,6 @@ def all_options() -> List[_Option[Any]]:
a set of publically available APIs for working with the client.
"""
-# TODO: remove this in 0.30.0
-_DEPRECATED_BUILD_DIR = Path(__file__).parent / "client" / "build"
-if _DEPRECATED_BUILD_DIR.exists(): # pragma: no cover
- shutil.rmtree(_DEPRECATED_BUILD_DIR)
-
IDOM_FEATURE_INDEX_AS_DEFAULT_KEY = _Option(
"IDOM_FEATURE_INDEX_AS_DEFAULT_KEY",
default=False,
diff --git a/src/idom/core/vdom.py b/src/idom/core/vdom.py
index d542954e5..166c4ddd9 100644
--- a/src/idom/core/vdom.py
+++ b/src/idom/core/vdom.py
@@ -106,7 +106,7 @@ class _VdomDictRequired(TypedDict, total=True):
class VdomDict(_VdomDictRequired, _VdomDictOptional):
- """A VDOM dictionary"""
+ """A VDOM dictionary - see :ref:`VDOM Mimetype` for more info"""
_AttributesAndChildrenArg = Union[Mapping[str, Any], str, Iterable[Any], Any]
@@ -201,7 +201,7 @@ def constructor(
qualname_prefix = constructor.__qualname__.rsplit(".", 1)[0]
constructor.__qualname__ = qualname_prefix + f".{tag}"
constructor.__doc__ = (
- f"""Create a new ``<{tag}/>`` - returns :ref:`VDOM `."""
+ f"""Create a new ``<{tag}/>`` - returns a :class:`VdomDict`."""
)
return constructor
diff --git a/src/idom/dialect.py b/src/idom/dialect.py
deleted file mode 100644
index b2b74e5a1..000000000
--- a/src/idom/dialect.py
+++ /dev/null
@@ -1,174 +0,0 @@
-"""
-HTML Language Extension
-=======================
-"""
-
-import ast
-from typing import Any, List, Optional, Tuple, Union
-
-import htm
-from pyalect import Dialect, DialectError
-
-
-class HtmlDialectTranspiler(Dialect, name="html"):
- """An HTML dialect transpiler for Python."""
-
- def __init__(self, filename: Optional[str] = None):
- self.filename: str = filename or ""
-
- def transform_src(self, source: str) -> str:
- return source
-
- def transform_ast(self, node: ast.AST) -> ast.AST:
- new_node: ast.AST = HtmlDialectNodeTransformer(self.filename).visit(node)
- return new_node
-
-
-class HtmlDialectNodeTransformer(ast.NodeTransformer):
- def __init__(self, filename: str):
- super().__init__()
- self.filename = filename
-
- def visit_Call(self, node: ast.Call) -> Optional[ast.AST]:
- if isinstance(node.func, ast.Name):
- if node.func.id == "html":
- if (
- not node.keywords
- and len(node.args) == 1
- and isinstance(node.args[0], ast.JoinedStr)
- ):
- try:
- new_node = self._transform_string(node.args[0])
- except htm.ParseError as error:
- raise DialectError(str(error), self.filename, node.lineno)
- return self.generic_visit(
- ast.fix_missing_locations(ast.copy_location(new_node, node))
- )
- return node
-
- def _transform_string(self, node: ast.JoinedStr) -> ast.Call:
- htm_strings: List[str] = []
- exp_nodes: List[ast.AST] = []
- for inner_node in node.values:
- if isinstance(inner_node, ast.Str):
- htm_strings.append(inner_node.s)
- elif isinstance(inner_node, ast.FormattedValue):
- if len(htm_strings) == len(exp_nodes):
- htm_strings.append("")
- if inner_node.conversion != -1 or inner_node.format_spec:
- exp_nodes.append(ast.JoinedStr([inner_node]))
- else:
- exp_nodes.append(inner_node.value)
-
- call_stack = _HtmlCallStack()
- for op_type, *data in htm.htm_parse(htm_strings):
- getattr(self, f"_transform_htm_{op_type.lower()}")(
- exp_nodes, call_stack, *data
- )
- return call_stack.finish()
-
- def _transform_htm_open(
- self,
- exp_nodes: List[ast.AST],
- call_stack: "_HtmlCallStack",
- is_index: bool,
- tag_or_index: Union[str, int],
- ) -> None:
- if isinstance(tag_or_index, int):
- call_stack.begin_child(exp_nodes[tag_or_index])
- else:
- call_stack.begin_child(ast.Str(tag_or_index))
-
- def _transform_htm_close(
- self, exp_nodes: List[ast.AST], call_stack: "_HtmlCallStack"
- ) -> None:
- call_stack.end_child()
-
- def _transform_htm_spread(
- self, exp_nodes: List[ast.AST], call_stack: "_HtmlCallStack", _: Any, index: int
- ) -> None:
- call_stack.add_attributes(None, exp_nodes[index])
-
- def _transform_htm_prop_single(
- self,
- exp_nodes: List[ast.AST],
- call_stack: "_HtmlCallStack",
- attr: str,
- is_index: bool,
- value_or_index: Union[str, int],
- ) -> None:
- if isinstance(value_or_index, bool):
- const = ast.NameConstant(value_or_index)
- call_stack.add_attributes(ast.Str(attr), const)
- elif isinstance(value_or_index, int):
- call_stack.add_attributes(ast.Str(attr), exp_nodes[value_or_index])
- else:
- call_stack.add_attributes(ast.Str(attr), ast.Str(value_or_index))
-
- def _transform_htm_prop_multi(
- self,
- exp_nodes: List[ast.AST],
- call_stack: "_HtmlCallStack",
- attr: str,
- items: Tuple[Tuple[bool, Union[str, int]]],
- ) -> None:
- op_root = current_op = ast.BinOp(None, None, None)
- for _, value_or_index in items:
- if isinstance(value_or_index, str):
- current_op.right = ast.BinOp(ast.Str(value_or_index), ast.Add(), None)
- else:
- current_op.right = ast.BinOp(exp_nodes[value_or_index], ast.Add(), None)
- last_op = current_op
- current_op = current_op.right
- last_op.right = current_op.left
- call_stack.add_attributes(ast.Str(attr), op_root.right)
-
- def _transform_htm_child(
- self,
- exp_nodes: List[ast.AST],
- call_stack: "_HtmlCallStack",
- is_index: bool,
- child_or_index: Union[str, int],
- ) -> None:
- if isinstance(child_or_index, int):
- call_stack.add_child(exp_nodes[child_or_index])
- else:
- call_stack.add_child(ast.Str(child_or_index))
-
-
-class _HtmlCallStack:
- def __init__(self) -> None:
- self._root = self._new(ast.Str())
- self._stack: List[ast.Call] = [self._root]
-
- def begin_child(self, tag: ast.AST) -> None:
- new = self._new(tag)
- last = self._stack[-1]
- children = last.args[2].elts # type: ignore
- children.append(new)
- self._stack.append(new)
-
- def add_child(self, child: ast.AST) -> None:
- current = self._stack[-1]
- children = current.args[2].elts # type: ignore
- children.append(child)
-
- def add_attributes(self, key: Optional[ast.Str], value: ast.AST) -> None:
- current = self._stack[-1]
- attributes: ast.Dict = current.args[1] # type: ignore
- attributes.keys.append(key)
- attributes.values.append(value) # type: ignore
-
- def end_child(self) -> None:
- self._stack.pop(-1)
-
- def finish(self) -> ast.Call:
- root = self._root
- self._root = self._new(ast.Str())
- self._stack.clear()
- return root.args[2].elts[0] # type: ignore
-
- @staticmethod
- def _new(tag: ast.AST) -> ast.Call:
- args = [tag, ast.Dict([], []), ast.List([], ast.Load())]
- return ast.Call(ast.Name("html", ast.Load()), args, [])
diff --git a/src/idom/html.py b/src/idom/html.py
new file mode 100644
index 000000000..b357fafec
--- /dev/null
+++ b/src/idom/html.py
@@ -0,0 +1,218 @@
+"""
+Standard HTML Elements
+======================
+
+
+External sources
+----------------
+
+link = make_vdom_constructor("link", allow_children=False)
+
+
+Content Sectioning
+------------------
+
+- :func:`style`
+- :func:`address`
+- :func:`article`
+- :func:`aside`
+- :func:`footer`
+- :func:`h1`
+- :func:`h2`
+- :func:`h3`
+- :func:`h4`
+- :func:`h5`
+- :func:`h6`
+- :func:`header`
+- :func:`hgroup`
+- :func:`nav`
+- :func:`section`
+
+
+Text Content
+------------
+- :func:`blockquote`
+- :func:`dd`
+- :func:`div`
+- :func:`dl`
+- :func:`dt`
+- :func:`figcaption`
+- :func:`figure`
+- :func:`hr`
+- :func:`li`
+- :func:`ol`
+- :func:`p`
+- :func:`pre`
+- :func:`ul`
+
+
+Inline Text Semantics
+---------------------
+
+- :func:`a`
+- :func:`abbr`
+- :func:`b`
+- :func:`br`
+- :func:`cite`
+- :func:`code`
+- :func:`data`
+- :func:`em`
+- :func:`i`
+- :func:`kbd`
+- :func:`mark`
+- :func:`q`
+- :func:`s`
+- :func:`samp`
+- :func:`small`
+- :func:`span`
+- :func:`strong`
+- :func:`sub`
+- :func:`sup`
+- :func:`time`
+- :func:`u`
+- :func:`var`
+
+
+Image and video
+---------------
+
+- :func:`img`
+- :func:`audio`
+- :func:`video`
+- :func:`source`
+
+
+Table Content
+-------------
+
+- :func:`caption`
+- :func:`col`
+- :func:`colgroup`
+- :func:`table`
+- :func:`tbody`
+- :func:`td`
+- :func:`tfoot`
+- :func:`th`
+- :func:`thead`
+- :func:`tr`
+
+
+Forms
+-----
+
+- :func:`meter`
+- :func:`output`
+- :func:`progress`
+- :func:`input`
+- :func:`button`
+- :func:`label`
+- :func:`fieldset`
+- :func:`legend`
+
+
+Interactive Elements
+--------------------
+
+- :func:`details`
+- :func:`dialog`
+- :func:`menu`
+- :func:`menuitem`
+- :func:`summary`
+"""
+
+from .core.vdom import make_vdom_constructor
+
+
+# External sources
+link = make_vdom_constructor("link", allow_children=False)
+
+# Content sectioning
+style = make_vdom_constructor("style")
+address = make_vdom_constructor("address")
+article = make_vdom_constructor("article")
+aside = make_vdom_constructor("aside")
+footer = make_vdom_constructor("footer")
+h1 = make_vdom_constructor("h1")
+h2 = make_vdom_constructor("h2")
+h3 = make_vdom_constructor("h3")
+h4 = make_vdom_constructor("h4")
+h5 = make_vdom_constructor("h5")
+h6 = make_vdom_constructor("h6")
+header = make_vdom_constructor("header")
+hgroup = make_vdom_constructor("hgroup")
+nav = make_vdom_constructor("nav")
+section = make_vdom_constructor("section")
+
+# Text content
+blockquote = make_vdom_constructor("blockquote")
+dd = make_vdom_constructor("dd")
+div = make_vdom_constructor("div")
+dl = make_vdom_constructor("dl")
+dt = make_vdom_constructor("dt")
+figcaption = make_vdom_constructor("figcaption")
+figure = make_vdom_constructor("figure")
+hr = make_vdom_constructor("hr", allow_children=False)
+li = make_vdom_constructor("li")
+ol = make_vdom_constructor("ol")
+p = make_vdom_constructor("p")
+pre = make_vdom_constructor("pre")
+ul = make_vdom_constructor("ul")
+
+# Inline text semantics
+a = make_vdom_constructor("a")
+abbr = make_vdom_constructor("abbr")
+b = make_vdom_constructor("b")
+br = make_vdom_constructor("br", allow_children=False)
+cite = make_vdom_constructor("cite")
+code = make_vdom_constructor("code")
+data = make_vdom_constructor("data")
+em = make_vdom_constructor("em")
+i = make_vdom_constructor("i")
+kbd = make_vdom_constructor("kbd")
+mark = make_vdom_constructor("mark")
+q = make_vdom_constructor("q")
+s = make_vdom_constructor("s")
+samp = make_vdom_constructor("samp")
+small = make_vdom_constructor("small")
+span = make_vdom_constructor("span")
+strong = make_vdom_constructor("strong")
+sub = make_vdom_constructor("sub")
+sup = make_vdom_constructor("sup")
+time = make_vdom_constructor("time")
+u = make_vdom_constructor("u")
+var = make_vdom_constructor("var")
+
+# Image and video
+img = make_vdom_constructor("img", allow_children=False)
+audio = make_vdom_constructor("audio")
+video = make_vdom_constructor("video")
+source = make_vdom_constructor("source", allow_children=False)
+
+# Table content
+caption = make_vdom_constructor("caption")
+col = make_vdom_constructor("col")
+colgroup = make_vdom_constructor("colgroup")
+table = make_vdom_constructor("table")
+tbody = make_vdom_constructor("tbody")
+td = make_vdom_constructor("td")
+tfoot = make_vdom_constructor("tfoot")
+th = make_vdom_constructor("th")
+thead = make_vdom_constructor("thead")
+tr = make_vdom_constructor("tr")
+
+# Forms
+meter = make_vdom_constructor("meter")
+output = make_vdom_constructor("output")
+progress = make_vdom_constructor("progress")
+input = make_vdom_constructor("input", allow_children=False)
+button = make_vdom_constructor("button")
+label = make_vdom_constructor("label")
+fieldset = make_vdom_constructor("fieldset")
+legend = make_vdom_constructor("legend")
+
+# Interactive elements
+details = make_vdom_constructor("details")
+dialog = make_vdom_constructor("dialog")
+menu = make_vdom_constructor("menu")
+menuitem = make_vdom_constructor("menuitem")
+summary = make_vdom_constructor("summary")
diff --git a/src/idom/server/fastapi.py b/src/idom/server/fastapi.py
index 844567a91..fcd27172f 100644
--- a/src/idom/server/fastapi.py
+++ b/src/idom/server/fastapi.py
@@ -23,7 +23,7 @@
from uvicorn.supervisors.multiprocess import Multiprocess
from uvicorn.supervisors.statreload import StatReload as ChangeReload
-from idom.config import IDOM_CLIENT_BUILD_DIR
+from idom.config import IDOM_WED_MODULES_DIR
from idom.core.component import ComponentConstructor
from idom.core.dispatcher import (
RecvCoroutine,
@@ -34,7 +34,7 @@
)
from idom.core.layout import Layout, LayoutEvent, LayoutUpdate
-from .utils import poll, threaded
+from .utils import CLIENT_BUILD_DIR, poll, threaded
logger = logging.getLogger(__name__)
@@ -195,7 +195,16 @@ def _setup_common_routes(app: FastAPI, router: APIRouter, config: Config) -> Non
app.mount(
f"{url_prefix}/client",
StaticFiles(
- directory=str(IDOM_CLIENT_BUILD_DIR.current),
+ directory=str(CLIENT_BUILD_DIR),
+ html=True,
+ check_dir=True,
+ ),
+ name="idom_static_files",
+ )
+ app.mount(
+ f"{url_prefix}/modules",
+ StaticFiles(
+ directory=str(IDOM_WED_MODULES_DIR.current),
html=True,
check_dir=True,
),
diff --git a/src/idom/server/flask.py b/src/idom/server/flask.py
index b5e1696c6..3f58a0d20 100644
--- a/src/idom/server/flask.py
+++ b/src/idom/server/flask.py
@@ -23,12 +23,12 @@
from typing_extensions import TypedDict
import idom
-from idom.config import IDOM_CLIENT_BUILD_DIR, IDOM_DEBUG_MODE
+from idom.config import IDOM_DEBUG_MODE, IDOM_WED_MODULES_DIR
from idom.core.component import AbstractComponent, ComponentConstructor
from idom.core.dispatcher import dispatch_single_view
from idom.core.layout import LayoutEvent, LayoutUpdate
-from .utils import threaded, wait_on_event
+from .utils import CLIENT_BUILD_DIR, threaded, wait_on_event
logger = logging.getLogger(__name__)
@@ -136,8 +136,12 @@ def _setup_common_routes(blueprint: Blueprint, config: Config) -> None:
if config["serve_static_files"]:
@blueprint.route("/client/")
- def send_build_dir(path: str) -> Any:
- return send_from_directory(str(IDOM_CLIENT_BUILD_DIR.current), path)
+ def send_client_dir(path: str) -> Any:
+ return send_from_directory(str(CLIENT_BUILD_DIR), path)
+
+ @blueprint.route("/modules/")
+ def send_modules_dir(path: str) -> Any:
+ return send_from_directory(str(IDOM_WED_MODULES_DIR.current), path)
if config["redirect_root_to_index"]:
@@ -145,7 +149,7 @@ def send_build_dir(path: str) -> Any:
def redirect_to_index() -> Any:
return redirect(
url_for(
- "idom.send_build_dir",
+ "idom.send_client_dir",
path="index.html",
**request.args,
)
diff --git a/src/idom/server/prefab.py b/src/idom/server/prefab.py
index cc9adfca0..f11616611 100644
--- a/src/idom/server/prefab.py
+++ b/src/idom/server/prefab.py
@@ -7,7 +7,7 @@
from typing import Any, Dict, Optional, Tuple, TypeVar
from idom.core.component import ComponentConstructor
-from idom.widgets.utils import MountFunc, MultiViewMount, hotswap, multiview
+from idom.widgets import MountFunc, MultiViewMount, hotswap, multiview
from .proto import Server, ServerFactory
from .utils import find_available_port, find_builtin_server_type
diff --git a/src/idom/server/sanic.py b/src/idom/server/sanic.py
index 71d5d931e..3a379c33a 100644
--- a/src/idom/server/sanic.py
+++ b/src/idom/server/sanic.py
@@ -17,7 +17,7 @@
from sanic_cors import CORS
from websockets import WebSocketCommonProtocol
-from idom.config import IDOM_CLIENT_BUILD_DIR
+from idom.config import IDOM_WED_MODULES_DIR
from idom.core.component import ComponentConstructor
from idom.core.dispatcher import (
RecvCoroutine,
@@ -28,11 +28,13 @@
)
from idom.core.layout import Layout, LayoutEvent, LayoutUpdate
-from .utils import threaded, wait_on_event
+from .utils import CLIENT_BUILD_DIR, threaded, wait_on_event
logger = logging.getLogger(__name__)
+_SERVER_COUNT = 0
+
class Config(TypedDict, total=False):
"""Config for :class:`SanicRenderServer`"""
@@ -153,6 +155,10 @@ def _setup_config_and_app(
config: Optional[Config],
app: Optional[Sanic],
) -> Tuple[Config, Sanic]:
+ if app is None:
+ global _SERVER_COUNT
+ _SERVER_COUNT += 1
+ app = Sanic(f"{__name__}[{_SERVER_COUNT}]")
return (
{
"cors": False,
@@ -161,7 +167,7 @@ def _setup_config_and_app(
"redirect_root_to_index": True,
**(config or {}), # type: ignore
},
- app or Sanic(),
+ app,
)
@@ -172,7 +178,8 @@ def _setup_common_routes(blueprint: Blueprint, config: Config) -> None:
CORS(blueprint, **cors_params)
if config["serve_static_files"]:
- blueprint.static("/client", str(IDOM_CLIENT_BUILD_DIR.current))
+ blueprint.static("/client", str(CLIENT_BUILD_DIR))
+ blueprint.static("/modules", str(IDOM_WED_MODULES_DIR.current))
if config["redirect_root_to_index"]:
diff --git a/src/idom/server/tornado.py b/src/idom/server/tornado.py
index 46d29dd78..6eb419ad1 100644
--- a/src/idom/server/tornado.py
+++ b/src/idom/server/tornado.py
@@ -18,12 +18,12 @@
from tornado.websocket import WebSocketHandler
from typing_extensions import TypedDict
-from idom.config import IDOM_CLIENT_BUILD_DIR
+from idom.config import IDOM_WED_MODULES_DIR
from idom.core.component import ComponentConstructor
from idom.core.dispatcher import dispatch_single_view
from idom.core.layout import Layout, LayoutEvent, LayoutUpdate
-from .utils import threaded, wait_on_event
+from .utils import CLIENT_BUILD_DIR, threaded, wait_on_event
_RouteHandlerSpecs = List[Tuple[str, Type[RequestHandler], Any]]
@@ -126,7 +126,14 @@ def _setup_common_routes(config: Config) -> _RouteHandlerSpecs:
(
r"/client/(.*)",
StaticFileHandler,
- {"path": str(IDOM_CLIENT_BUILD_DIR.current)},
+ {"path": str(CLIENT_BUILD_DIR)},
+ )
+ )
+ handlers.append(
+ (
+ r"/modules/(.*)",
+ StaticFileHandler,
+ {"path": str(IDOM_WED_MODULES_DIR.current)},
)
)
if config["redirect_root_to_index"]:
diff --git a/src/idom/server/utils.py b/src/idom/server/utils.py
index 781e523f9..410bd7cc4 100644
--- a/src/idom/server/utils.py
+++ b/src/idom/server/utils.py
@@ -3,13 +3,18 @@
from contextlib import closing
from functools import wraps
from importlib import import_module
+from pathlib import Path
from socket import socket
from threading import Event, Thread
from typing import Any, Callable, List, Optional, TypeVar, cast
+import idom
+
from .proto import ServerFactory
+CLIENT_BUILD_DIR = Path(idom.__file__).parent / "client" / "build"
+
_SUPPORTED_PACKAGES = [
"sanic",
"fastapi",
@@ -17,7 +22,6 @@
"tornado",
]
-
_Func = TypeVar("_Func", bound=Callable[..., None])
diff --git a/src/idom/testing.py b/src/idom/testing.py
index 02a8b6edc..4d703867b 100644
--- a/src/idom/testing.py
+++ b/src/idom/testing.py
@@ -5,6 +5,7 @@
import logging
import re
+import shutil
from functools import wraps
from types import TracebackType
from typing import (
@@ -25,6 +26,7 @@
from selenium.webdriver import Chrome
from selenium.webdriver.remote.webdriver import WebDriver
+from idom.config import IDOM_WED_MODULES_DIR
from idom.core.events import EventHandler
from idom.core.hooks import LifeCycleHook, current_hook
from idom.core.utils import hex_id
@@ -43,8 +45,8 @@
def create_simple_selenium_web_driver(
driver_type: Type[WebDriver] = Chrome,
driver_options: Optional[Any] = None,
- implicit_wait_timeout: float = 3.0,
- page_load_timeout: float = 3.0,
+ implicit_wait_timeout: float = 5.0,
+ page_load_timeout: float = 5.0,
window_size: Tuple[int, int] = (1080, 800),
) -> WebDriver:
driver = driver_type(options=driver_options)
@@ -285,3 +287,8 @@ def use(self, function: Callable[..., Any]) -> EventHandler:
self._handler.clear()
self._handler.add(function)
return self._handler
+
+
+def clear_idom_web_modules_dir() -> None:
+ for path in IDOM_WED_MODULES_DIR.current.iterdir():
+ shutil.rmtree(path) if path.is_dir() else path.unlink()
diff --git a/src/idom/web/__init__.py b/src/idom/web/__init__.py
new file mode 100644
index 000000000..d3187366c
--- /dev/null
+++ b/src/idom/web/__init__.py
@@ -0,0 +1,9 @@
+from .module import export, module_from_file, module_from_template, module_from_url
+
+
+__all__ = [
+ "module_from_file",
+ "module_from_template",
+ "module_from_url",
+ "export",
+]
diff --git a/src/idom/web/module.py b/src/idom/web/module.py
new file mode 100644
index 000000000..d6ed49117
--- /dev/null
+++ b/src/idom/web/module.py
@@ -0,0 +1,253 @@
+"""
+Web Modules
+===========
+"""
+
+from __future__ import annotations
+
+import shutil
+from dataclasses import dataclass
+from functools import partial
+from pathlib import Path
+from typing import Any, List, NewType, Optional, Set, Tuple, Union, overload
+
+from idom.config import IDOM_DEBUG_MODE, IDOM_WED_MODULES_DIR
+from idom.core.vdom import ImportSourceDict, VdomDictConstructor, make_vdom_constructor
+
+from .utils import (
+ module_name_suffix,
+ resolve_module_exports_from_file,
+ resolve_module_exports_from_url,
+)
+
+
+SourceType = NewType("SourceType", str)
+
+NAME_SOURCE = SourceType("NAME")
+"""A named souce - usually a Javascript package name"""
+
+URL_SOURCE = SourceType("URL")
+"""A source loaded from a URL, usually a CDN"""
+
+
+def module_from_url(
+ url: str,
+ fallback: Optional[Any] = None,
+ resolve_exports: bool = IDOM_DEBUG_MODE.current,
+ resolve_exports_depth: int = 5,
+) -> WebModule:
+ """Load a :class:`WebModule` from a :data:`URL_SOURCE`
+
+ Parameters:
+ url:
+ Where the javascript module will be loaded from which conforms to the
+ interface for :ref:`Custom Javascript Components`
+ fallback:
+ What to temporarilly display while the module is being loaded.
+ resolve_imports:
+ Whether to try and find all the named exports of this module.
+ resolve_exports_depth:
+ How deeply to search for those exports.
+ """
+ return WebModule(
+ source=url,
+ source_type=URL_SOURCE,
+ default_fallback=fallback,
+ file=None,
+ export_names=(
+ resolve_module_exports_from_url(url, resolve_exports_depth)
+ if resolve_exports
+ else None
+ ),
+ )
+
+
+def module_from_template(
+ template: str,
+ package: str,
+ cdn: str = "https://esm.sh",
+ fallback: Optional[Any] = None,
+ resolve_exports: bool = IDOM_DEBUG_MODE.current,
+ resolve_exports_depth: int = 5,
+) -> WebModule:
+ """Load a :class:`WebModule` from a :data:`URL_SOURCE` using a known framework
+
+ Parameters:
+ template:
+ The name of the template to use with the given ``package`` (``react`` | ``preact``)
+ package:
+ The name of a package to load. May include a file extension (defaults to
+ ``.js`` if not given)
+ cdn:
+ Where the package should be loaded from. The CDN must distribute ESM modules
+ fallback:
+ What to temporarilly display while the module is being loaded.
+ resolve_imports:
+ Whether to try and find all the named exports of this module.
+ resolve_exports_depth:
+ How deeply to search for those exports.
+ """
+ cdn = cdn.rstrip("/")
+
+ template_file_name = f"{template}{module_name_suffix(package)}"
+ template_file = Path(__file__).parent / "templates" / template_file_name
+ if not template_file.exists():
+ raise ValueError(f"No template for {template_file_name!r} exists")
+
+ target_file = _web_module_path(package)
+ if not target_file.exists():
+ target_file.parent.mkdir(parents=True, exist_ok=True)
+ target_file.write_text(
+ template_file.read_text().replace("$PACKAGE", package).replace("$CDN", cdn)
+ )
+
+ return WebModule(
+ source=package + module_name_suffix(package),
+ source_type=NAME_SOURCE,
+ default_fallback=fallback,
+ file=target_file,
+ export_names=(
+ resolve_module_exports_from_url(f"{cdn}/{package}", resolve_exports_depth)
+ if resolve_exports
+ else None
+ ),
+ )
+
+
+def module_from_file(
+ name: str,
+ file: Union[str, Path],
+ fallback: Optional[Any] = None,
+ resolve_exports: bool = IDOM_DEBUG_MODE.current,
+ resolve_exports_depth: int = 5,
+ symlink: bool = False,
+) -> WebModule:
+ """Load a :class:`WebModule` from a :data:`URL_SOURCE` using a known framework
+
+ Parameters:
+ template:
+ The name of the template to use with the given ``package``
+ package:
+ The name of a package to load. May include a file extension (defaults to
+ ``.js`` if not given)
+ cdn:
+ Where the package should be loaded from. The CDN must distribute ESM modules
+ fallback:
+ What to temporarilly display while the module is being loaded.
+ resolve_imports:
+ Whether to try and find all the named exports of this module.
+ resolve_exports_depth:
+ How deeply to search for those exports.
+ """
+ source_file = Path(file)
+ target_file = _web_module_path(name)
+ if not source_file.exists():
+ raise FileNotFoundError(f"Source file does not exist: {source_file}")
+ elif target_file.exists() or target_file.is_symlink():
+ raise FileExistsError(f"{name!r} already exists as {target_file.resolve()}")
+ else:
+ target_file.parent.mkdir(parents=True, exist_ok=True)
+ if symlink:
+ target_file.symlink_to(source_file)
+ else:
+ shutil.copy(source_file, target_file)
+ return WebModule(
+ source=name + module_name_suffix(name),
+ source_type=NAME_SOURCE,
+ default_fallback=fallback,
+ file=target_file,
+ export_names=(
+ resolve_module_exports_from_file(source_file, resolve_exports_depth)
+ if resolve_exports
+ else None
+ ),
+ )
+
+
+@dataclass(frozen=True)
+class WebModule:
+ source: str
+ source_type: SourceType
+ default_fallback: Optional[Any]
+ export_names: Optional[Set[str]]
+ file: Optional[Path]
+
+
+@overload
+def export(
+ web_module: WebModule,
+ export_names: str,
+ fallback: Optional[Any],
+ allow_children: bool,
+) -> VdomDictConstructor:
+ ...
+
+
+@overload
+def export(
+ web_module: WebModule,
+ export_names: Union[List[str], Tuple[str]],
+ fallback: Optional[Any],
+ allow_children: bool,
+) -> List[VdomDictConstructor]:
+ ...
+
+
+def export(
+ web_module: WebModule,
+ export_names: Union[str, List[str], Tuple[str]],
+ fallback: Optional[Any] = None,
+ allow_children: bool = True,
+) -> Union[VdomDictConstructor, List[VdomDictConstructor]]:
+ """Return one or more VDOM constructors from a :class:`WebModule`
+
+ Parameters:
+ export_names:
+ One or more names to export. If given as a string, a single component
+ will be returned. If a list is given, then a list of components will be
+ returned.
+ fallback:
+ What to temporarilly display while the module is being loaded.
+ allow_children:
+ Whether or not these components can have children.
+ """
+ if isinstance(export_names, str):
+ if (
+ web_module.export_names is not None
+ and export_names not in web_module.export_names
+ ):
+ raise ValueError(f"{web_module.source!r} does not export {export_names!r}")
+ return _make_export(web_module, export_names, fallback, allow_children)
+ else:
+ if web_module.export_names is not None:
+ missing = list(
+ sorted(set(export_names).difference(web_module.export_names))
+ )
+ if missing:
+ raise ValueError(f"{web_module.source!r} does not export {missing!r}")
+ return [
+ _make_export(web_module, name, fallback, allow_children)
+ for name in export_names
+ ]
+
+
+def _make_export(
+ web_module: WebModule, name: str, fallback: Optional[Any], allow_children: bool
+) -> VdomDictConstructor:
+ return partial(
+ make_vdom_constructor(
+ name,
+ allow_children=allow_children,
+ ),
+ import_source=ImportSourceDict(
+ source=web_module.source,
+ sourceType=web_module.source_type,
+ fallback=(fallback or web_module.default_fallback),
+ ),
+ )
+
+
+def _web_module_path(name: str) -> Path:
+ name += module_name_suffix(name)
+ path = IDOM_WED_MODULES_DIR.current.joinpath(*name.split("/"))
+ return path.with_suffix(path.suffix)
diff --git a/src/idom/web/templates/preact.js b/src/idom/web/templates/preact.js
new file mode 100644
index 000000000..773463137
--- /dev/null
+++ b/src/idom/web/templates/preact.js
@@ -0,0 +1,9 @@
+import { render } from "$CDN/preact";
+
+export { h as createElement, render as renderElement } from "$CDN/preact";
+
+export function unmountElement(container) {
+ render(null, container);
+}
+
+export * from "$CDN/$PACKAGE";
diff --git a/src/idom/web/templates/react.js b/src/idom/web/templates/react.js
new file mode 100644
index 000000000..71c3eff1a
--- /dev/null
+++ b/src/idom/web/templates/react.js
@@ -0,0 +1,9 @@
+export * from "$CDN/$PACKAGE";
+
+import * as react from "$CDN/react";
+import * as reactDOM from "$CDN/react-dom";
+
+export const createElement = (component, props) =>
+ react.createElement(component, props);
+export const renderElement = reactDOM.render;
+export const unmountElement = reactDOM.unmountComponentAtNode;
diff --git a/src/idom/web/utils.py b/src/idom/web/utils.py
new file mode 100644
index 000000000..7e7c62895
--- /dev/null
+++ b/src/idom/web/utils.py
@@ -0,0 +1,128 @@
+import logging
+import re
+from pathlib import Path, PurePosixPath
+from typing import Set, Tuple
+from urllib.parse import urlparse
+
+import requests
+
+
+logger = logging.getLogger(__name__)
+
+
+def module_name_suffix(name: str) -> str:
+ head, _, tail = name.partition("@") # handle version identifier
+ version, _, tail = tail.partition("/") # get section after version
+ return PurePosixPath(tail or head).suffix or ".js"
+
+
+def resolve_module_exports_from_file(file: Path, max_depth: int) -> Set[str]:
+ if max_depth == 0:
+ logger.warning(f"Did not resolve all exports for {file} - max depth reached")
+ return set()
+ elif not file.exists():
+ logger.warning(f"Did not resolve exports for unknown file {file}")
+ return set()
+
+ export_names, references = resolve_module_exports_from_source(file.read_text())
+
+ for ref in references:
+ if urlparse(ref).scheme: # is an absolute URL
+ export_names.update(resolve_module_exports_from_url(ref, max_depth - 1))
+ else:
+ path = file.parent.joinpath(*ref.split("/"))
+ export_names.update(resolve_module_exports_from_file(path, max_depth - 1))
+
+ return export_names
+
+
+def resolve_module_exports_from_url(url: str, max_depth: int) -> Set[str]:
+ if max_depth == 0:
+ logger.warning(f"Did not resolve all exports for {url} - max depth reached")
+ return set()
+
+ try:
+ text = requests.get(url).text
+ except requests.exceptions.ConnectionError as error:
+ reason = "" if error is None else " - {error.errno}"
+ logger.warning("Did not resolve exports for url " + url + reason)
+ return set()
+
+ export_names, references = resolve_module_exports_from_source(text)
+
+ for ref in references:
+ url = _resolve_relative_url(url, ref)
+ export_names.update(resolve_module_exports_from_url(url, max_depth - 1))
+
+ return export_names
+
+
+def resolve_module_exports_from_source(content: str) -> Tuple[Set[str], Set[str]]:
+ names: Set[str] = set()
+ references: Set[str] = set()
+
+ if _JS_DEFAULT_EXPORT_PATTERN.search(content):
+ names.add("default")
+
+ # Exporting functions and classes
+ names.update(_JS_FUNC_OR_CLS_EXPORT_PATTERN.findall(content))
+
+ for export in _JS_GENERAL_EXPORT_PATTERN.findall(content):
+ export = export.rstrip(";").strip()
+ # Exporting individual features
+ if export.startswith("let "):
+ names.update(let.split("=", 1)[0] for let in export[4:].split(","))
+ # Renaming exports and export list
+ elif export.startswith("{") and export.endswith("}"):
+ names.update(
+ item.split(" as ", 1)[-1] for item in export.strip("{}").split(",")
+ )
+ # Exporting destructured assignments with renaming
+ elif export.startswith("const "):
+ names.update(
+ item.split(":", 1)[0]
+ for item in export[6:].split("=", 1)[0].strip("{}").split(",")
+ )
+ # Default exports
+ elif export.startswith("default "):
+ names.add("default")
+ # Aggregating modules
+ elif export.startswith("* as "):
+ names.add(export[5:].split(" from ", 1)[0])
+ elif export.startswith("* "):
+ references.add(export[2:].split("from ", 1)[-1].strip("'\""))
+ elif export.startswith("{") and " from " in export:
+ names.update(
+ item.split(" as ", 1)[-1]
+ for item in export.split(" from ")[0].strip("{}").split(",")
+ )
+ elif not (export.startswith("function ") or export.startswith("class ")):
+ logger.warning(f"Unknown export type {export!r}")
+ return {n.strip() for n in names}, {r.strip() for r in references}
+
+
+def _resolve_relative_url(base_url: str, rel_url: str) -> str:
+ if not rel_url.startswith("."):
+ return rel_url
+
+ base_url = base_url.rsplit("/", 1)[0]
+
+ if rel_url.startswith("./"):
+ return base_url + rel_url[1:]
+
+ while rel_url.startswith("../"):
+ base_url = base_url.rsplit("/", 1)[0]
+ rel_url = rel_url[3:]
+
+ return f"{base_url}/{rel_url}"
+
+
+_JS_DEFAULT_EXPORT_PATTERN = re.compile(
+ r";?\s*export\s+default\s",
+)
+_JS_FUNC_OR_CLS_EXPORT_PATTERN = re.compile(
+ r";?\s*export\s+(?:function|class)\s+([a-zA-Z_$][0-9a-zA-Z_$]*)"
+)
+_JS_GENERAL_EXPORT_PATTERN = re.compile(
+ r";?\s*export(?=\s+|{)(.*?)(?:;|$)", re.MULTILINE
+)
diff --git a/src/idom/widgets/utils.py b/src/idom/widgets.py
similarity index 78%
rename from src/idom/widgets/utils.py
rename to src/idom/widgets.py
index d61d73fcc..fe3922477 100644
--- a/src/idom/widgets/utils.py
+++ b/src/idom/widgets.py
@@ -1,14 +1,68 @@
"""
-Widget Tools
-============
+Widgets
+=======
"""
from __future__ import annotations
-from typing import Any, Callable, Dict, Optional, Set, Tuple, TypeVar
+from base64 import b64encode
+from typing import Any, Callable, Dict, Optional, Set, Tuple, TypeVar, Union
-from idom.core import hooks
-from idom.core.component import ComponentConstructor, component
-from idom.utils import Ref
+import idom
+
+from . import html
+from .core import hooks
+from .core.component import ComponentConstructor, component
+from .core.vdom import VdomDict
+from .utils import Ref
+
+
+def image(
+ format: str,
+ value: Union[str, bytes] = "",
+ attributes: Optional[Dict[str, Any]] = None,
+) -> VdomDict:
+ """Utility for constructing an image from a string or bytes
+
+ The source value will automatically be encoded to base64
+ """
+ if format == "svg":
+ format = "svg+xml"
+
+ if isinstance(value, str):
+ bytes_value = value.encode()
+ else:
+ bytes_value = value
+
+ base64_value = b64encode(bytes_value).decode()
+ src = f"data:image/{format};base64,{base64_value}"
+
+ return {"tagName": "img", "attributes": {"src": src, **(attributes or {})}}
+
+
+@component
+def Input(
+ callback: Callable[[str], None],
+ type: str,
+ value: str = "",
+ attributes: Optional[Dict[str, Any]] = None,
+ cast: Optional[Callable[[str], Any]] = None,
+ ignore_empty: bool = True,
+) -> VdomDict:
+ """Utility for making an ```` with a callback"""
+ attrs = attributes or {}
+ value, set_value = idom.hooks.use_state(value)
+
+ events = idom.Events()
+
+ @events.on("change")
+ def on_change(event: Dict[str, Any]) -> None:
+ value = event["value"]
+ set_value(value)
+ if not value and ignore_empty:
+ return
+ callback(value if cast is None else cast(value))
+
+ return html.input({"type": type, "value": value, **attrs}, event_handlers=events)
MountFunc = Callable[[ComponentConstructor], None]
diff --git a/src/idom/widgets/__init__.py b/src/idom/widgets/__init__.py
deleted file mode 100644
index dbb88d0d9..000000000
--- a/src/idom/widgets/__init__.py
+++ /dev/null
@@ -1,12 +0,0 @@
-from .html import Input, html, image
-from .utils import hotswap, multiview
-
-
-__all__ = [
- "node",
- "hotswap",
- "multiview",
- "html",
- "image",
- "Input",
-]
diff --git a/src/idom/widgets/html.py b/src/idom/widgets/html.py
deleted file mode 100644
index 3f72c62ef..000000000
--- a/src/idom/widgets/html.py
+++ /dev/null
@@ -1,209 +0,0 @@
-"""
-HTML Widgets
-============
-"""
-
-from base64 import b64encode
-from typing import Any, Callable, Dict, Optional, Union, overload
-
-import idom
-from idom.core.component import AbstractComponent, ComponentConstructor, component
-from idom.core.vdom import (
- VdomDict,
- VdomDictConstructor,
- coalesce_attributes_and_children,
- make_vdom_constructor,
- vdom,
-)
-
-
-def image(
- format: str,
- value: Union[str, bytes] = "",
- attributes: Optional[Dict[str, Any]] = None,
-) -> VdomDict:
- """Utility for constructing an image from a string or bytes
-
- The source value will automatically be encoded to base64
- """
- if format == "svg":
- format = "svg+xml"
-
- if isinstance(value, str):
- bytes_value = value.encode()
- else:
- bytes_value = value
-
- base64_value = b64encode(bytes_value).decode()
- src = f"data:image/{format};base64,{base64_value}"
-
- return {"tagName": "img", "attributes": {"src": src, **(attributes or {})}}
-
-
-@component
-def Input(
- callback: Callable[[str], None],
- type: str,
- value: str = "",
- attributes: Optional[Dict[str, Any]] = None,
- cast: Optional[Callable[[str], Any]] = None,
- ignore_empty: bool = True,
-) -> VdomDict:
- """Utility for making an ```` with a callback"""
- attrs = attributes or {}
- value, set_value = idom.hooks.use_state(value)
-
- events = idom.Events()
-
- @events.on("change")
- def on_change(event: Dict[str, Any]) -> None:
- value = event["value"]
- set_value(value)
- if not value and ignore_empty:
- return
- callback(value if cast is None else cast(value))
-
- return html.input({"type": type, "value": value, **attrs}, event_handlers=events)
-
-
-class Html:
- """Utility for making basic HTML elements
-
- Many basic elements already have constructors, however accessing an attribute
- of any name on this object will return a constructor for an element with the
- same ``tagName``.
-
- All constructors return :class:`~idom.core.vdom.VdomDict`.
- """
-
- def __init__(self) -> None:
- # External sources
- self.link = make_vdom_constructor("link", allow_children=False)
-
- # Content sectioning
- self.style = make_vdom_constructor("style")
- self.address = make_vdom_constructor("address")
- self.article = make_vdom_constructor("article")
- self.aside = make_vdom_constructor("aside")
- self.footer = make_vdom_constructor("footer")
- self.h1 = make_vdom_constructor("h1")
- self.h2 = make_vdom_constructor("h2")
- self.h3 = make_vdom_constructor("h3")
- self.h4 = make_vdom_constructor("h4")
- self.h5 = make_vdom_constructor("h5")
- self.h6 = make_vdom_constructor("h6")
- self.header = make_vdom_constructor("header")
- self.hgroup = make_vdom_constructor("hgroup")
- self.nav = make_vdom_constructor("nav")
- self.section = make_vdom_constructor("section")
-
- # Text content
- self.blockquote = make_vdom_constructor("blockquote")
- self.dd = make_vdom_constructor("dd")
- self.div = make_vdom_constructor("div")
- self.dl = make_vdom_constructor("dl")
- self.dt = make_vdom_constructor("dt")
- self.figcaption = make_vdom_constructor("figcaption")
- self.figure = make_vdom_constructor("figure")
- self.hr = make_vdom_constructor("hr", allow_children=False)
- self.li = make_vdom_constructor("li")
- self.ol = make_vdom_constructor("ol")
- self.p = make_vdom_constructor("p")
- self.pre = make_vdom_constructor("pre")
- self.ul = make_vdom_constructor("ul")
-
- # Inline text semantics
- self.a = make_vdom_constructor("a")
- self.abbr = make_vdom_constructor("abbr")
- self.b = make_vdom_constructor("b")
- self.br = make_vdom_constructor("br", allow_children=False)
- self.cite = make_vdom_constructor("cite")
- self.code = make_vdom_constructor("code")
- self.data = make_vdom_constructor("data")
- self.em = make_vdom_constructor("em")
- self.i = make_vdom_constructor("i")
- self.kbd = make_vdom_constructor("kbd")
- self.mark = make_vdom_constructor("mark")
- self.q = make_vdom_constructor("q")
- self.s = make_vdom_constructor("s")
- self.samp = make_vdom_constructor("samp")
- self.small = make_vdom_constructor("small")
- self.span = make_vdom_constructor("span")
- self.strong = make_vdom_constructor("strong")
- self.sub = make_vdom_constructor("sub")
- self.sup = make_vdom_constructor("sup")
- self.time = make_vdom_constructor("time")
- self.u = make_vdom_constructor("u")
- self.var = make_vdom_constructor("var")
-
- # Image and video
- self.img = make_vdom_constructor("img", allow_children=False)
- self.audio = make_vdom_constructor("audio")
- self.video = make_vdom_constructor("video")
- self.source = make_vdom_constructor("source", allow_children=False)
-
- # Table content
- self.caption = make_vdom_constructor("caption")
- self.col = make_vdom_constructor("col")
- self.colgroup = make_vdom_constructor("colgroup")
- self.table = make_vdom_constructor("table")
- self.tbody = make_vdom_constructor("tbody")
- self.td = make_vdom_constructor("td")
- self.tfoot = make_vdom_constructor("tfoot")
- self.th = make_vdom_constructor("th")
- self.thead = make_vdom_constructor("thead")
- self.tr = make_vdom_constructor("tr")
-
- # Forms
- self.meter = make_vdom_constructor("meter")
- self.output = make_vdom_constructor("output")
- self.progress = make_vdom_constructor("progress")
- self.input = make_vdom_constructor("input", allow_children=False)
- self.button = make_vdom_constructor("button")
- self.label = make_vdom_constructor("label")
- self.fieldset = make_vdom_constructor("fieldset")
- self.legend = make_vdom_constructor("legend")
-
- # Interactive elements
- self.details = make_vdom_constructor("details")
- self.dialog = make_vdom_constructor("dialog")
- self.menu = make_vdom_constructor("menu")
- self.menuitem = make_vdom_constructor("menuitem")
- self.summary = make_vdom_constructor("summary")
-
- @overload
- @staticmethod
- def __call__(
- tag: ComponentConstructor, *attributes_and_children: Any
- ) -> AbstractComponent:
- ...
-
- @overload
- @staticmethod
- def __call__(tag: str, *attributes_and_children: Any) -> VdomDict:
- ...
-
- @staticmethod
- def __call__(
- tag: Union[str, ComponentConstructor],
- *attributes_and_children: Any,
- ) -> Union[VdomDict, AbstractComponent]:
- if isinstance(tag, str):
- return vdom(tag, *attributes_and_children)
-
- attributes, children = coalesce_attributes_and_children(attributes_and_children)
-
- if children:
- return tag(children=children, **attributes)
- else:
- return tag(**attributes)
-
- def __getattr__(self, tag: str) -> VdomDictConstructor:
- return make_vdom_constructor(tag)
-
-
-html = Html()
-"""Holds pre-made constructors for basic HTML elements
-
-See :class:`Html` for more info.
-"""
diff --git a/tests/conftest.py b/tests/conftest.py
index 9bf8a6e42..228f2f4e7 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -2,9 +2,8 @@
import inspect
import os
-from typing import Any, Iterator, List
+from typing import Any, List
-import pyalect.builtins.pytest # noqa
import pytest
from _pytest.config import Config
from _pytest.config.argparsing import Parser
@@ -12,8 +11,11 @@
from selenium.webdriver.support.ui import WebDriverWait
import idom
-from idom.client import manage as manage_client
-from idom.testing import ServerMountPoint, create_simple_selenium_web_driver
+from idom.testing import (
+ ServerMountPoint,
+ clear_idom_web_modules_dir,
+ create_simple_selenium_web_driver,
+)
def pytest_collection_modifyitems(
@@ -104,20 +106,9 @@ def driver_is_headless(pytestconfig: Config):
return bool(pytestconfig.option.headless)
-@pytest.fixture(scope="session", autouse=True)
-def _restore_client(pytestconfig: Config) -> Iterator[None]:
- """Restore the client's state before and after testing
-
- For faster test runs set ``--no-restore-client`` at the CLI. Test coverage and
- breakages may occur if this is set. Further the client is not cleaned up
- after testing and may effect usage of IDOM beyond the scope of the tests.
- """
- if pytestconfig.option.restore_client:
- manage_client.restore()
- yield
- manage_client.restore()
- else:
- yield
+@pytest.fixture(autouse=True)
+def _clear_web_modules_dir_after_test():
+ clear_idom_web_modules_dir()
def _mark_coros_as_async_tests(items: List[pytest.Item]) -> None:
diff --git a/tests/test_cli.py b/tests/test_cli.py
deleted file mode 100644
index aa59fd922..000000000
--- a/tests/test_cli.py
+++ /dev/null
@@ -1,37 +0,0 @@
-from typer.testing import CliRunner
-
-import idom
-from idom.cli import main
-from idom.client.manage import web_module_exists
-from idom.config import all_options
-
-
-cli_runner = CliRunner()
-
-
-def test_root():
- assert idom.__version__ in cli_runner.invoke(main, ["--version"]).stdout
-
-
-def test_install():
- cli_runner.invoke(main, ["restore"])
- assert cli_runner.invoke(main, ["install", "jquery"]).exit_code == 0
- assert web_module_exists("jquery")
-
- result = cli_runner.invoke(main, ["install", "jquery"])
- print(result.stdout)
- assert result.exit_code == 0
- assert "Already installed ['jquery']" in result.stdout
- assert "Build skipped" in result.stdout
- assert web_module_exists("jquery")
-
-
-def test_restore():
- assert cli_runner.invoke(main, ["restore"]).exit_code == 0
-
-
-def test_options():
- assert cli_runner.invoke(main, ["options"]).stdout.strip().split("\n") == [
- f"{opt.name} = {opt.current}"
- for opt in sorted(all_options(), key=lambda o: o.name)
- ]
diff --git a/tests/test_client/test_app.py b/tests/test_client.py
similarity index 59%
rename from tests/test_client/test_app.py
rename to tests/test_client.py
index 793c03c20..9fbf50b74 100644
--- a/tests/test_client/test_app.py
+++ b/tests/test_client.py
@@ -43,35 +43,3 @@ def NewComponent():
# check that we can resume normal operation
set_state.current(1)
driver.find_element_by_id("new-component-1")
-
-
-def test_that_js_module_unmount_is_called(driver, driver_wait, display):
- module = idom.Module(
- "set-flag-when-unmount-is-called",
- source_file=JS_DIR / "set-flag-when-unmount-is-called.js",
- )
-
- set_current_component = idom.Ref(None)
-
- @idom.component
- def ShowCurrentComponent():
- current_component, set_current_component.current = idom.hooks.use_state(
- lambda: module.SomeComponent(
- {"id": "some-component", "text": "initial component"}
- )
- )
- return current_component
-
- display(ShowCurrentComponent)
-
- driver.find_element_by_id("some-component")
-
- set_current_component.current(
- idom.html.h1({"id": "some-other-component"}, "some other component")
- )
-
- # the new component has been displayed
- driver.find_element_by_id("some-other-component")
-
- # the unmount callback for the old component was called
- driver.find_element_by_id("unmount-flag")
diff --git a/tests/test_client/__init__.py b/tests/test_client/__init__.py
deleted file mode 100644
index e69de29bb..000000000
diff --git a/tests/test_client/js/simple-button.js b/tests/test_client/js/simple-button.js
deleted file mode 100644
index 91d6ad121..000000000
--- a/tests/test_client/js/simple-button.js
+++ /dev/null
@@ -1,14 +0,0 @@
-import react from "./react.js";
-
-export function SimpleButton(props) {
- return react.createElement(
- "button",
- {
- id: props.id,
- onClick(event) {
- props.onClick({ data: props.eventResponseData });
- },
- },
- "simple button"
- );
-}
diff --git a/tests/test_client/test__private.py b/tests/test_client/test__private.py
deleted file mode 100644
index 9044d802e..000000000
--- a/tests/test_client/test__private.py
+++ /dev/null
@@ -1,43 +0,0 @@
-import pytest
-
-from idom.client._private import (
- find_js_module_exports_in_source,
- split_package_name_and_version,
-)
-from tests.general_utils import assert_same_items
-
-
-@pytest.mark.parametrize(
- "module_source, expected_names",
- [
- ("asdfasdfasdf;export{one as One, two as Two};asdfasdf;", ["One", "Two"]),
- ("asd;export{one as One};asdfasdf;export{two as Two};", ["One", "Two"]),
- ("asdasd;export default something;", ["default"]),
- ("asdasd;export One something;asdfa;export Two somethingElse;", ["One", "Two"]),
- (
- "asdasd;export One something;asdfa;export{two as Two};asdfasdf;",
- ["One", "Two"],
- ),
- ],
-)
-def test_find_js_module_exports_in_source(module_source, expected_names):
- assert_same_items(find_js_module_exports_in_source(module_source), expected_names)
-
-
-@pytest.mark.parametrize(
- "package_specifier,expected_name_and_version",
- [
- ("package", ("package", "")),
- ("package@1.2.3", ("package", "1.2.3")),
- ("@scope/pkg", ("@scope/pkg", "")),
- ("@scope/pkg@1.2.3", ("@scope/pkg", "1.2.3")),
- ("alias@npm:package", ("alias", "npm:package")),
- ("alias@npm:package@1.2.3", ("alias", "npm:package@1.2.3")),
- ("alias@npm:@scope/pkg@1.2.3", ("alias", "npm:@scope/pkg@1.2.3")),
- ("@alias/pkg@npm:@scope/pkg@1.2.3", ("@alias/pkg", "npm:@scope/pkg@1.2.3")),
- ],
-)
-def test_split_package_name_and_version(package_specifier, expected_name_and_version):
- assert (
- split_package_name_and_version(package_specifier) == expected_name_and_version
- )
diff --git a/tests/test_client/test_manage.py b/tests/test_client/test_manage.py
deleted file mode 100644
index a494d7b5c..000000000
--- a/tests/test_client/test_manage.py
+++ /dev/null
@@ -1,151 +0,0 @@
-import pytest
-
-import idom
-from idom.client.manage import (
- add_web_module,
- build,
- remove_web_module,
- restore,
- web_module_exists,
- web_module_exports,
- web_module_path,
-)
-from tests.general_utils import assert_same_items
-
-
-@pytest.fixture(scope="module")
-def victory():
- return idom.install("victory@35.4.0")
-
-
-def test_clean_build():
- restore()
- build(["jquery"])
- assert web_module_exists("jquery")
- build([], clean_build=True)
- assert not web_module_exists("jquery")
-
-
-def test_add_web_module_source_must_exist(tmp_path):
- with pytest.raises(FileNotFoundError, match="Package source file does not exist"):
- add_web_module("test", tmp_path / "file-does-not-exist.js")
-
-
-def test_cannot_add_web_module_if_already_exists(tmp_path):
- first_temp_file = tmp_path / "temp-1.js"
- second_temp_file = tmp_path / "temp-2.js"
-
- first_temp_file.write_text("console.log('hello!')") # this won't get run
- second_temp_file.write_text("console.log('hello!')") # this won't get run
-
- add_web_module("test", first_temp_file)
- with pytest.raises(FileExistsError):
- add_web_module("test", second_temp_file)
-
- remove_web_module("test")
-
-
-def test_can_add_web_module_if_already_exists_and_source_is_same(tmp_path):
- temp_file = tmp_path / "temp.js"
- temp_file.write_text("console.log('hello!')")
- add_web_module("test", temp_file)
- add_web_module("test", temp_file)
- remove_web_module("test")
-
-
-def test_web_module_path_must_exist():
- with pytest.raises(ValueError, match="does not exist at path"):
- web_module_path("this-does-not-exist", must_exist=True)
- assert not web_module_path("this-does-not-exist", must_exist=False).exists()
-
-
-def test_web_module_exports(victory):
- assert_same_items(
- web_module_exports("victory"),
- [
- "Area",
- "Axis",
- "Background",
- "Bar",
- "Border",
- "Box",
- "BrushHelpers",
- "Candle",
- "Circle",
- "ClipPath",
- "Collection",
- "CursorHelpers",
- "Curve",
- "Data",
- "DefaultTransitions",
- "Domain",
- "ErrorBar",
- "Events",
- "Flyout",
- "Helpers",
- "LabelHelpers",
- "Line",
- "LineSegment",
- "Log",
- "Path",
- "Point",
- "Portal",
- "PropTypes",
- "RawZoomHelpers",
- "Rect",
- "Scale",
- "Selection",
- "SelectionHelpers",
- "Slice",
- "Style",
- "TSpan",
- "Text",
- "TextSize",
- "Transitions",
- "VictoryAnimation",
- "VictoryArea",
- "VictoryAxis",
- "VictoryBar",
- "VictoryBoxPlot",
- "VictoryBrushContainer",
- "VictoryBrushLine",
- "VictoryCandlestick",
- "VictoryChart",
- "VictoryClipContainer",
- "VictoryContainer",
- "VictoryCursorContainer",
- "VictoryErrorBar",
- "VictoryGroup",
- "VictoryHistogram",
- "VictoryLabel",
- "VictoryLegend",
- "VictoryLine",
- "VictoryPie",
- "VictoryPolarAxis",
- "VictoryPortal",
- "VictoryScatter",
- "VictorySelectionContainer",
- "VictorySharedEvents",
- "VictoryStack",
- "VictoryTheme",
- "VictoryTooltip",
- "VictoryTransition",
- "VictoryVoronoi",
- "VictoryVoronoiContainer",
- "VictoryZoomContainer",
- "Voronoi",
- "VoronoiHelpers",
- "Whisker",
- "Wrapper",
- "ZoomHelpers",
- "addEvents",
- "brushContainerMixin",
- "combineContainerMixins",
- "createContainer",
- "cursorContainerMixin",
- "makeCreateContainerFunction",
- "selectionContainerMixin",
- "voronoiContainerMixin",
- "zoomContainerMixin",
- ],
- )
diff --git a/tests/test_client/test_module.py b/tests/test_client/test_module.py
deleted file mode 100644
index 1b26cde4d..000000000
--- a/tests/test_client/test_module.py
+++ /dev/null
@@ -1,116 +0,0 @@
-from pathlib import Path
-
-import pytest
-
-import idom
-from idom import Module
-from idom.client.module import URL_SOURCE
-
-
-HERE = Path(__file__).parent
-JS_FIXTURES = HERE / "js"
-
-
-@pytest.fixture
-def victory():
- return idom.install("victory@35.4.0")
-
-
-@pytest.fixture(scope="module")
-def simple_button():
- return Module("simple-button", source_file=JS_FIXTURES / "simple-button.js")
-
-
-def test_any_relative_or_abolute_url_allowed():
- Module("/absolute/url/module")
- Module("./relative/url/module")
- Module("../relative/url/module")
- Module("http://someurl.com/module")
-
-
-def test_module_import_repr():
- assert (
- repr(Module("/absolute/url/module").declare("SomeComponent"))
- == "Import(name='SomeComponent', source='/absolute/url/module', sourceType='URL', fallback=None)"
- )
-
-
-def test_install_multiple():
- # install several random JS packages
- pad_left, decamelize, is_sorted = idom.install(
- ["pad-left", "decamelize", "is-sorted"]
- )
- # ensure the output order is the same as the input order
- assert pad_left.source.endswith("pad-left")
- assert decamelize.source.endswith("decamelize")
- assert is_sorted.source.endswith("is-sorted")
-
-
-def test_module_does_not_exist():
- with pytest.raises(ValueError, match="does not exist"):
- Module("this-module-does-not-exist")
-
-
-def test_installed_module(driver, display, victory):
- display(victory.VictoryBar)
- driver.find_element_by_class_name("VictoryContainer")
-
-
-def test_reference_pre_installed_module(victory):
- assert victory == idom.Module("victory")
-
-
-def test_module_from_url():
- url = "https://code.jquery.com/jquery-3.5.0.js"
- jquery = idom.Module(url)
- assert jquery.source == url
- assert jquery.source_type == URL_SOURCE
- assert jquery.exports is None
-
-
-def test_module_from_source(driver, driver_wait, display, simple_button):
- response_data = idom.Ref(None)
-
- @idom.component
- def ShowButton():
- return simple_button.SimpleButton(
- {
- "id": "test-button",
- "onClick": lambda event: response_data.set_current(event["data"]),
- "eventResponseData": 10,
- }
- )
-
- display(ShowButton)
-
- client_button = driver.find_element_by_id("test-button")
- client_button.click()
- driver_wait.until(lambda dvr: response_data.current == 10)
-
-
-def test_module_checks_export_names(simple_button):
- with pytest.raises(ValueError, match="does not export 'ComponentDoesNotExist'"):
- simple_button.declare("ComponentDoesNotExist")
-
-
-def test_cannot_have_source_file_for_url_source_type():
- with pytest.raises(ValueError, match="File given, but source type is 'URL'"):
- idom.Module("test", source_file="something.js", source_type=URL_SOURCE)
-
-
-def test_cannot_check_exports_for_url_source_type():
- with pytest.raises(ValueError, match="Can't check exports for source type 'URL'"):
- idom.Module("test", check_exports=True, source_type=URL_SOURCE)
-
-
-def test_invalid_source_type():
- with pytest.raises(ValueError, match="Invalid source type"):
- idom.Module("test", source_type="TYPE_DOES_NOT_EXIST")
-
-
-def test_attribute_error_if_lowercase_name_doesn_not_exist():
- mod = idom.Module("test", source_type=URL_SOURCE)
- with pytest.raises(AttributeError, match="this_attribute_does_not_exist"):
- # This attribute would otherwise be considered to
- # be the name of a component the module exports.
- mod.this_attribute_does_not_exist
diff --git a/tests/test_client/utils.py b/tests/test_client/utils.py
deleted file mode 100644
index 404998db7..000000000
--- a/tests/test_client/utils.py
+++ /dev/null
@@ -1,10 +0,0 @@
-from contextlib import contextmanager
-from pathlib import Path
-
-
-@contextmanager
-def assert_file_is_touched(path):
- path = Path(path)
- last_modified = path.stat().st_mtime
- yield
- assert last_modified != path.stat().st_mtime
diff --git a/tests/test_dialect.py b/tests/test_dialect.py
deleted file mode 100644
index 7cb806a38..000000000
--- a/tests/test_dialect.py
+++ /dev/null
@@ -1,269 +0,0 @@
-import ast
-from typing import Any, Dict, Tuple
-
-import pytest
-from pyalect import DialectError, apply_dialects
-
-from idom import html
-
-
-def eval_html(src, variables=None):
- tree = apply_dialects(src, "html")
- if len(tree.body) > 1 or not isinstance(tree.body[0], ast.Expr):
- raise ValueError(f"Expected a single expression, not {src!r}")
- code = compile(ast.Expression(tree.body[0].value), "", "eval")
- return eval(code, {"html": html}, variables)
-
-
-def make_html_dialect_test(*expectations: Tuple[str, Dict[str, Any], Any]):
- def make_ids(exp):
- source, variables = exp[:2]
- source_repr = repr(source)
- if len(source_repr) > 30:
- source_repr = source_repr[:30] + "'..."
- variables_repr = repr(variables)
- if len(variables_repr) > 30:
- variables_repr = variables_repr[:30] + "...}"
- return source_repr + "-" + variables_repr
-
- @pytest.mark.parametrize("expect", expectations, ids=make_ids)
- def test_html_dialect(expect):
- source, variables, result = expect
- assert eval_html(source, variables) == result
-
- return test_html_dialect
-
-
-test_simple_htm_template = make_html_dialect_test(
- ('html(f"")', {}, {"tagName": "div"})
-)
-
-test_value_children = make_html_dialect_test(
- ('html(f"