Grouo pyscript related code into module

Author: Archmonger

src/reactpy_django/components.py

@@ -6,7 +6,6 @@
 import os
 from typing import TYPE_CHECKING, Any, Callable, Union, cast
 from urllib.parse import urlencode
-from uuid import uuid4
 
 from django.contrib.staticfiles.finders import find
 from django.core.cache import caches
@@ -17,13 +16,11 @@
 
 from reactpy_django.exceptions import ViewNotRegisteredError
 from reactpy_django.forms.components import _django_form
-from reactpy_django.html import pyscript
+from reactpy_django.pyscript.components import _pyscript_component
 from reactpy_django.utils import (
     generate_obj_name,
     import_module,
-    render_pyscript_template,
     render_view,
-    vdom_or_component_to_string,
 )
 
 if TYPE_CHECKING:
@@ -316,30 +313,3 @@ def _cached_static_contents(static_path: str) -> str:
         caches[REACTPY_CACHE].set(cache_key, file_contents, timeout=None, version=int(last_modified_time))
 
     return file_contents
-
-
-@component
-def _pyscript_component(
-    *file_paths: str,
-    initial: str | VdomDict | ComponentType = "",
-    root: str = "root",
-):
-    rendered, set_rendered = hooks.use_state(False)
-    uuid_ref = hooks.use_ref(uuid4().hex.replace("-", ""))
-    uuid = uuid_ref.current
-    initial = vdom_or_component_to_string(initial, uuid=uuid)
-    executor = render_pyscript_template(file_paths, uuid, root)
-
-    if not rendered:
-        # FIXME: This is needed to properly re-render PyScript during a WebSocket
-        # disconnection / reconnection. There may be a better way to do this in the future.
-        set_rendered(True)
-        return None
-
-    return html._(
-        html.div(
-            {"id": f"pyscript-{uuid}", "className": "pyscript", "data-uuid": uuid},
-            initial,
-        ),
-        pyscript({"async": ""}, executor),
-    )

src/reactpy_django/pyscript/components.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from uuid import uuid4
+
+from reactpy import component, hooks, html
+from reactpy.types import ComponentType, VdomDict
+
+from reactpy_django.html import pyscript
+from reactpy_django.pyscript.utils import render_pyscript_template
+from reactpy_django.utils import vdom_or_component_to_string
+
+
+@component
+def _pyscript_component(
+    *file_paths: str,
+    initial: str | VdomDict | ComponentType = "",
+    root: str = "root",
+):
+    rendered, set_rendered = hooks.use_state(False)
+    uuid_ref = hooks.use_ref(uuid4().hex.replace("-", ""))
+    uuid = uuid_ref.current
+    initial = vdom_or_component_to_string(initial, uuid=uuid)
+    executor = render_pyscript_template(file_paths, uuid, root)
+
+    if not rendered:
+        # FIXME: This is needed to properly re-render PyScript during a WebSocket
+        # disconnection / reconnection. There may be a better way to do this in the future.
+        set_rendered(True)
+        return None
+
+    return html._(
+        html.div(
+            {"id": f"pyscript-{uuid}", "className": "pyscript", "data-uuid": uuid},
+            initial,
+        ),
+        pyscript({"async": ""}, executor),
+    )

