Move reactpy.backend.hooks module into reactpy.core.hooks

docs/source/about/changelog.rst

@@ -40,12 +40,15 @@ Unreleased
   fragment to conditionally render an element by writing
   ``something if condition else html._()``. Now you can simply write
   ``something if condition else None``.
+- :pull:`1210` - Move hooks from ``reactpy.backend.hooks`` into ``reactpy.core.hooks``.
 
 **Deprecated**
 
 - :pull:`1171` - The ``Stop`` exception. Recent releases of ``anyio`` have made this
   exception difficult to use since it now raises an ``ExceptionGroup``. This exception
   was primarily used for internal testing purposes and so is now deprecated.
+- :pull:`1210` - Deprecate ``reactpy.backend.hooks`` since the hooks have been moved into
+  ``reactpy.core.hooks``.
 
 
 v1.0.2

src/py/reactpy/reactpy/__init__.py

@@ -1,18 +1,20 @@
 from reactpy import backend, config, html, logging, sample, svg, types, web, widgets
-from reactpy.backend.hooks import use_connection, use_location, use_scope
 from reactpy.backend.utils import run
 from reactpy.core import hooks
 from reactpy.core.component import component
 from reactpy.core.events import event
 from reactpy.core.hooks import (
     create_context,
     use_callback,
+    use_connection,
     use_context,
     use_debug_value,
     use_effect,
+    use_location,
     use_memo,
     use_reducer,
     use_ref,
+    use_scope,
     use_state,
 )
 from reactpy.core.layout import Layout

src/py/reactpy/reactpy/backend/flask.py

@@ -35,8 +35,8 @@
     safe_client_build_dir_path,
     safe_web_modules_dir_path,
 )
-from reactpy.backend.hooks import ConnectionContext
-from reactpy.backend.hooks import use_connection as _use_connection
+from reactpy.core.hooks import ConnectionContext
+from reactpy.core.hooks import use_connection as _use_connection
 from reactpy.backend.types import Connection, Location
 from reactpy.core.serve import serve_layout
 from reactpy.core.types import ComponentType, RootComponentConstructor
@@ -70,7 +70,8 @@ def configure(
     """
     options = options or Options()
 
-    api_bp = Blueprint(f"reactpy_api_{id(app)}", __name__, url_prefix=str(PATH_PREFIX))
+    api_bp = Blueprint(f"reactpy_api_{id(app)}",
+                       __name__, url_prefix=str(PATH_PREFIX))
     spa_bp = Blueprint(
         f"reactpy_spa_{id(app)}", __name__, url_prefix=options.url_prefix
     )
@@ -192,14 +193,15 @@ def recv() -> Any:
         _dispatch_in_thread(
             ws,
             # remove any url prefix from path
-            path[len(options.url_prefix) :],
+            path[len(options.url_prefix):],
             constructor(),
             send,
             recv,
         )
 
     sock.route(STREAM_PATH.name, endpoint="without_path")(model_stream)
-    sock.route(f"{STREAM_PATH.name}/<path:path>", endpoint="with_path")(model_stream)
+    sock.route(f"{STREAM_PATH.name}/<path:path>",
+               endpoint="with_path")(model_stream)
 
 
 def _dispatch_in_thread(
@@ -260,7 +262,8 @@ async def main() -> None:
     Thread(target=run_dispatcher, daemon=True).start()
 
     dispatch_thread_info_created.wait()
-    dispatch_thread_info = cast(_DispatcherThreadInfo, dispatch_thread_info_ref.current)
+    dispatch_thread_info = cast(
+        _DispatcherThreadInfo, dispatch_thread_info_ref.current)
 
     if dispatch_thread_info is None:
         raise RuntimeError("Failed to create dispatcher thread")  # nocov

src/py/reactpy/reactpy/backend/hooks.py

@@ -3,16 +3,16 @@
 from collections.abc import MutableMapping
 from typing import Any
 
+from reactpy._warnings import warn
 from reactpy.backend.types import Connection, Location
-from reactpy.core.hooks import create_context, use_context
-from reactpy.core.types import Context
-
-# backend implementations should establish this context at the root of an app
-ConnectionContext: Context[Connection[Any] | None] = create_context(None)
+from reactpy.core.hooks import ConnectionContext, use_context
 
 
 def use_connection() -> Connection[Any]:
     """Get the current :class:`~reactpy.backend.types.Connection`."""
+    warn("The module reactpy.backend.hooks has been deprecated and will be deleted in the future. ",
+         "Call use_connection in reactpy.core.hooks instead.", DeprecationWarning)
+
     conn = use_context(ConnectionContext)
     if conn is None:  # nocov
         msg = "No backend established a connection."
@@ -22,9 +22,15 @@ def use_connection() -> Connection[Any]:
 
 def use_scope() -> MutableMapping[str, Any]:
     """Get the current :class:`~reactpy.backend.types.Connection`'s scope."""
+    warn("The module reactpy.backend.hooks has been deprecated and will be deleted in the future. ",
+         "Call use_scope in reactpy.core.hooks instead.", DeprecationWarning)
+
     return use_connection().scope
 
 
 def use_location() -> Location:
     """Get the current :class:`~reactpy.backend.types.Connection`'s location."""
+    warn("The module reactpy.backend.hooks has been deprecated and will be deleted in the future. ",
+         "Call use_location in reactpy.core.hooks instead.", DeprecationWarning)
+
     return use_connection().location

src/py/reactpy/reactpy/backend/sanic.py

@@ -24,8 +24,8 @@
     safe_web_modules_dir_path,
     serve_with_uvicorn,
 )
