Move some project files around

Archmonger · Archmonger · commit df3c0f7cf14b · 2025-01-26T19:31:55.000-08:00
diff --git a/middleware.py b/middleware.py
@@ -0,0 +1,37 @@
+from starlette.applications import Starlette
+from starlette.routing import Route
+from starlette.templating import Jinja2Templates
+
+from reactpy import component, hooks, html
+from reactpy.backend.middleware import ReactPyMiddleware
+
+templates = Jinja2Templates(
+    directory="templates", extensions=["reactpy.jinja.ReactPyTemplateTag"]
+)
+
+
+@component
+def Counter():
+    count, set_count = hooks.use_state(0)
+
+    def increment(event):
+        set_count(count + 1)
+
+    return html.div(
+        html.button({"onClick": increment}, "Increment"),
+        html.p(f"Count: {count}"),
+    )
+
+
+async def homepage(request):
+    return templates.TemplateResponse(request, "index.html")
+
+
+app = Starlette(
+    debug=True,
+    routes=[
+        Route("/", homepage),
+    ],
+)
+
+app = ReactPyMiddleware(app, ["middleware.Counter"])
diff --git a/pyproject.toml b/pyproject.toml
@@ -37,7 +37,6 @@ dependencies = [
   "asgiref >=3",
   "lxml >=4",
   "servestatic >=3.0.0",
-  "jinja2 >=3",
 ]
 dynamic = ["version"]
 urls.Changelog = "https://reactpy.dev/docs/about/changelog.html"
@@ -77,7 +76,7 @@ artifacts = []
 [project.optional-dependencies]
 # TODO: Nuke backends from the optional deps
 all = ["reactpy[jinja,uvicorn,testing]"]
-jinja = ["jinja2-simple-tags", "jinja2"]
+jinja = ["jinja2-simple-tags", "jinja2 >=3"]
 uvicorn = ["uvicorn[standard]"]
 testing = ["playwright"]
 
diff --git a/src/reactpy/__init__.py b/src/reactpy/__init__.py
@@ -1,4 +1,4 @@
-from reactpy import backend, config, logging, types, web, widgets
+from reactpy import asgi, config, logging, types, web, widgets
 from reactpy._html import html
 from reactpy.core import hooks
 from reactpy.core.component import component