src/reactpy_django/pyscript/utils.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+import json
+import os
+import textwrap
+from copy import deepcopy
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
+
+import jsonpointer
+import orjson
+import reactpy
+from django.templatetags.static import static
+
+from reactpy_django.utils import create_cache_key
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+
+PYSCRIPT_COMPONENT_TEMPLATE = (Path(__file__).parent / "component_template.py").read_text(encoding="utf-8")
+PYSCRIPT_LAYOUT_HANDLER = (Path(__file__).parent / "layout_handler.py").read_text(encoding="utf-8")
+PYSCRIPT_DEFAULT_CONFIG: dict[str, Any] = {}
+
+
+def render_pyscript_template(file_paths: Sequence[str], uuid: str, root: str):
+    """Inserts the user's code into the PyScript template using pattern matching."""
+    from django.core.cache import caches
+
+    from reactpy_django.config import REACTPY_CACHE
+
+    # Create a valid PyScript executor by replacing the template values
+    executor = PYSCRIPT_COMPONENT_TEMPLATE.replace("UUID", uuid)
+    executor = executor.replace("return root()", f"return {root}()")
+
+    # Fetch the user's PyScript code
+    all_file_contents: list[str] = []
+    for file_path in file_paths:
+        # Try to get user code from cache
+        cache_key = create_cache_key("pyscript", file_path)
+        last_modified_time = os.stat(file_path).st_mtime
+        file_contents: str = caches[REACTPY_CACHE].get(cache_key, version=int(last_modified_time))
+        if file_contents:
+            all_file_contents.append(file_contents)
+
+        # If not cached, read from file system
+        else:
+            file_contents = Path(file_path).read_text(encoding="utf-8").strip()
+            all_file_contents.append(file_contents)
+            caches[REACTPY_CACHE].set(cache_key, file_contents, version=int(last_modified_time))
+
+    # Prepare the PyScript code block
+    user_code = "\n".join(all_file_contents)  # Combine all user code
+    user_code = user_code.replace("\t", "    ")  # Normalize the text
+    user_code = textwrap.indent(user_code, "    ")  # Add indentation to match template
+
+    # Insert the user code into the PyScript template
+    return executor.replace("    def root(): ...", user_code)
+
+
+def extend_pyscript_config(extra_py: Sequence, extra_js: dict | str, config: dict | str) -> str:
+    """Extends ReactPy's default PyScript config with user provided values."""
+    # Lazily set up the initial config in to wait for Django's static file system
+    if not PYSCRIPT_DEFAULT_CONFIG:
+        PYSCRIPT_DEFAULT_CONFIG.update({
+            "packages": [
+                f"reactpy=={reactpy.__version__}",
+                f"jsonpointer=={jsonpointer.__version__}",
+                "ssl",
+            ],
+            "js_modules": {"main": {static("reactpy_django/morphdom/morphdom-esm.js"): "morphdom"}},
+        })
+
+    # Extend the Python dependency list
+    pyscript_config = deepcopy(PYSCRIPT_DEFAULT_CONFIG)
+    pyscript_config["packages"].extend(extra_py)
+
+    # Extend the JavaScript dependency list
+    if extra_js and isinstance(extra_js, str):
+        pyscript_config["js_modules"]["main"].update(json.loads(extra_js))
+    elif extra_js and isinstance(extra_js, dict):
+        pyscript_config["js_modules"]["main"].update(extra_py)
+
+    # Update the config
+    if config and isinstance(config, str):
+        pyscript_config.update(json.loads(config))
+    elif config and isinstance(config, dict):
+        pyscript_config.update(config)
+    return orjson.dumps(pyscript_config).decode("utf-8")

src/reactpy_django/templatetags/reactpy.py

@@ -15,11 +15,9 @@
     InvalidHostError,
     OfflineComponentMissingError,
 )
+from reactpy_django.pyscript.utils import PYSCRIPT_LAYOUT_HANDLER, extend_pyscript_config, render_pyscript_template
 from reactpy_django.utils import (
-    PYSCRIPT_LAYOUT_HANDLER,
-    extend_pyscript_config,
     prerender_component,
-    render_pyscript_template,
     save_component_params,
     strtobool,
     validate_component_args,

src/reactpy_django/utils.py

@@ -2,33 +2,25 @@
 
 import contextlib
 import inspect
-import json
 import logging
 import os
 import re
-import textwrap
 from asyncio import iscoroutinefunction
 from concurrent.futures import ThreadPoolExecutor
-from copy import deepcopy
 from fnmatch import fnmatch
 from functools import wraps
 from importlib import import_module
-from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Awaitable, Callable
 from uuid import UUID, uuid4
 
 import dill
-import jsonpointer
-import orjson
-import reactpy
 from asgiref.sync import async_to_sync
 from channels.db import database_sync_to_async
 from django.db.models import ManyToManyField, ManyToOneRel, prefetch_related_objects
 from django.db.models.base import Model
 from django.db.models.query import QuerySet
 from django.http import HttpRequest, HttpResponse
 from django.template import engines
-from django.templatetags.static import static
 from django.utils.encoding import smart_str
 from reactpy import vdom_to_html
 from reactpy.backend.types import Connection, Location
@@ -41,6 +33,7 @@
     InvalidHostError,
     ViewDoesNotExistError,
 )
