Changes to v2 to encourage docs simplicity

Author: Archmonger

docs/source/about/changelog.rst

@@ -18,11 +18,11 @@ Unreleased
 **Added**
 
 - :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:`1269` - Added ``reactpy.executors.asgi.ReactPyCsr`` 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:`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.ReactPyJinja`` 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 ``asgi`` and ``jinja`` installation extras (for example ``pip install reactpy[asgi, 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.
@@ -72,8 +72,8 @@ Unreleased
 **Fixed**
 
 - :pull:`1239` - Fixed a bug where script elements would not render to the DOM as plain text.
-- :pull:`1271` - Fixed a bug where the ``key`` property provided via server-side ReactPy code was failing to propagate to the front-end JavaScript component.
-- :pull:`1254` - Fixed a bug where ``RuntimeError("Hook stack is in an invalid state")`` errors would be provided when using a webserver that reuses threads.
+- :pull:`1271` - Fixed a bug where the ``key`` property provided within server-side ReactPy code was failing to propagate to the front-end JavaScript components.
+- :pull:`1254` - Fixed a bug where ``RuntimeError("Hook stack is in an invalid state")`` errors could be generated when using a webserver that reuses threads.
 
 v1.1.0
 ------

pyproject.toml

@@ -40,10 +40,9 @@ urls.Documentation = "https://reactpy.dev/"
 urls.Source = "https://github.com/reactive-python/reactpy"
 
 [project.optional-dependencies]
-all = ["reactpy[asgi,jinja,uvicorn,testing]"]
+all = ["reactpy[asgi,jinja,testing]"]
 asgi = ["asgiref", "asgi-tools", "servestatic", "orjson", "pip"]
 jinja = ["jinja2-simple-tags", "jinja2 >=3"]
-uvicorn = ["uvicorn[standard]"]
 testing = ["playwright"]
 
 [tool.hatch.version]

src/reactpy/executors/asgi/__init__.py

@@ -1,5 +1,5 @@
 from reactpy.executors.asgi.middleware import ReactPyMiddleware
-from reactpy.executors.asgi.pyscript import ReactPyPyscript
+from reactpy.executors.asgi.pyscript import ReactPyCsr
 from reactpy.executors.asgi.standalone import ReactPy
 
-__all__ = ["ReactPy", "ReactPyMiddleware", "ReactPyPyscript"]
+__all__ = ["ReactPy", "ReactPyCsr", "ReactPyMiddleware"]

src/reactpy/executors/asgi/pyscript.py

@@ -20,7 +20,7 @@
 from reactpy.types import ReactPyConfig, VdomDict
 
 
-class ReactPyPyscript(ReactPy):
+class ReactPyCsr(ReactPy):
     def __init__(
         self,
         *file_paths: str | Path,
@@ -64,7 +64,7 @@ def __init__(
                 are not applicable to CSR and will have no effect.
         """
         ReactPyMiddleware.__init__(
-            self, app=ReactPyPyscriptApp(self), root_components=[], **settings
+            self, app=ReactpyPyscriptApp(self), root_components=[], **settings
         )
         if not file_paths:
             raise ValueError("At least one component file path must be provided.")
@@ -85,10 +85,10 @@ def match_dispatch_path(self, scope: AsgiWebsocketScope) -> bool:  # nocov
 
 
 @dataclass
-class ReactPyPyscriptApp(ReactPyApp):
+class ReactpyPyscriptApp(ReactPyApp):
     """ReactPy's standalone ASGI application for Client-Side Rendering (CSR) via PyScript."""
 
-    parent: ReactPyPyscript
+    parent: ReactPyCsr
     _index_html = ""
     _etag = ""
     _last_modified = ""

src/reactpy/pyscript/component_template.py

@@ -1,11 +1,8 @@
-# ruff: noqa: TC004, N802, N816, RUF006
+# ruff: noqa: N802, N816, RUF006
 # type: ignore
-from typing import TYPE_CHECKING
+import asyncio
 
-if TYPE_CHECKING:
-    import asyncio
-
-    from reactpy.pyscript.layout_handler import ReactPyLayoutHandler
+from reactpy.pyscript.layout_handler import ReactPyLayoutHandler
 
 
 # User component is inserted below by regex replacement

src/reactpy/pyscript/layout_handler.py

@@ -11,7 +11,7 @@
 
 
 class ReactPyLayoutHandler:
-    """Encapsulate the entire layout handler with a class to prevent overlapping
+    """Encapsulate the entire PyScript layout handler with a class to prevent overlapping
     variable names between user code.
 
     This code is designed to be run directly by PyScript, and is not intended to be run

src/reactpy/templatetags/__init__.py

@@ -1,3 +1,3 @@
-from reactpy.templatetags.jinja import Jinja
+from reactpy.templatetags.jinja import ReactPyJinja
 
-__all__ = ["Jinja"]
+__all__ = ["ReactPyJinja"]

src/reactpy/templatetags/jinja.py

@@ -7,7 +7,7 @@
 from reactpy.pyscript.utils import pyscript_component_html, pyscript_setup_html
 
 
-class Jinja(StandaloneTag):  # type: ignore
+class ReactPyJinja(StandaloneTag):  # type: ignore
     safe_output = True
     tags: ClassVar[set[str]] = {"component", "pyscript_component", "pyscript_setup"}
 

tests/test_asgi/test_middleware.py

@@ -22,7 +22,7 @@ async def display(page):
     templates = Jinja2Templates(
         env=JinjaEnvironment(
             loader=JinjaFileSystemLoader("tests/templates"),
-            extensions=["reactpy.templatetags.Jinja"],
+            extensions=["reactpy.templatetags.ReactPyJinja"],
         )
     )
 
@@ -60,7 +60,7 @@ async def test_unregistered_root_component():
     templates = Jinja2Templates(
         env=JinjaEnvironment(
             loader=JinjaFileSystemLoader("tests/templates"),
-            extensions=["reactpy.templatetags.Jinja"],
+            extensions=["reactpy.templatetags.ReactPyJinja"],
         )
     )
 
@@ -124,7 +124,7 @@ async def test_templatetag_bad_kwargs(page, caplog):
     templates = Jinja2Templates(
         env=JinjaEnvironment(
             loader=JinjaFileSystemLoader("tests/templates"),
-            extensions=["reactpy.templatetags.Jinja"],
+            extensions=["reactpy.templatetags.ReactPyJinja"],
         )
     )
 

tests/test_asgi/test_pyscript.py

@@ -9,14 +9,14 @@
 from starlette.templating import Jinja2Templates
 
 from reactpy import html
-from reactpy.executors.asgi.pyscript import ReactPyPyscript
+from reactpy.executors.asgi.pyscript import ReactPyCsr
 from reactpy.testing import BackendFixture, DisplayFixture
 
 
 @pytest.fixture()
 async def display(page):
     """Override for the display fixture that uses ReactPyMiddleware."""
-    app = ReactPyPyscript(
+    app = ReactPyCsr(
         Path(__file__).parent / "pyscript_components" / "root.py",
         initial=html.div({"id": "loading"}, "Loading..."),
     )
@@ -29,7 +29,7 @@ async def display(page):
 @pytest.fixture()
 async def multi_file_display(page):
     """Override for the display fixture that uses ReactPyMiddleware."""
-    app = ReactPyPyscript(
+    app = ReactPyCsr(
         Path(__file__).parent / "pyscript_components" / "load_first.py",
         Path(__file__).parent / "pyscript_components" / "load_second.py",
         initial=html.div({"id": "loading"}, "Loading..."),
@@ -46,7 +46,7 @@ async def jinja_display(page):
     templates = Jinja2Templates(
         env=JinjaEnvironment(
             loader=JinjaFileSystemLoader("tests/templates"),
-            extensions=["reactpy.templatetags.Jinja"],
+            extensions=["reactpy.templatetags.ReactPyJinja"],
         )
     )
 
@@ -93,7 +93,7 @@ async def test_multi_file_components(multi_file_display: DisplayFixture):
 
 def test_bad_file_path():
     with pytest.raises(ValueError):
-        ReactPyPyscript()
+        ReactPyCsr()
 
 
 async def test_jinja_template_tag(jinja_display: DisplayFixture):