Rework VDOM construction and type hints (#1281)

- Removed ``reactpy.vdom``. Use ``reactpy.Vdom`` instead.
- Removed ``reactpy.core.make_vdom_constructor``. Use ``reactpy.Vdom`` instead.
- Removed ``reactpy.core.custom_vdom_constructor``. Use ``reactpy.Vdom`` instead.
- ``reactpy.html`` will now automatically flatten lists recursively (ex. ``reactpy.html(["child1", ["child2"]])``)
- Added type hints to ``reactpy.html`` attributes.

Author: Archmonger

docs/source/about/changelog.rst

@@ -19,12 +19,15 @@ Unreleased
 - :pull:`1113` - Added ``reactpy.executors.asgi.ReactPy`` that can be used to run ReactPy in standalone mode via ASGI.
 - :pull:`1269` - Added ``reactpy.executors.asgi.ReactPyPyodide`` that can be used to run ReactPy in standalone mode via ASGI, but rendered entirely client-sided.
 - :pull:`1113` - Added ``reactpy.executors.asgi.ReactPyMiddleware`` that can be used to utilize ReactPy within any ASGI compatible framework.
-- :pull:`1113` :pull:`1269` - Added ``reactpy.templatetags.Jinja`` that can be used alongside ``ReactPyMiddleware`` to embed several ReactPy components into your existing application. This includes the following template tags: ``{% component %}``, ``{% pyscript_component %}``, and ``{% pyscript_setup %}``.
+- :pull:`1269` - Added ``reactpy.templatetags.Jinja`` that can be used alongside ``ReactPyMiddleware`` to embed several ReactPy components into your existing application. This includes the following template tags: ``{% component %}``, ``{% pyscript_component %}``, and ``{% pyscript_setup %}``.
 - :pull:`1269` - Added ``reactpy.pyscript_component`` that can be used to embed ReactPy components into your existing application.
 - :pull:`1113` - Added ``uvicorn`` and ``jinja`` installation extras (for example ``pip install reactpy[jinja]``).
 - :pull:`1113` - Added support for Python 3.12 and 3.13.
 - :pull:`1264` - Added ``reactpy.use_async_effect`` hook.
 - :pull:`1267` - Added ``shutdown_timeout`` parameter to the ``reactpy.use_async_effect`` hook.
+- :pull:`1281` - ``reactpy.html`` will now automatically flatten lists recursively (ex. ``reactpy.html(["child1", ["child2"]])``)
+- :pull:`1281` - Added ``reactpy.Vdom`` primitive interface for creating VDOM dictionaries.
+- :pull:`1281` - Added type hints to ``reactpy.html`` attributes.
 
 **Changed**
 
@@ -40,6 +43,9 @@ Unreleased
 - :pull:`1263` - ReactPy no longer auto-converts ``snake_case`` props to ``camelCase``. It is now the responsibility of the user to ensure that props are in the correct format.
 - :pull:`1278` - ``reactpy.utils.reactpy_to_string`` will now retain the user's original casing for ``data-*`` and ``aria-*`` attributes.
 - :pull:`1278` - ``reactpy.utils.string_to_reactpy`` has been upgraded to handle more complex scenarios without causing ReactJS rendering errors.
+- :pull:`1281` - ``reactpy.core.vdom._CustomVdomDictConstructor`` has been moved to ``reactpy.types.CustomVdomConstructor``.
+- :pull:`1281` - ``reactpy.core.vdom._EllipsisRepr`` has been moved to ``reactpy.types.EllipsisRepr``.
+- :pull:`1281` - ``reactpy.types.VdomDictConstructor`` has been renamed to ``reactpy.types.VdomConstructor``.
 
 **Removed**
 
@@ -56,6 +62,9 @@ Unreleased
 - :pull:`1113` - Removed deprecated function ``module_from_template``.
 - :pull:`1113` - Removed support for Python 3.9.
 - :pull:`1264` - Removed support for async functions within ``reactpy.use_effect`` hook. Use ``reactpy.use_async_effect`` instead.
+- :pull:`1281` - Removed ``reactpy.vdom``. Use ``reactpy.Vdom`` instead.
+- :pull:`1281` - Removed ``reactpy.core.make_vdom_constructor``. Use ``reactpy.Vdom`` instead.
+- :pull:`1281` - Removed ``reactpy.core.custom_vdom_constructor``. Use ``reactpy.Vdom`` instead.
 
 **Fixed**
 

pyproject.toml

@@ -107,6 +107,8 @@ filterwarnings = """
   ignore::DeprecationWarning:uvicorn.*
   ignore::DeprecationWarning:websockets.*
   ignore::UserWarning:tests.test_core.test_vdom
+  ignore::UserWarning:tests.test_pyscript.test_components
+  ignore::UserWarning:tests.test_utils
 """
 testpaths = "tests"
 xfail_strict = true

src/reactpy/__init__.py

@@ -19,7 +19,7 @@
     use_state,
 )
 from reactpy.core.layout import Layout
-from reactpy.core.vdom import vdom
+from reactpy.core.vdom import Vdom
 from reactpy.pyscript.components import pyscript_component
 from reactpy.utils import Ref, reactpy_to_string, string_to_reactpy
 
@@ -29,6 +29,7 @@
 __all__ = [
     "Layout",
     "Ref",
+    "Vdom",
     "component",
     "config",
     "create_context",
@@ -52,7 +53,6 @@
     "use_ref",
     "use_scope",
     "use_state",
-    "vdom",
     "web",
     "widgets",
 ]