-from reactpy.backend.hooks import ConnectionContext
-from reactpy.backend.hooks import use_connection as _use_connection
+from reactpy.core.hooks import ConnectionContext
+from reactpy.core.hooks import use_connection as _use_connection
 from reactpy.backend.types import Connection, Location
 from reactpy.core.layout import Layout
 from reactpy.core.serve import RecvCoroutine, SendCoroutine, Stop, serve_layout

src/py/reactpy/reactpy/backend/starlette.py

@@ -24,8 +24,8 @@
     read_client_index_html,
     serve_with_uvicorn,
 )
-from reactpy.backend.hooks import ConnectionContext
-from reactpy.backend.hooks import use_connection as _use_connection
+from reactpy.core.hooks import ConnectionContext
+from reactpy.core.hooks import use_connection as _use_connection
 from reactpy.backend.types import Connection, Location
 from reactpy.config import REACTPY_WEB_MODULES_DIR
 from reactpy.core.layout import Layout

src/py/reactpy/reactpy/backend/tornado.py

@@ -24,8 +24,8 @@
     CommonOptions,
     read_client_index_html,
 )
-from reactpy.backend.hooks import ConnectionContext
-from reactpy.backend.hooks import use_connection as _use_connection
+from reactpy.core.hooks import ConnectionContext
+from reactpy.core.hooks import use_connection as _use_connection
 from reactpy.backend.types import Connection, Location
 from reactpy.config import REACTPY_WEB_MODULES_DIR
 from reactpy.core.layout import Layout

src/py/reactpy/reactpy/core/hooks.py

@@ -1,4 +1,6 @@
 from __future__ import annotations
+from collections.abc import MutableMapping
+from reactpy.backend.types import Connection, Location
 
 import asyncio
 from collections.abc import Coroutine, Sequence
@@ -248,6 +250,29 @@ def use_context(context: Context[_Type]) -> _Type:
     return provider.value
 
 
+# backend implementations should establish this context at the root of an app
+ConnectionContext: Context[Connection[Any] | None] = create_context(None)
+
+
+def use_connection() -> Connection[Any]:
+    """Get the current :class:`~reactpy.backend.types.Connection`."""
+    conn = use_context(ConnectionContext)
+    if conn is None:  # nocov
+        msg = "No backend established a connection."
+        raise RuntimeError(msg)
+    return conn
+
+
+def use_scope() -> MutableMapping[str, Any]:
+    """Get the current :class:`~reactpy.backend.types.Connection`'s scope."""
+    return use_connection().scope
+
+
+def use_location() -> Location:
+    """Get the current :class:`~reactpy.backend.types.Connection`'s location."""
+    return use_connection().location
+
+
 class _ContextProvider(Generic[_Type]):
     def __init__(
         self,