@@ -27,7 +27,7 @@
 __all__ = [
     "Layout",
     "Ref",
-    "backend",
+    "asgi",
     "component",
     "config",
     "create_context",
diff --git a/src/reactpy/asgi/__init__.py b/src/reactpy/asgi/__init__.py
diff --git a/src/reactpy/asgi/middleware.py b/src/reactpy/asgi/middleware.py
@@ -14,13 +14,12 @@
 from asgiref.compatibility import guarantee_single_callable
 from servestatic import ServeStaticASGI
 
-from reactpy.backend.types import Connection, Location
-from reactpy.backend.utils import check_path, import_components
+from reactpy.asgi.utils import check_path, import_components
 from reactpy.config import REACTPY_WEB_MODULES_DIR
 from reactpy.core.hooks import ConnectionContext
 from reactpy.core.layout import Layout
 from reactpy.core.serve import serve_layout
-from reactpy.types import RootComponentConstructor
+from reactpy.types import Connection, Location, RootComponentConstructor
 
 _logger = logging.getLogger(__name__)
 
diff --git a/src/reactpy/asgi/standalone.py b/src/reactpy/asgi/standalone.py
@@ -9,8 +9,8 @@
 from typing import Any, Callable
 
 from reactpy import html
-from reactpy.backend.middleware import ReactPyMiddleware
-from reactpy.backend.utils import (
+from reactpy.asgi.middleware import ReactPyMiddleware
+from reactpy.asgi.utils import (
     dict_to_byte_list,
     http_response,
     replace_many,
diff --git a/src/reactpy/asgi/utils.py b/src/reactpy/asgi/utils.py
diff --git a/src/reactpy/backend/__init__.py b/src/reactpy/backend/__init__.py
diff --git a/src/reactpy/backend/types.py b/src/reactpy/backend/types.py
diff --git a/src/reactpy/core/hooks.py b/src/reactpy/core/hooks.py
@@ -18,10 +18,10 @@
 
 from typing_extensions import TypeAlias
 
-from reactpy.backend.types import Connection, Location
 from reactpy.config import REACTPY_DEBUG_MODE
 from reactpy.core._life_cycle_hook import current_hook
 from reactpy.core.types import Context, Key, State, VdomDict
+from reactpy.types import Connection, Location
 from reactpy.utils import Ref
 
 if not TYPE_CHECKING:
@@ -264,12 +264,12 @@ def use_connection() -> Connection[Any]:
 
 
 def use_scope() -> MutableMapping[str, Any]:
-    """Get the current :class:`~reactpy.backend.types.Connection`'s scope."""
+    """Get the current :class:`~reactpy.types.Connection`'s scope."""
     return use_connection().scope
 
 
 def use_location() -> Location:
-    """Get the current :class:`~reactpy.backend.types.Connection`'s location."""
+    """Get the current :class:`~reactpy.types.Connection`'s location."""
     return use_connection().location
 
 
diff --git a/src/reactpy/core/types.py b/src/reactpy/core/types.py
@@ -2,7 +2,8 @@
 
 import sys
 from collections import namedtuple
-from collections.abc import Mapping, Sequence
+from collections.abc import Mapping, MutableMapping, Sequence
+from dataclasses import dataclass
 from types import TracebackType
 from typing import (
     TYPE_CHECKING,
@@ -19,6 +20,8 @@
 
 from typing_extensions import TypeAlias, TypedDict
 
+CarrierType = TypeVar("CarrierType")
+
 _Type = TypeVar("_Type")
 
 
@@ -246,3 +249,38 @@ class ContextProviderType(ComponentType, Protocol[_Type]):
     @property
     def value(self) -> _Type:
         "Current context value"
+
+
+@dataclass
+class Connection(Generic[CarrierType]):
+    """Represents a connection with a client"""
+
+    scope: MutableMapping[str, Any]
+    """An ASGI scope dictionary"""
+
+    location: Location
+    """The current location (URL)"""
+
+    carrier: CarrierType
+    """How the connection is mediated. For example, a request or websocket.
+
+    This typically depends on the backend implementation.
+    """
+
+
+@dataclass
+class Location:
+    """Represents the current location (URL)
+
+    Analogous to, but not necessarily identical to, the client-side
+    ``document.location`` object.
+    """
+
+    pathname: str
+    """the path of the URL for the location"""
+
+    query_string: str
+    """HTTP query string - a '?' followed by the parameters of the URL.
+
+    If there are no search parameters this should be an empty string
+    """
diff --git a/src/reactpy/jinja.py b/src/reactpy/jinja.py
@@ -1,15 +1,24 @@
 import urllib.parse
+from importlib import import_module
 from typing import ClassVar
 from uuid import uuid4
 
 from jinja2_simple_tags import StandaloneTag
 
+try:
+    import_module("jinja2")
+except ImportError as e:
+    raise ImportError(
+        "The Jinja2 library is required to use the ReactPy template tag. "
+        "Please install it via `pip install reactpy[jinja]`."
+    ) from e
 
-class ComponentTag(StandaloneTag):
+
+class ReactPyTemplateTag(StandaloneTag):
     """This allows enables a `component` tag to be used in any Jinja2 rendering context."""
 
     safe_output = True
-    tags: ClassVar[set[str]] = {"reactpy_component"}
+    tags: ClassVar[set[str]] = {"component"}
 
     def render(self, dotted_path: str, *args, **kwargs):
         uuid = uuid4().hex
diff --git a/src/reactpy/testing/backend.py b/src/reactpy/testing/backend.py
@@ -7,9 +7,8 @@
 from typing import Any, Callable
 from urllib.parse import urlencode, urlunparse
 
-from reactpy.backend import default as default_server
-from reactpy.backend.types import BackendType
-from reactpy.backend.utils import find_available_port
+from reactpy.asgi import default as default_server
+from reactpy.asgi.utils import find_available_port
 from reactpy.config import REACTPY_TESTING_DEFAULT_TIMEOUT
 from reactpy.core.component import component
 from reactpy.core.hooks import use_callback, use_effect, use_state
@@ -19,6 +18,7 @@
     capture_reactpy_logs,
     list_logged_exceptions,
 )
+from reactpy.types import BackendType
 from reactpy.utils import Ref
 
 
diff --git a/src/reactpy/types.py b/src/reactpy/types.py
@@ -4,11 +4,11 @@
 - :mod:`reactpy.backend.types`
 """
 
-from reactpy.backend.types import Connection, Location
 from reactpy.core.component import Component
 from reactpy.core.types import (
     ComponentConstructor,
     ComponentType,
+    Connection,
     Context,
     EventHandlerDict,
     EventHandlerFunc,
@@ -17,6 +17,7 @@
     ImportSourceDict,
     Key,
     LayoutType,
+    Location,
     RootComponentConstructor,
     State,
     VdomAttributes,
diff --git a/standalone.py b/standalone.py
@@ -0,0 +1,21 @@
+from reactpy import component, hooks, html
+from reactpy.backend.standalone import ReactPy
+
+
+@component
+def Counter():
+    count, set_count = hooks.use_state(0)
+
+    def increment(event):
+        set_count(count + 1)
+
+    return html.div(
+        html.button({"onClick": increment}, "Increment"),
+        html.p(f"Count: {count}"),
+    )
+
+
+app = ReactPy(Counter)
+# from reactpy import run
+
+# run(Counter)
diff --git a/templates/index.html b/templates/index.html
@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+
+<head></head>
+
+<body>
+  <div id="app"></div>
+  {% component "middleware.Counter" %}
+</body>
+
+</html>
diff --git a/tests/test_backend/test_all.py b/tests/test_backend/test_all.py
@@ -4,11 +4,11 @@
 
 import reactpy
 from reactpy import html
-from reactpy.backend import default as default_implementation
-from reactpy.backend._common import PATH_PREFIX
-from reactpy.backend.types import BackendType, Connection, Location
-from reactpy.backend.utils import all_implementations
+from reactpy.asgi import default as default_implementation
+from reactpy.asgi._common import PATH_PREFIX
+from reactpy.asgi.utils import all_implementations
 from reactpy.testing import BackendFixture, DisplayFixture, poll
+from reactpy.types import BackendType, Connection, Location
 
 
 @pytest.fixture(
diff --git a/tests/test_backend/test_common.py b/tests/test_backend/test_common.py
@@ -1,7 +1,7 @@
 import pytest
 
 from reactpy import html
-from reactpy.backend._common import (
+from reactpy.asgi._common import (
     CommonOptions,
     traversal_safe_path,
     vdom_head_elements_to_html,
diff --git a/tests/test_backend/test_utils.py b/tests/test_backend/test_utils.py
@@ -5,9 +5,9 @@
 import pytest
 from playwright.async_api import Page
 
-from reactpy.backend import flask as flask_implementation
-from reactpy.backend.utils import find_available_port
-from reactpy.backend.utils import run as sync_run
+from reactpy.asgi import flask as flask_implementation
+from reactpy.asgi.utils import find_available_port
+from reactpy.asgi.utils import run as sync_run
 from tests.sample import SampleApp
 
 
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -5,7 +5,7 @@
 from playwright.async_api import Browser
 
 import reactpy
-from reactpy.backend.utils import find_available_port
+from reactpy.asgi.utils import find_available_port
 from reactpy.testing import BackendFixture, DisplayFixture, poll
 from tests.tooling.common import DEFAULT_TYPE_DELAY
 from tests.tooling.hooks import use_counter
diff --git a/tests/test_testing.py b/tests/test_testing.py
diff --git a/tests/test_web/test_module.py b/tests/test_web/test_module.py