+from reactpy_django.types import FuncParams, Inferred
 
 if TYPE_CHECKING:
     from collections.abc import Awaitable, Mapping, Sequence
@@ -65,9 +58,6 @@
     + rf"({_OFFLINE_KWARG_PATTERN}|{_GENERIC_KWARG_PATTERN})*?"
     + r"\s*%}"
 )
-PYSCRIPT_COMPONENT_TEMPLATE = (Path(__file__).parent / "pyscript" / "component_template.py").read_text(encoding="utf-8")
-PYSCRIPT_LAYOUT_HANDLER = (Path(__file__).parent / "pyscript" / "layout_handler.py").read_text(encoding="utf-8")
-PYSCRIPT_DEFAULT_CONFIG: dict[str, Any] = {}
 FILE_ASYNC_ITERATOR_THREAD = ThreadPoolExecutor(max_workers=1, thread_name_prefix="ReactPy-Django-FileAsyncIterator")
 
 
@@ -441,72 +431,6 @@ def vdom_or_component_to_string(
     raise ValueError(msg)
 
 
-def render_pyscript_template(file_paths: Sequence[str], uuid: str, root: str):
-    """Inserts the user's code into the PyScript template using pattern matching."""
-    from django.core.cache import caches
-
-    from reactpy_django.config import REACTPY_CACHE
-
-    # Create a valid PyScript executor by replacing the template values
-    executor = PYSCRIPT_COMPONENT_TEMPLATE.replace("UUID", uuid)
-    executor = executor.replace("return root()", f"return {root}()")
-
-    # Fetch the user's PyScript code
-    all_file_contents: list[str] = []
-    for file_path in file_paths:
-        # Try to get user code from cache
-        cache_key = create_cache_key("pyscript", file_path)
-        last_modified_time = os.stat(file_path).st_mtime
-        file_contents: str = caches[REACTPY_CACHE].get(cache_key, version=int(last_modified_time))
-        if file_contents:
-            all_file_contents.append(file_contents)
-
-        # If not cached, read from file system
-        else:
-            file_contents = Path(file_path).read_text(encoding="utf-8").strip()
-            all_file_contents.append(file_contents)
-            caches[REACTPY_CACHE].set(cache_key, file_contents, version=int(last_modified_time))
-
-    # Prepare the PyScript code block
-    user_code = "\n".join(all_file_contents)  # Combine all user code
-    user_code = user_code.replace("\t", "    ")  # Normalize the text
-    user_code = textwrap.indent(user_code, "    ")  # Add indentation to match template
-
-    # Insert the user code into the PyScript template
-    return executor.replace("    def root(): ...", user_code)
-
-
-def extend_pyscript_config(extra_py: Sequence, extra_js: dict | str, config: dict | str) -> str:
-    """Extends ReactPy's default PyScript config with user provided values."""
-    # Lazily set up the initial config in to wait for Django's static file system
-    if not PYSCRIPT_DEFAULT_CONFIG:
-        PYSCRIPT_DEFAULT_CONFIG.update({
-            "packages": [
-                f"reactpy=={reactpy.__version__}",
-                f"jsonpointer=={jsonpointer.__version__}",
-                "ssl",
-            ],
-            "js_modules": {"main": {static("reactpy_django/morphdom/morphdom-esm.js"): "morphdom"}},
-        })
-
-    # Extend the Python dependency list
-    pyscript_config = deepcopy(PYSCRIPT_DEFAULT_CONFIG)
-    pyscript_config["packages"].extend(extra_py)
-
-    # Extend the JavaScript dependency list
-    if extra_js and isinstance(extra_js, str):
-        pyscript_config["js_modules"]["main"].update(json.loads(extra_js))
-    elif extra_js and isinstance(extra_js, dict):
-        pyscript_config["js_modules"]["main"].update(extra_py)
-
-    # Update the config
-    if config and isinstance(config, str):
-        pyscript_config.update(json.loads(config))
-    elif config and isinstance(config, dict):
-        pyscript_config.update(config)
-    return orjson.dumps(pyscript_config).decode("utf-8")
-
-
 def save_component_params(args, kwargs, uuid) -> None:
     """Saves the component parameters to the database.
     This is used within our template tag in order to propogate