Reduce dependencies by making ASGI optional

Author: Archmonger

docs/source/about/changelog.rst

@@ -16,8 +16,8 @@ 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.asgi.ReactPy`` that can be used to run ReactPy in standalone mode via ASGI.
+- :pull:`1113` - Added ``reactpy.asgi.ReactPyMiddleware`` that can be used to utilize ReactPy within any ASGI compatible framework.
 - :pull:`1113` - Added ``reactpy.templatetags.Jinja`` that can be used alongside ``ReactPyMiddleware`` to embed several 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.

pyproject.toml

@@ -28,24 +28,21 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = [
-  "exceptiongroup >=1.0",
-  "typing-extensions >=3.10",
-  "anyio >=3",
   "fastjsonschema >=2.14.5",
   "requests >=2",
-  "asgiref >=3",
   "lxml >=4",
-  "servestatic >=3.0.0",
-  "orjson >=3",
-  "asgi-tools",
+  "anyio >=3",
+  "typing-extensions >=3.10",
 ]
 dynamic = ["version"]
 urls.Changelog = "https://reactpy.dev/docs/about/changelog.html"
 urls.Documentation = "https://reactpy.dev/"
 urls.Source = "https://github.com/reactive-python/reactpy"
 
 [project.optional-dependencies]
-all = ["reactpy[jinja,uvicorn,testing]"]
+all = ["reactpy[asgi,jinja,uvicorn,testing]"]
+standard = ["reactpy[asgi]"]
+asgi = ["asgiref", "asgi-tools", "servestatic", "orjson"]
 jinja = ["jinja2-simple-tags", "jinja2 >=3"]
 uvicorn = ["uvicorn[standard]"]
 testing = ["playwright"]
@@ -91,14 +88,12 @@ artifacts = []
 
 [tool.hatch.envs.hatch-test]
 extra-dependencies = [
+  "reactpy[all]",
   "pytest-sugar",
   "pytest-asyncio",
   "responses",
-  "playwright",
+  "exceptiongroup",
   "jsonpointer",
-  "uvicorn[standard]",
-  "jinja2-simple-tags",
-  "jinja2",
   "starlette",
 ]
 
