REACTPY_ASYNC_RENDERING

Author: Archmonger

CHANGELOG.md

@@ -36,7 +36,9 @@ Don't forget to remove deprecated code on each major release!
 
 ## [Unreleased]
 
--   Nothing (yet)!
+### Added
+
+-   `settings.py:REACTPY_ASYNC_RENDERING` to enable asynchronous rendering of components.
 
 ## [5.0.0] - 2024-10-22
 

docs/src/reference/settings.md

@@ -123,6 +123,18 @@ This setting is incompatible with [`daphne`](https://github.com/django/daphne).
 
 ---
 
+### `#!python REACTPY_ASYNC_RENDERING`
+
+**Default:** `#!python False`
+
+**Example Value(s):** `#!python True`
+
+Configures whether to use an async ReactPy rendering queue. When enabled, large renders will no longer block smaller renders from taking place. Additionally, prevents the rendering queue from being blocked on waiting for async effects to startup/shutdown (which is typically a relatively slow operation).
+
+This setting is currently experimental, and currently no effort is made to de-duplicate renders. For example, if parent and child components are scheduled to render at the same time, both renders will take place even though a single render of the parent component would have been sufficient.
+
+---
+
 ### `#!python REACTPY_DEFAULT_HOSTS`
 
 **Default:** `#!python None`

src/reactpy_django/config.py

@@ -7,6 +7,7 @@
 from django.core.cache import DEFAULT_CACHE_ALIAS
 from django.db import DEFAULT_DB_ALIAS
 from django.views import View
+from reactpy.config import REACTPY_ASYNC_RENDERING as _REACTPY_ASYNC_RENDERING
 from reactpy.config import REACTPY_DEBUG_MODE as _REACTPY_DEBUG_MODE
 from reactpy.core.types import ComponentConstructor
 
@@ -17,13 +18,16 @@
 from reactpy_django.utils import import_dotted_path
 
 # Non-configurable values
-_REACTPY_DEBUG_MODE.set_current(getattr(settings, "DEBUG"))
 REACTPY_DEBUG_MODE = _REACTPY_DEBUG_MODE.current
 REACTPY_REGISTERED_COMPONENTS: dict[str, ComponentConstructor] = {}
 REACTPY_FAILED_COMPONENTS: set[str] = set()
 REACTPY_REGISTERED_IFRAME_VIEWS: dict[str, Callable | View] = {}
 
 # Configurable through Django settings.py
+_REACTPY_DEBUG_MODE.set_current(getattr(settings, "DEBUG"))
+_REACTPY_ASYNC_RENDERING.set_current(
+    getattr(settings, "REACTPY_ASYNC_RENDERING", _REACTPY_ASYNC_RENDERING.current)
+)
 REACTPY_URL_PREFIX: str = getattr(
     settings,
     "REACTPY_URL_PREFIX",

src/reactpy_django/utils.py

@@ -263,7 +263,7 @@ def generate_obj_name(obj: Any) -> str:
     """Makes a best effort to create a name for an object.
     Useful for JSON serialization of Python objects."""
 
-    # First attempt: Dunder methods
+    # First attempt: Create a dotted path by inspecting dunder methods
     if hasattr(obj, "__module__"):
         if hasattr(obj, "__name__"):
             return f"{obj.__module__}.{obj.__name__}"