ReactPy ASGI Middleware and standalone ReactPy ASGI App (#1113)

- `ReactPy` class has been created as the standalone API for ReactPy.
- `ReactPyMiddleware` has been created as the version of ReactPy that can wrap other ASGI web frameworks.
- Added a template tag to use alongside our middleware.
- `@reactpy/client` has been rewritten to be more modular.
- `reactpy.backends.*` is removed.

Author: Archmonger

.github/workflows/.hatch-run.yml

@@ -43,7 +43,7 @@ jobs:
               with:
                   python-version: ${{ matrix.python-version }}
             - name: Install Python Dependencies
-              run: pip install --upgrade pip hatch uv
+              run: pip install --upgrade hatch uv
             - name: Run Scripts
               env:
                   NPM_CONFIG_TOKEN: ${{ secrets.node-auth-token }}

.github/workflows/check.yml

@@ -6,7 +6,7 @@ on:
             - main
     pull_request:
         branches:
-            - main
+            - "*"
     schedule:
         - cron: "0 0 * * 0"
 
@@ -27,8 +27,10 @@ jobs:
             job-name: "python-{0} {1}"
             run-cmd: "hatch test"
             runs-on: '["ubuntu-latest", "macos-latest", "windows-latest"]'
-            python-version: '["3.9", "3.10", "3.11"]'
+            python-version: '["3.10", "3.11", "3.12", "3.13"]'
     test-documentation:
+        # Temporarily disabled
+        if: 0
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "python-{0}"

.gitignore

@@ -1,5 +1,5 @@
 # --- Build Artifacts ---
-src/reactpy/static/**/index.js*
+src/reactpy/static/*
 
 # --- Jupyter ---
 *.ipynb_checkpoints
@@ -15,8 +15,8 @@ src/reactpy/static/**/index.js*
 
 # --- Python ---
 .hatch
-.venv
-venv
+.venv*
+venv*
 MANIFEST
 build
 dist

docs/Dockerfile

@@ -33,6 +33,6 @@ RUN sphinx-build -v -W -b html source build
 # Define Entrypoint
 # -----------------
 ENV PORT=5000
-ENV REACTPY_DEBUG_MODE=1
+ENV REACTPY_DEBUG=1
 ENV REACTPY_CHECK_VDOM_SPEC=0
 CMD ["python", "main.py"]

docs/docs_app/app.py

@@ -6,7 +6,7 @@
 from docs_app.examples import get_normalized_example_name, load_examples
 from reactpy import component
 from reactpy.backend.sanic import Options, configure, use_request
-from reactpy.core.types import ComponentConstructor
+from reactpy.types import ComponentConstructor
 
 THIS_DIR = Path(__file__).parent
 DOCS_DIR = THIS_DIR.parent

docs/source/about/changelog.rst

@@ -15,20 +15,36 @@ Changelog
 Unreleased
 ----------
 
+**Added**
+- :pull:`1113` - Added ``reactpy.ReactPy`` that can be used to run ReactPy in standalone mode.
+- :pull:`1113` - Added ``reactpy.ReactPyMiddleware`` that can be used to run ReactPy with any ASGI compatible framework.
+- :pull:`1113` - Added ``reactpy.jinja.Component`` that can be used alongside ``ReactPyMiddleware`` to embed several ReactPy components into your existing application.
+- :pull:`1113` - Added ``standard``, ``uvicorn``, ``jinja`` installation extras (for example ``pip install reactpy[standard]``).
+- :pull:`1113` - Added support for Python 3.12 and 3.13.
+
 **Changed**
 
 - :pull:`1251` - Substitute client-side usage of ``react`` with ``preact``.
 - :pull:`1239` - Script elements no longer support behaving like effects. They now strictly behave like plain HTML script elements.
 - :pull:`1255` - The ``reactpy.html`` module has been modified to allow for auto-creation of any HTML nodes. For example, you can create a ``<data-table>`` element by calling ``html.data_table()``.
 - :pull:`1256` - Change ``set_state`` comparison method to check equality with ``==`` more consistently.
 - :pull:`1257` - Add support for rendering ``@component`` children within ``vdom_to_html``.
+- :pull:`1113` - Renamed the ``use_location`` hook's ``search`` attribute to ``query_string``.
+- :pull:`1113` - Renamed the ``use_location`` hook's ``pathname`` attribute to ``path``.
+- :pull:`1113` - Renamed ``reactpy.config.REACTPY_DEBUG_MODE`` to ``reactpy.config.REACTPY_DEBUG``.
 
 **Removed**
 
 - :pull:`1255` - Removed the ability to import ``reactpy.html.*`` elements directly. You must now call ``html.*`` to access the elements.
 - :pull:`1255` - Removed ``reactpy.sample`` module.
 - :pull:`1255` - Removed ``reactpy.svg`` module. Contents previously within ``reactpy.svg.*`` can now be accessed via ``html.svg.*``.
 - :pull:`1255` - Removed ``reactpy.html._`` function. Use ``html.fragment`` instead.
+- :pull:`1113` - Removed ``reactpy.run``. See the documentation for the new method to run ReactPy applications.
+- :pull:`1113` - Removed ``reactpy.backend.*``. See the documentation for the new method to run ReactPy applications.
+- :pull:`1113` - Removed ``reactpy.core.types`` module. Use ``reactpy.types`` instead.
+- :pull:`1113` - All backend related installation extras (such as ``pip install reactpy[starlette]``) have been removed.
+- :pull:`1113` - Removed deprecated function ``module_from_template``.
+- :pull:`1113` - Removed support for Python 3.9.
 
 **Fixed**
 

docs/source/guides/escape-hatches/distributing-javascript.rst

@@ -188,7 +188,7 @@ loaded with :func:`~reactpy.web.module.export`.
 
 .. note::
 
-    When :data:`reactpy.config.REACTPY_DEBUG_MODE` is active, named exports will be validated.
+    When :data:`reactpy.config.REACTPY_DEBUG` is active, named exports will be validated.
 
 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

docs/source/guides/getting-started/running-reactpy.rst

@@ -103,29 +103,29 @@ Running ReactPy in Debug Mode
 -----------------------------
 
 ReactPy provides a debug mode that is turned off by default. This can be enabled when you
-run your application by setting the ``REACTPY_DEBUG_MODE`` environment variable.
+run your application by setting the ``REACTPY_DEBUG`` environment variable.
 
 .. tab-set::
 
     .. tab-item:: Unix Shell
 
         .. code-block::
 
-            export REACTPY_DEBUG_MODE=1
+            export REACTPY_DEBUG=1
             python my_reactpy_app.py
 
     .. tab-item:: Command Prompt
 
         .. code-block:: text
 
-            set REACTPY_DEBUG_MODE=1
+            set REACTPY_DEBUG=1
             python my_reactpy_app.py
 
     .. tab-item:: PowerShell
 
         .. code-block:: powershell
 
-            $env:REACTPY_DEBUG_MODE = "1"
+            $env:REACTPY_DEBUG = "1"
             python my_reactpy_app.py
 
 .. danger::

pyproject.toml

@@ -29,14 +29,15 @@ classifiers = [
 dependencies = [
   "exceptiongroup >=1.0",
   "typing-extensions >=3.10",
-  "mypy-extensions >=0.4.3",
   "anyio >=3",
   "jsonpatch >=1.32",
   "fastjsonschema >=2.14.5",
   "requests >=2",
   "colorlog >=6",
   "asgiref >=3",
   "lxml >=4",
+  "servestatic >=3.0.0",
+  "orjson >=3",
 ]
 dynamic = ["version"]
 urls.Changelog = "https://reactpy.dev/docs/about/changelog.html"
@@ -69,24 +70,15 @@ commands = [
   'bun run --cwd "src/js/packages/@reactpy/client" build',
   'bun install --cwd "src/js/packages/@reactpy/app"',
   'bun run --cwd "src/js/packages/@reactpy/app" build',
-  'python "src/build_scripts/copy_dir.py" "src/js/packages/@reactpy/app/dist" "src/reactpy/static/assets"',
+  'python "src/build_scripts/copy_dir.py" "src/js/packages/@reactpy/app/dist" "src/reactpy/static"',
 ]
 artifacts = []
 
 [project.optional-dependencies]
-# TODO: Nuke backends from the optional deps
-all = ["reactpy[starlette,sanic,fastapi,flask,tornado,testing]"]
-starlette = ["starlette >=0.13.6", "uvicorn[standard] >=0.19.0"]
-sanic = [
-  "sanic>=21",
-  "sanic-cors",
-  "tracerite>=1.1.1",
-  "setuptools",
-  "uvicorn[standard]>=0.19.0",
-]
-fastapi = ["fastapi >=0.63.0", "uvicorn[standard] >=0.19.0"]
-flask = ["flask", "markupsafe>=1.1.1,<2.1", "flask-cors", "flask-sock"]
-tornado = ["tornado"]
+all = ["reactpy[jinja,uvicorn,testing]"]
+standard = ["reactpy[jinja,uvicorn]"]
+jinja = ["jinja2-simple-tags", "jinja2 >=3"]
+uvicorn = ["uvicorn[standard]"]
 testing = ["playwright"]
 
 
@@ -103,45 +95,31 @@ extra-dependencies = [
   "responses",
   "playwright",
   "jsonpointer",
-  # TODO: Nuke everything past this point after removing backends from deps
-  "starlette >=0.13.6",
-  "uvicorn[standard] >=0.19.0",
-  "sanic>=21",
-  "sanic-cors",
-  "sanic-testing",
-  "tracerite>=1.1.1",
-  "setuptools",
-  "uvicorn[standard]>=0.19.0",
-  "fastapi >=0.63.0",
-  "uvicorn[standard] >=0.19.0",
-  "flask",
-  "markupsafe>=1.1.1,<2.1",
-  "flask-cors",
-  "flask-sock",
-  "tornado",
+  "uvicorn[standard]",
+  "jinja2-simple-tags",
+  "jinja2 >=3",
+  "starlette",
 ]
 
 [[tool.hatch.envs.hatch-test.matrix]]
-python = ["3.9", "3.10", "3.11", "3.12"]
+python = ["3.10", "3.11", "3.12", "3.13"]
 
 [tool.pytest.ini_options]
 addopts = """\
-    --strict-config
-    --strict-markers
-    """
+  --strict-config
+  --strict-markers
+"""
+filterwarnings = """
+  ignore::DeprecationWarning:uvicorn.*
+  ignore::DeprecationWarning:websockets.*
+  ignore::UserWarning:tests.test_core.test_vdom
+"""
 testpaths = "tests"
 xfail_strict = true
 asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 log_cli_level = "INFO"
 
-[tool.hatch.envs.default.scripts]
-test-cov = "playwright install && coverage run -m pytest {args:tests}"
-cov-report = ["coverage report"]
-cov = ["test-cov {args}", "cov-report"]
-
-[tool.hatch.envs.default.env-vars]
-REACTPY_DEBUG_MODE = "1"
-
 #######################################
 # >>> Hatch Documentation Scripts <<< #
 #######################################
@@ -256,10 +234,14 @@ warn_unused_ignores = true
 source_pkgs = ["reactpy"]
 branch = false
 parallel = false
-omit = ["reactpy/__init__.py"]
+omit = [
+  "src/reactpy/__init__.py",
+  "src/reactpy/_console/*",
+  "src/reactpy/__main__.py",
+]
 
 [tool.coverage.report]
-fail_under = 98
+fail_under = 100
 show_missing = true
 skip_covered = true
 sort = "Name"
@@ -269,7 +251,6 @@ exclude_also = [
   "if __name__ == .__main__.:",
   "if TYPE_CHECKING:",
 ]
-omit = ["**/reactpy/__main__.py"]
 
 [tool.ruff]
 target-version = "py39"

src/js/packages/@reactpy/app/package.json

@@ -11,7 +11,7 @@
     "typescript": "^5.7.3"
   },
   "scripts": {
-    "build": "bun build \"src/index.ts\" --outdir \"dist\" --minify --sourcemap=linked",
+    "build": "bun build \"src/index.ts\" --outdir=\"dist\" --minify --sourcemap=\"linked\"",
     "checkTypes": "tsc --noEmit"
   }
 }