@@ -158,6 +153,7 @@ serve = [
 
 [tool.hatch.envs.python]
 extra-dependencies = [
+  "reactpy[all]",
   "ruff",
   "toml",
   "mypy==1.8",

src/reactpy/__init__.py

@@ -1,7 +1,5 @@
-from reactpy import asgi, config, logging, types, web, widgets
+from reactpy import config, logging, types, web, widgets
 from reactpy._html import html
-from reactpy.asgi.executors.standalone import ReactPy
-from reactpy.asgi.middleware import ReactPyMiddleware
 from reactpy.core import hooks
 from reactpy.core.component import component
 from reactpy.core.events import event
@@ -29,10 +27,7 @@
 
 __all__ = [
     "Layout",
-    "ReactPy",
-    "ReactPyMiddleware",
     "Ref",
-    "asgi",
     "component",
     "config",
     "create_context",

src/reactpy/asgi/__init__.py

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

src/reactpy/asgi/executors/pyscript.py

@@ -16,10 +16,7 @@
 from reactpy.asgi.middleware import ReactPyMiddleware
 from reactpy.asgi.utils import vdom_head_to_html
 from reactpy.pyscript.utils import pyscript_component_html, pyscript_setup_html
-from reactpy.types import (
-    ReactPyConfig,
-    VdomDict,
-)
+from reactpy.types import ReactPyConfig, VdomDict
 
 
 class ReactPyCSR(ReactPy):

src/reactpy/asgi/executors/standalone.py

@@ -14,16 +14,9 @@
 
 from reactpy import html
 from reactpy.asgi.middleware import ReactPyMiddleware
+from reactpy.asgi.types import AsgiApp, AsgiHttpApp, AsgiLifespanApp, AsgiWebsocketApp
 from reactpy.asgi.utils import import_dotted_path, vdom_head_to_html
-from reactpy.types import (
-    AsgiApp,
-    AsgiHttpApp,
-    AsgiLifespanApp,
-    AsgiWebsocketApp,
-    ReactPyConfig,
-    RootComponentConstructor,
-    VdomDict,
-)
+from reactpy.types import ReactPyConfig, RootComponentConstructor, VdomDict
 from reactpy.utils import asgi_component_html
 
 _logger = getLogger(__name__)

src/reactpy/asgi/middleware.py

@@ -18,22 +18,19 @@
 from typing_extensions import Unpack
 
 from reactpy import config
-from reactpy.asgi.utils import check_path, import_components, process_settings
-from reactpy.core.hooks import ConnectionContext
-from reactpy.core.layout import Layout
-from reactpy.core.serve import serve_layout
-from reactpy.types import (
+from reactpy.asgi.types import (
     AsgiApp,
     AsgiHttpApp,
     AsgiLifespanApp,
     AsgiWebsocketApp,
     AsgiWebsocketReceive,
     AsgiWebsocketSend,
-    Connection,
-    Location,
-    ReactPyConfig,
-    RootComponentConstructor,
 )
+from reactpy.asgi.utils import check_path, import_components, process_settings
+from reactpy.core.hooks import ConnectionContext
+from reactpy.core.layout import Layout
+from reactpy.core.serve import serve_layout
+from reactpy.types import Connection, Location, ReactPyConfig, RootComponentConstructor
 
 _logger = logging.getLogger(__name__)
 
@@ -222,7 +219,7 @@ async def run_dispatcher(self) -> None:
                 self.scope["query_string"].decode(), strict_parsing=True
             )
             connection = Connection(
-                scope=self.scope,
+                scope=self.scope,  # type: ignore
                 location=Location(
                     path=ws_query_string.get("http_pathname", [""])[0],
                     query_string=ws_query_string.get("http_query_string", [""])[0],

src/reactpy/asgi/types.py

@@ -0,0 +1,77 @@
+"""These types are separated from the main module to avoid dependency issues."""
+
+from __future__ import annotations
+
+from collections.abc import Awaitable
+from typing import Callable, Union
+
+from asgiref import typing as asgi_types
+
+AsgiHttpReceive = Callable[
+    [],
+    Awaitable[asgi_types.HTTPRequestEvent | asgi_types.HTTPDisconnectEvent],
+]
+
+AsgiHttpSend = Callable[
+    [
+        asgi_types.HTTPResponseStartEvent
+        | asgi_types.HTTPResponseBodyEvent
+        | asgi_types.HTTPResponseTrailersEvent
+        | asgi_types.HTTPServerPushEvent
+        | asgi_types.HTTPDisconnectEvent
+    ],
+    Awaitable[None],
+]
+
+AsgiWebsocketReceive = Callable[
+    [],
+    Awaitable[
+        asgi_types.WebSocketConnectEvent
+        | asgi_types.WebSocketDisconnectEvent
+        | asgi_types.WebSocketReceiveEvent
+    ],
+]
+
+AsgiWebsocketSend = Callable[
+    [
+        asgi_types.WebSocketAcceptEvent
+        | asgi_types.WebSocketSendEvent
+        | asgi_types.WebSocketResponseStartEvent
+        | asgi_types.WebSocketResponseBodyEvent
+        | asgi_types.WebSocketCloseEvent
+    ],
+    Awaitable[None],
+]
+
+AsgiLifespanReceive = Callable[
+    [],
+    Awaitable[asgi_types.LifespanStartupEvent | asgi_types.LifespanShutdownEvent],
+]
+
+AsgiLifespanSend = Callable[
+    [
+        asgi_types.LifespanStartupCompleteEvent
+        | asgi_types.LifespanStartupFailedEvent
+        | asgi_types.LifespanShutdownCompleteEvent
+        | asgi_types.LifespanShutdownFailedEvent
+    ],
+    Awaitable[None],
+]
+
+AsgiHttpApp = Callable[
+    [asgi_types.HTTPScope, AsgiHttpReceive, AsgiHttpSend],
+    Awaitable[None],
+]
+
+AsgiWebsocketApp = Callable[
+    [asgi_types.WebSocketScope, AsgiWebsocketReceive, AsgiWebsocketSend],
+    Awaitable[None],
+]
+
+AsgiLifespanApp = Callable[
+    [asgi_types.LifespanScope, AsgiLifespanReceive, AsgiLifespanSend],
+    Awaitable[None],
+]
+
+
+AsgiApp = Union[AsgiHttpApp, AsgiWebsocketApp, AsgiLifespanApp]

src/reactpy/core/hooks.py

@@ -16,7 +16,6 @@
     overload,
 )
 
-from asgiref import typing as asgi_types
 from typing_extensions import TypeAlias
 
 from reactpy.config import REACTPY_DEBUG
@@ -25,9 +24,11 @@
 from reactpy.utils import Ref
 
 if not TYPE_CHECKING:
-    # make flake8 think that this variable exists
     ellipsis = type(...)
 
+if TYPE_CHECKING:
+    from asgiref import typing as asgi_types
+
 
 __all__ = [
     "use_async_effect",
@@ -339,7 +340,7 @@ def use_connection() -> Connection[Any]:
 
 def use_scope() -> asgi_types.HTTPScope | asgi_types.WebSocketScope:
     """Get the current :class:`~reactpy.types.Connection`'s scope."""
-    return use_connection().scope
+    return use_connection().scope  # type: ignore
 
 
 def use_location() -> Location:

src/reactpy/logging.py

@@ -18,12 +18,7 @@
                 "stream": sys.stdout,
             }
         },
-        "formatters": {
-            "generic": {
-                "format": "%(asctime)s | %(log_color)s%(levelname)s%(reset)s | %(message)s",
-                "datefmt": r"%Y-%m-%dT%H:%M:%S%z",
-            }
-        },
+        "formatters": {"generic": {"datefmt": r"%Y-%m-%dT%H:%M:%S%z"}},
     }
 )